NZ Shared Digital Health Record API
0.4.0 - draft

NZ Shared Digital Health Record API - Local Development build (v0.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

FHIR Artifacts

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

NZ Shared Digital Health Record API

NZ Shared Digital Health Record API

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

SDHRAllergyIntolerance

AllergyIntolerance FHIR resource for Shared Digital Health Record
SDHRCondition

Condition resource to record problems and conditions affecting a person
SDHREncounter

Encounter resource to record an instance of an interaction between patient and healthcare provider
SDHRObservation

A Shared Digital Health Record Observation.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

APIError-Unauthorised

Access to Shared Digital Health Records is restricted.<br> This API validates information that is provided by the API Consumer in their Request-Context header. The API Consumer must also provide an appropriate OAuth 2.0 Bearer token in the Authorization header containing scopes appropriate for the resource being accessed. The API Consumer must be registered with the Shared Digital Health Record API.
AllergyIntoleranceExample

An example payload for a Primary Care AllergyIntolerance resource indicating an allergy to Penicillin
ConditionSearchResponseExample

Example of a search response for a condition search. In this case the search response returns one result using the search parameters code and subject. GET /Condition?subject=https://api.hip.digital.health.nz/fhir/Patient/ZKC7284&amp;code=http://snomed.info/sct%7C38341003
HypertensionConditionExample

Example Hypertension Condition
ObservationVitalSignsExample

An example SDHR Vital Signs Observation
RespiratoryConditionExample

Example Respiratory Condition
SDHREncounterExample

Example Encounter resource to record an instance of an interaction between patient and healthcare provider