Te Whatu Ora Shared Care FHIR API
0.4.0 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

Collect Measurements

About Observation resources

Care in the Community can involve monitoring a patient’s vital signs and this is done with the help of FHIR Observation resources.

Patient remote capture Observation data may be captured by the patient themselves, and submitted to HNZ directly through a patient experience. In such cases, the FHIR Observation resources will be created by the MyHealthRecord app.

Clinician capture Observation resources may be created from data gathered from patients by clinicians (such as HNZ staff, COVID case managers, etc.) In these cases FHIR Observation resources are created from data entered into the CCCM app.

API Sequence

The sequence below illustrates an interaction with the FHIR API creating an Observation resource containing a series of measurements.

FHIR Observation linkage to other resources

Observation resources link to CarePlans through ServiceRequests. As used here, the ServiceRequest resources exist principally to make connections between FHIR resources, rather than to record requests for participants to perform a service for a care plan.

That said, when a ServiceRequest comes into existence with a code of 122869004 (SNOMED) and a link to a CarePlan, viewers of the system can interpret this as a request for Observation data to be collected.

Each Observation resource must link back to its CarePlan through its basedOn relation which references a ServiceRequest. The ServiceRequest in turn has a basedOn relation to the CarePlan resource.

The next diagram shows this linkage from Observation resources along with SNOMED coding and the performer relation.

Observation period dates

For Observation.issued and Observation.effective[x] time periods, the client application must supply UTC dateTime values and not local (eg. New Zealand time zone values).

The client application is responsible for converting UTC dateTimes to the timezone of the user and formatting the date and time display according to the user’s locale preference.