Aotearoa Immunisation Register (AIR) FHIR Implementation Guide
2.7.0 - ci-build New Zealand

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

Resource Profile: AIRImmunization - Mappings

Active as of 2026-07-20

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
... id
... meta
.... id
n/a
.... Slices for extension
n/a
..... extension:DataQualityAssessment
..... extension:PlannedEventMatch
..... extension:PlannedEventMatchQuality
..... extension:CreatedSourceSystem
..... extension:CreatedBy
..... extension:ModifiedSourceSystem
..... extension:ModifiedBy
..... extension:CreatedDate
N/A
n/a
.... versionId
.... lastUpdated
.... source
.... profile
.... security
.... tag
... implicitRules
... language
... text
Act.text?
... contained
N/A
... Slices for extension
.... extension:administeredProduct
.... extension:Diluent
.... extension:MobileSiteId
.... extension:AgeGiven
.... extension:relatedPersonExtension
.... extension:serologyReportExtension
.... extension:rescheduleDateExtension
... 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
.... id
n/a
.... extension
n/a
.... coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
.... text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
... vaccineCode
Event.code
RXA-5
.code
FiveWs.what[x]
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
.... id
n/a
.... extension
n/a
.... coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
..... id
n/a
..... extension
n/a
..... system
C*E.3
./codeSystem
..... version
C*E.7
./codeSystemVersion
..... code
C*E.1
./code
..... display
C*E.2 - but note this is not well followed
CV.displayName
..... userSelected
Sometimes implied by being first
CD.codingRationale
.... text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
... 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
.... id
n/a
.... extension
n/a
.... coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
.... text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
... route
RXR-1
.routeCode
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
.... id
n/a
.... extension
n/a
.... coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
.... text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
... 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
..... id
n/a
..... extension
n/a
..... coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
..... text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
.... 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
... programEligibility
OBX-3 = 64994-7
N/A
... fundingSource
N/A
... reaction
OBX-3
Observation[classCode=obs].code
... 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

doco Documentation for this format