ERA FHIR specification
1.0.0 - draft
ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
This page contains general guidance for the ERA FHIR interface.
The following headers are commonly used in requests:
| Header | Documentation |
|---|---|
X-Registry-UUID |
Registry ID. Required. |
Accept |
Defines which response content types the client can understand. Required. Use application/fhir+json; fhirVersion=4.0. |
Content-Type |
Defines the request body format. Required when the request has a body. Use application/fhir+json; fhirVersion=4.0. |
X-ERA-Session-ID |
ERA session ID. Required when the request uses an active ERA session. The operation description states whether a session is required. |
X-ERA-Organization-ID |
Registered organization UUID. Required when X-ERA-Session-ID is not required for the request. |
If-Match |
Contains the most recent version of the resource that is the update target. Required for updating resources. The value must be provided as an integer, for example 1. |
Example request headers:
X-Registry-UUID: <Registry ID>
Accept: application/fhir+json; fhirVersion=4.0
Content-Type: application/fhir+json; fhirVersion=4.0
X-ERA-Session-ID: <Session ID>
X-ERA-Organization-ID: <Registered Organization ID>
If-Match: <Resource version>
The retention time for each FHIR resource is defined in the resource's meta element. The retention time is expressed as an instant in time until which the resource must be retained by ERA. The retention time is defined using the Resource Retention Time extension.
The retention time can be set for each resource in Create and Update actions by providing the extension element in the resource's meta element. If the extension is not provided, a default retention time is used.
The stored retention time for each resource is returned in the resource's meta element in Create, Update, Read and Search actions.