Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2)
2.2.0-SNAPSHOT - ci-build New Zealand

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V2) - Local Development build (v2.2.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AIRImmunization - Mappings

Active as of 2026-10-12

Mappings for the air-immunization resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameWorkflow PatternHL7 v2 MappingRIM MappingFiveWs Pattern MappingCDA (R2)doco
Immunization
Event
VXU_V04
SubstanceAdministration
Immunization / id
Immunization / meta
Immunization / meta / id
n/a
Immunization / meta / Slices for extension
n/a
Immunization / meta / Slices for extension / extension:DataQualityAssessment
Immunization / meta / Slices for extension / extension:PlannedEventMatch
Immunization / meta / Slices for extension / extension:PlannedEventMatchQuality
Immunization / meta / Slices for extension / extension:CreatedSourceSystem
Immunization / meta / Slices for extension / extension:CreatedBy
Immunization / meta / Slices for extension / extension:ModifiedSourceSystem
Immunization / meta / Slices for extension / extension:ModifiedBy
Immunization / meta / Slices for extension / extension:CreatedDate
N/A
n/a
Immunization / meta / versionId
Immunization / meta / lastUpdated
Immunization / meta / source
Immunization / meta / profile
Immunization / meta / security
Immunization / meta / tag
Immunization / implicitRules
Immunization / language
Immunization / text
Act.text?
Immunization / contained
N/A
Immunization / Slices for extension
Immunization / Slices for extension / extension:administeredProduct
Immunization / Slices for extension / extension:Diluent
Immunization / Slices for extension / extension:MobileSiteId
Immunization / Slices for extension / extension:AgeGiven
Immunization / Slices for extension / extension:relatedPersonExtension
Immunization / Slices for extension / extension:serologyReportExtension
Immunization / Slices for extension / extension:rescheduleDateExtension
Immunization / modifierExtension
N/A
Immunization / identifier
Event.identifier
.id
FiveWs.identifier
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
Immunization / status
Event.status
statusCode
FiveWs.status
Immunization / statusReason
Event.statusReason
  • .inboundRelationship[typeCode=SUBJ].source[classCode=CACT
  • moodCode=EVN].reasonCOde
Immunization / statusReason / id
n/a
Immunization / statusReason / extension
n/a
Immunization / statusReason / coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
Immunization / statusReason / text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
Immunization / vaccineCode
Event.code
RXA-5
.code
FiveWs.what[x]
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
Immunization / vaccineCode / id
n/a
Immunization / vaccineCode / extension
n/a
Immunization / vaccineCode / coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
Immunization / vaccineCode / coding / id
n/a
Immunization / vaccineCode / coding / extension
n/a
Immunization / vaccineCode / coding / system
C*E.3
./codeSystem
Immunization / vaccineCode / coding / version
C*E.7
./codeSystemVersion
Immunization / vaccineCode / coding / code
C*E.1
./code
Immunization / vaccineCode / coding / display
C*E.2 - but note this is not well followed
CV.displayName
Immunization / vaccineCode / coding / userSelected
Sometimes implied by being first
CD.codingRationale
Immunization / vaccineCode / text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
Immunization / patient
Event.subject
PID-3
.partipication[ttypeCode=].role
FiveWs.subject
Immunization / encounter
Event.context
PV1-19
component->EncounterEvent
FiveWs.context
Immunization / occurrence[x]
Event.occurrence[x]
RXA-3
.effectiveTime
FiveWs.done[x]
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
Immunization / recorded
.participation[typeCode=AUT].time
FiveWs.recorded
Immunization / primarySource
RXA-9
  • immunization.uncertaintycode (if primary source=false
  • uncertainty=U)
FiveWs.source
Immunization / 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
Immunization / location
Event.location
  • RXA-27 (or RXA-11
  • deprecated as of v2.7)
.participation[typeCode=LOC].COCT_MT240000UV
FiveWs.where[x]
Immunization / manufacturer
RXA-17
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
Immunization / 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
Immunization / expirationDate
RXA-16
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
Immunization / site
RXR-2
observation.targetSiteCode
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
Immunization / site / id
n/a
Immunization / site / extension
n/a
Immunization / site / coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
Immunization / site / text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
Immunization / route
RXR-1
.routeCode
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
Immunization / route / id
n/a
Immunization / route / extension
n/a
Immunization / route / coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
Immunization / route / text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
Immunization / doseQuantity
RXA-6 / RXA-7
.doseQuantity
Immunization / performer
Event.performer
ORC-12 / RXA-10
.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
Immunization / performer / id
n/a
Immunization / performer / extension
n/a
Immunization / performer / modifierExtension
N/A
Immunization / performer / function
Event.performer.function
.participation.functionCode
Immunization / performer / function / id
n/a
Immunization / performer / function / extension
n/a
Immunization / performer / function / coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
Immunization / performer / function / text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
Immunization / performer / actor
Event.performer.actor
.player
FiveWs.actor
Immunization / note
Event.note
OBX-3 = 48767-8
note
Immunization / reasonCode
Event.reasonCode
[actionNegationInd=false].reasonCode
Immunization / reasonReference
Event.reasonReference
N/A
Immunization / isSubpotent
RXA-20 = PA (partial administration)
N/A
Immunization / subpotentReason
N/A
Immunization / education
N/A
Immunization / programEligibility
OBX-3 = 64994-7
N/A
Immunization / fundingSource
N/A
Immunization / reaction
OBX-3
Observation[classCode=obs].code
Immunization / protocolApplied
N/A
Immunization / protocolApplied / id
n/a
Immunization / protocolApplied / extension
n/a
Immunization / protocolApplied / modifierExtension
N/A
Immunization / protocolApplied / series
N/A
Immunization / protocolApplied / authority
N/A
Immunization / protocolApplied / targetDisease
N/A
Immunization / protocolApplied / doseNumber[x]
N/A
Immunization / protocolApplied / seriesDoses[x]
N/A

doco Documentation for this format