REST API
Aidbox provides two REST APIs - FHIR and Aidbox. The main difference is Aidbox & FHIR formats. Base URL for FHIR API is /fhir and for Aidbox /
| Interaction type | Format | |
|---|---|---|
| Instance Level Interactions | ||
| Read | Read the current state of the resource | both |
| Read | 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 |
| Bulk API | Dump all resources of specific type | Aidbox |
| Bulk API | Load resources of specific type | both |
| Whole System Interactions | ||
| Capability Statement | 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 |
| Bulk API | Bulk Import async operation | both |
| Bulk API | Bulk load ndjson file with resources | both |
| Bulk API | Bulk export result of SQL Query | Aidbox |
| history | Not supported for performance reason | |
| search | Not supported for performance reason |