NZ Shared Digital Health Record API
1.0.1 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

## Resource Profile: SDHRImmunization - Mappings

Active as of 2026-06-05

Mappings for the SDHRImmunization resource profile.

#### Mappings to Structures in this Implementation Guide

No Mappings Found

#### Mappings to other Structures

No Mappings Found

#### Other Mappings

Name | Workflow Pattern | HL7 v2 Mapping | RIM Mapping | FiveWs Pattern Mapping | CDA (R2)
--- | --- | --- | --- | --- | ---
Immunization | Event | VXU_V04 | SubstanceAdministration |  |
id |  |  |  |  |
meta |  |  |  |  |
implicitRules |  |  |  |  |
language |  |  |  |  |
text |  |  | Act.text? |  |
contained |  |  | N/A |  |
extension |  |  | N/A |  |
modifierExtension |  |  | N/A |  |
identifier | Event.identifier |  | .id | FiveWs.identifier | ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
status | Event.status |  | statusCode | FiveWs.status |
statusReason | Event.statusReason |  | .inboundRelationship[typeCode=SUBJ].source[classCode=CACT moodCode=EVN].reasonCOde |  |
vaccineCode | Event.code | RXA-5 | .code | FiveWs.what[x] | ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
patient | Event.subject | PID-3 | .partipication[ttypeCode=].role | FiveWs.subject |
encounter | Event.context | PV1-19 | component->EncounterEvent | FiveWs.context |
occurrence[x] | Event.occurrence[x] | RXA-3 | .effectiveTime | FiveWs.done[x] | ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
recorded |  |  | .participation[typeCode=AUT].time | FiveWs.recorded |
primarySource |  | RXA-9 | immunization.uncertaintycode (if primary source=false uncertainty=U) | FiveWs.source |
reportOrigin |  | RXA-9 | .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member) | FiveWs.source |
location | Event.location | RXA-27 (or RXA-11 deprecated as of v2.7) | .participation[typeCode=LOC].COCT_MT240000UV | FiveWs.where[x] |
manufacturer |  | RXA-17 | .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG] |  | ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
lotNumber |  | RXA-15 | .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id |  | ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
expirationDate |  | RXA-16 | .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime |  |
site |  | RXR-2 | observation.targetSiteCode |  | ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
route |  | RXR-1 | .routeCode |  | ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
doseQuantity |  | RXA-6 / RXA-7 | .doseQuantity |  |
performer | Event.performer | ORC-12 / RXA-10 | .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE] |  |
id |  |  | n/a |  |
extension |  |  | n/a |  |
modifierExtension |  |  | N/A |  |
function | Event.performer.function |  | .participation.functionCode |  |
actor | Event.performer.actor |  | .player | FiveWs.actor |
note | Event.note | OBX-3 = 48767-8 | note |  |
reasonCode | Event.reasonCode |  | [actionNegationInd=false].reasonCode |  |
reasonReference | Event.reasonReference |  | N/A |  |
isSubpotent |  | RXA-20 = PA (partial administration) | N/A |  |
subpotentReason |  |  | N/A |  |
education |  |  | N/A |  |
id |  |  | n/a |  |
extension |  |  | n/a |  |
modifierExtension |  |  | N/A |  |
documentType |  | OBX-3 = 69764-9 | N/A |  |
reference |  |  | N/A |  |
publicationDate |  | OBX-3 = 29768-9 | N/A |  |
presentationDate |  | OBX-3 = 29769-7 | N/A |  |
programEligibility |  | OBX-3 = 64994-7 | N/A |  |
fundingSource |  |  | N/A |  |
reaction |  | OBX-3 | Observation[classCode=obs].code |  |
id |  |  | n/a |  |
extension |  |  | n/a |  |
modifierExtension |  |  | N/A |  |
date |  | OBX-14 (ideally this would be reported in an IAM segment but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all) | .effectiveTime |  |
detail |  | OBX-5 | .value |  |
reported |  | (HL7 v2 doesn't seem to provide for this) | .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true) |  |
protocolApplied |  |  | N/A |  |
id |  |  | n/a |  |
extension |  |  | n/a |  |
modifierExtension |  |  | N/A |  |
series |  |  | N/A |  |
authority |  |  | N/A |  |
targetDisease |  |  | N/A |  |
doseNumber[x] |  |  | N/A |  |
seriesDoses[x] |  |  | N/A |  |
Documentation for this format