NZ Shared Digital Health Record API - Local Development build (v1.1.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Data Models
FHIR data models
This section provides an overview of the design of the FHIR data representations that authorised applications can use to record and interchange shared digital health record information.
Overview
Shared Digital Health Record - FHIR data model Shared Digital Health Record - FHIR data model Core Data Services Te Whatu Ora NHI/HPI Notes «Condition» SDHR:Condition Represents a SDHR condition SDHR profile Inherits FHIR Condition meta.source : 1..1 HPI Location code : 1..1 Condition or diagnosis code subject : 1..1 Reference NHI Patient clinicalStatus : 0..1 Clinical status verificationStatus : 0..1 Verification status onsetDateTime : 0..1 Onset date recorder | asserter : Reference Practitioner «AllergyIntolerance» SDHR:AllergyIntolerance Represents a SDHR allergy intolerance SDHR profile Inherits FHIR AllergyIntolerance meta.source : 1..1 HPI Location clinicalStatus : 1..1 Clinical status verificationStatus : 1..1 Verification status code : 1..1 Allergy or intolerance code patient : 1..1 Reference NHI Patient category : 0..* Allergy category recorder : 0..1 Reference Practitioner «Observation» SDHR:Observation Represents a SDHR observation SDHR profile Inherits FHIR Observation meta.source : 1..1 HPI Location code : Observation code subject : 1..1 Reference NHI Patient effectiveDateTime : Observation date value[x] : Observation value interpretation : Result interpretation status : Observation status performer : Reference Practitioner «MedicationRequest» SDHR:MedicationRequest Represents prescribing intent from MDR SDHR profile Inherits FHIR MedicationRequest id : MDR prescription item identifier identifier : NZePS prescription item ID status : 1..1 Medication request status medicationCodeableConcept : 1..1 Medication requested subject : 1..1 Reference NHI Patient authoredOn : 0..1 Date and time authored requester : 0..1 Reference Practitioner or Organization reasonReference : 0..* Reference Condition or Observation «MedicationDispense» SDHR:MedicationDispense Represents medicines supplied from MDR SDHR profile Inherits FHIR MedicationDispense id : 1..1 MDR dispense record identifier identifier : 1..1 NZePS prescription item ID status : 1..1 completed authorizingPrescription : 0..* Reference MedicationRequest subject : 1..1 Reference NHI Patient quantity : 0..1 Quantity dispensed daysSupply : 0..1 Expected days supplied whenHandedOver : 0..1 Date and time supplied destination : 0..1 Reference Location «Immunization» SDHR:Immunization Represents an immunisation event from AIR SDHR profile Inherits AIR Immunization id : 1..1 Immunisation event identifier status : 1..1 Immunisation event status vaccineCode : 1..1 Vaccine administered patient : 1..1 Reference NHI Patient occurrence[x] : 1..1 Date or timing of the event location : 0..1 Reference Location performer : 1..* Reference Practitioner or Organization «Reference» Patient (NHI) logical id: NHI «Reference» HPI org identifier format GXXNNN-C HPI Org Id Notes The following resources are sourced from primary care systems: - AllergyIntolerance - Condition - Observation The following resources are existing national data services: - Immunization (AIR) - Patient (NHI) - Practitioner/Organization/Location (HPI) - MedicationRequest/MedicationDispense (MDR) } authorizing prescription subject recorder | asserter subject recorder subject performer subject requester | supporting information subject destination patient location | performer Notes - (preferred) indicates that whilst not mandatory it highly desirable. Key to datatype colours colour stereotype ghost white Standard FHIR resource in TWO IG salmon Profiled FHIR resource orange red Canonical shared resource defined by TWO sky blue Logical identifier reference to records in national systems Health NZ/Te Whatu Ora. Generated from PlantUML source on 12/08/2026
