NZ Shared Digital Health Record API - Local Development build (v0.3.0) 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 Core Data Services Te Whatu Ora NHI/HPI Notes «Encounter» SDHR:Encounter Represents a SDHR encounter https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHREncounter.html Inherits FHIR Encounter meta.source : 1..1 "https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}" meta.profile : 1..1 "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHREncounter" identifier : 1..* * identifier[*].system : "https://standards.digital.health.nz/ns/health-record-key-id" * identifier[*].value ": "health-record-key-id" status : 1..1 Binding: EncounterStatus class : 1..1 Binding: ActEncounterCode (extensible) subject : 1..1 Reference NHI Patient «Condition» SDHR:Condition Represents a SDHR condition https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRCondition.html Inherits FHIR Condition meta.source : 1..1 "https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}" meta.profile : 1..1 "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition" identifier : 1..* * identifier[*].system : "https://standards.digital.health.nz/ns/health-record-key-id" * identifier[*].value " : "health-record-key-id" extension : 1..* extentension[*].url : "http://hl7.org.nz/fhir/StructureDefinition/long-term-condition" extension[*].valueBoolean : boolean true|false clinicalStatus : 1..1 Binding: ConditionClinicalStatusCodes (required) verificationStatus : 1..1 Binding: ConditionVerificationStatus (required) code : Binding: 1..1 Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS subject : 1..1 Reference NHI Patient onsetDateTime : 0..1 Preferred recordedDateTime : 0..1 Preferred recorder : 0..1 Reference Practitioner (preferred) asserter : 1..1 Reference Practitioner «AllergyIntolerance» SDHR:AllergyIntolerance Represents a SDHR allergy intolerance https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRAllergyIntolerance.html Inherits FHIR AllergyIntolerance meta.source : 1..1 "https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}" meta.profile : 1..1 "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance" identifier : 1..* * identifier[*].system : "https://standards.digital.health.nz/ns/health-record-key-id" * identifier[*].value " : "health-record-key-id" clinicalStatus : 1..1 Binding: AllergyIntoleranceClinicalStatus (required) verificationStatus : 1..1 Binding: AllergyIntoleranceVerificationStatus (required) code : 1..1 Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS subject : 1..1 Reference NHI Patient category : 0..* Binding: AllergyIntoleranceCategory (preferred) recordedDateTime : 0..1 (preferred) recorder : 0..1 Reference Practitioner (preferred) «Observation» SDHR:Observation Represents a SDHR observation https://fhir-ig.digital.health.nz/sdhr/StructureDefinition-SDHRObservation.html Inherits FHIR Observation meta.source : 1..1 "https://api.hip.digital.health.nz/fhir/Location/{hpi-facilityid}}" meta.profile : 1..1 "https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation" identifier : 1..* * identifier[*].system : "https://standards.digital.health.nz/ns/health-record-key-id" * identifier[*].value " : "health-record-key-id" code : Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS subject : Reference NHI Patient effectiveDateTime : Preferred value[x] : Binding: Multiple bindings e.g. SNOMED CT, ReadCodes, MIMS interpretation : Binding: ObservationInterpretation (extensible) status : Binding: ObservationStatus (required) «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 - Encounter - Observation The following resources are existing national data services: - Immunization (AIR) - Patient (NHI) - Practitioner/Organizaion/Location (HPI) - MedicationRequest/MedicationDispense (MDR) Coding/Terminology: In some cases an attempt may be made to map a source code to a standard code such as read code --> SNOMEDCT. In these scenarios the "source" code will always be preserved and marked as "user selected". e.g. { "code" : { "coding" : [ { "system" : "http://snomed.info/sct", "code" : "373784005", "display" : "Penicillin allergy", "userSelected" : false }, { "system" : "http://mims.co.nz", "code" : "m00286", "display" : "Penicillins", "userSelected" : true } ] } } subject participant subject recorder | asserter subject recorder subject 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 10/03/2025
