Endpoints for writing clinical data to the Shared Health Record, reading a patient's records against a consent token, and looking up the security labels that govern them.
Submit a FHIR bundle to the SHR
Forwards a FHIR collection Bundle to the Shared Health Record. The Encounter must reference the visit's EpisodeOfCare and all clinical resources must reference that Encounter.
The middleware only enforces that the body is a FHIR Bundle (resourceType is Bundle); the bundle contents are validated upstream by DHA.
Related documentation: Introduction to the Shared Health Record
Submit a FHIR bundle to the SHR › Request Body
resourceTypeMust be Bundle. Any other value is rejected with a 400.
Clinical resources carried by the bundle. Each entry wraps one FHIR resource.
typeFHIR bundle type. The Shared Health Record expects a collection.
Submit a FHIR bundle to the SHR › Responses
Bundle accepted
mediator_idIdentifier DHA assigned to the submitted bundle. Quote it when following up on a submission.
messageHuman readable outcome message from DHA.
statusOutcome status reported by DHA.
Fetch patient records from the SHR
Retrieves clinical records for a patient from the Shared Health Record. Requires the per-visit consent token issued when the consent was verified, supplied in the X-Consent-Token header.
The response is the FHIR search result returned by DHA, passed through unchanged. Any further FHIR search parameters you supply are forwarded upstream as-is.
Related documentation: Introduction to the Shared Health Record
query Parameters
cr_idClient Registry (CR) identifier of the patient whose records are being read.
practitioner_idHealth Worker Registry identifier of the practitioner making the request.
resourcesComma-separated FHIR resource types to return.
_idFilter to a single resource instance by its FHIR logical id.
page_tokenPagination token returned by a previous response. Omit it to fetch the first page.
Headers
X-Consent-TokenPer-visit consent token issued on consent verification, or refreshed for an open visit. Required.
Fetch patient records from the SHR › Responses
Patient records
Get SHR resource security labels
Returns the security labels DHA supports for a FHIR resource type and/or a specific code. Security labels drive what a consent grants access to, so read them before building a consent request or interpreting a records response.
Supply at least one of resource_name or code. A lookup with neither is rejected with a 400.
Related documentation: Introduction to the Shared Health Record
query Parameters
resource_nameFHIR resource type to look up. At least one of resource_name or code is required.
codeSpecific code to look up. At least one of resource_name or code is required.
Get SHR resource security labels › Responses
Resource security labels