FHIR support
The MIDATA server supports FHIR R4 and FHIR STU3.
FHIR is used both for the API and for the data format of the personal data records.
If no FHIR version is specified in request headers FHIR STU3 is used as default. For new applications we strongly recommend to use FHIR R4.
A list of supported FHIR resources can be found in the FHIR resource list.
A detailed description of the FHIR API can be found on the FHIR homepage. Please have look below for a list of what is supported and what not.
These features are supported for all FHIR resources that we support unless stated otherwise on the resource specific page.
Supported Operations
Instance Level Interactions
| Supported | Operation | Description |
|---|---|---|
| yes | read | Read the current state of the resource |
| yes | vread | Read the state of a specific version of the resource |
| yes | update | Update an existing resource by its id (or create it if it is new) |
| no | patch | Update an existing resource by posting a set of changes to it |
| no | delete | Delete a resource |
| yes | history | Retrieve the change history for a particular resource |
Type Level Interactions
| Supported | Operation | Description |
|---|---|---|
| yes | create | Create a new resource with a server assigned id |
| yes | search | Search the resource type based on some filter criteria |
| no | history | Retrieve the change history for a particular resource type |
Whole System Interactions
| Supported | Operation | Description |
|---|---|---|
| yes | capabilities | Get a capability statement for the system |
| create+update | batch/transaction | Update, create or delete a set of resources in a single interaction |
| no | history | Retrieve the change history for all resources |
| no | search | Search across all resource types based on some filter criteria |
Data Formats
- JSON
- XML
Search Features
| Supported | Feature | Example |
|---|---|---|
| yes | AND on one parameter | ?param1=A¶m1=B |
| yes | OR on one parameter | ?param1=A,B,C |
| yes | Chaining | ?patient.name=Hugo |
| yes | Modifier :missing | |
| yes | Modifier :exact | |
| yes | Modifier :contains | |
| yes | Modifier :text | |
| no | Modifier :below | |
| no | Modifier :above | |
| no | Modifier :in | |
| no | Modifier :not-in | |
| yes | Modifier :not | |
| yes | _id | |
| yes | _lastUpdated | |
| no | _tag | |
| no | _profile | |
| no | _security | |
| no | _text | |
| no | _content | |
| no | _list | |
| no | _has | |
| no | _type | |
| no | _query | |
| yes | _sort | |
| yes | _count | |
| yes | _include | |
| yes | _revinclude | |
| yes | _summary | |
| yes | _elements | |
| no | _contained | |
| no | _containedType |
Search Prefixes
- Supported: eq, ne, gt, lt, ge, le, sa, eb
- Not supported: ap