MediRecords FHIR Implementation Guide
1.2.0 - ci-build
The MediRecords FHIR API supports the following Observation profiles:
The MediRecords FHIR API supports the following Observation operations.
GET {API_URL}/v1/Observation
This API interface enables the client to search Observation instances from MediRecords repository. This is in compliance with the MediRecords Observation Vital Signs profiles.
| Query Parameters | ||
|---|---|---|
| _count | number | Instruct the server regarding how many resources should be returned in a single page |
| patient | reference | Mandatory Patient(id) that the observation is about |
| performer | reference | Who performed the observation |
| category | token | The classification of the type of observation |
| code | token | The code of the observation type |
| date | date | Observation effectiveDateTime. Either a date value precise to the day to retreive observations effective within this day, or datetime value including seconds, time zone and a comparator prefix, such as ‘ge’ or ‘lt’, to retrieve observations in a specific date/time range. For example, ?date=2022-06-07 or ?date=ge2022-06-07T17:00:00+10:00<2022-06-07T18:00:00+10:00 |
| status | token | The status of the observation |
The server returns matching Observation instances in a Bundle that the logged-in user has access to. If no search criteria is provided, then all Observation instances that the logged-in user has access to will be returned.
By default, only active Observations will be provided in the search result.
In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.
| Status | Text |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
GET {API_URL}/v1/Observation/{id}
This API interface enables the client to read an Observation resource from MediRecords repository which is compliant with the supported MediRecords Observation Vital Signs profiles.
In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.
| Status | Text |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
The following table provides the FHIR Webhook event types generated for the Observation resource.
| Hub Event | Application Trigger Event |
|---|---|
| observation.created | Occurs whenever a new clinical observation record is created |
| observation.updated | Occurs whenever a clinical observation record is updated |
Bundle
Observation (1..*)
Encounter (0..1)
Patient (1)
PractitionerRole (0..1)
Practitioner (0..2)
Organization (0..2)
| observation.deleted coming soon |
Occurs whenever a clinical observation record is deleted |
Bundle<br>
request (1)
url: DELETE Observation/{id}