REST API
This page describes types of Aidbox REST API operations in general
Aidbox provides two REST APIs - FHIR and Aidbox. The main difference is a format of resources. Base URL for FHIR API is /fhir and for Aidbox /
Please consider using /fhir. Aidbox API is scheduled for deprecation.
| Interaction type | Format | |
|---|---|---|
| Instance Level Interactions | ||
| read | Read the current state of the resource | both |
| vread | Read the state of a specific version of the resource | both |
| update | Update an existing resource by its id (or create it if it is new) | both |
| patch | Update an existing resource by posting a set of changes to it | both |
| delete | Delete a resource | both |
| history | Retrieve the change history for a particular resource | both |
| Type Level Interactions | ||
| create | Create a new resource | both |
| search | Search the resource type based on some filter criteria | both |
| history | Retrieve the change history for a particular resource type | both |
| $dump | Dump all resources of specific type | Aidbox |
| $load | Load resources of specific type | both |
| Whole System Interactions | ||
| capabilities | Get a capability statement for the system | FHIR |
| batch/transaction | Update, create or delete a set of resources in a single interaction | both |
| batch upsert | Batch create or update interaction | Aidbox |
| $import | Bulk Import async operation | both |
| $load | Bulk load ndjson file with resources | both |
| $dump-sql | Bulk export result of SQL Query | Aidbox |
| history | Not supported for performance reason | |
| search | Not supported for performance reason |
Last updated 2025-05-12T17:04:33Z