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: AIRImmunizationRecommendation - Mappings

Active as of 2026-10-12

Mappings for the air-immunization-recommendation 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 Mappingdoco
ImmunizationRecommendation
Request
VXU_V04
SubstanceAdministration[moodCode=RMD]
ImmunizationRecommendation / id
ImmunizationRecommendation / meta
ImmunizationRecommendation / implicitRules
ImmunizationRecommendation / language
ImmunizationRecommendation / text
Act.text?
ImmunizationRecommendation / contained
N/A
ImmunizationRecommendation / extension
N/A
ImmunizationRecommendation / modifierExtension
N/A
ImmunizationRecommendation / identifier
Request.identifier
.id
FiveWs.identifier
ImmunizationRecommendation / patient
Request.subject
PID-3
.partipication[typeCode=SUBJ].role
FiveWs.subject
ImmunizationRecommendation / date
Request.authoredOn
OBX-15
.partipication[typeCode=AUTH].time
ImmunizationRecommendation / authority
OBX-3 = 59779-9
.participation[typeCode=AUT]
ImmunizationRecommendation / recommendation
  • .outboundRelationship[typeCode='COMP'].target[classCode=SBADM
  • moodCode=RMD]
ImmunizationRecommendation / recommendation / id
n/a
ImmunizationRecommendation / recommendation / Slices for extension
ImmunizationRecommendation / recommendation / Slices for extension / extension:id
ImmunizationRecommendation / recommendation / Slices for extension / extension:disease-covered
ImmunizationRecommendation / recommendation / Slices for extension / extension:antigen-group
ImmunizationRecommendation / recommendation / Slices for extension / extension:air-scheduled-event
ImmunizationRecommendation / recommendation / modifierExtension
N/A
ImmunizationRecommendation / recommendation / vaccineCode
Request.code
OBX-3 = ( 30956-7 | 38890-0 )
.partipication[typeCode=CSM].role[classCode=ADMM].code
ImmunizationRecommendation / recommendation / targetDisease
OBX-3 = ( 30956-7 | 38890-0 )
.partipication[typeCode=CSM].role[classCode=ADMM].code
ImmunizationRecommendation / recommendation / contraindicatedVaccineCode
ImmunizationRecommendation / recommendation / forecastStatus
OBX-3 = 59783-1
  • .inboundRelationship[typeCode=SUBJ] .source[classCode=OBS
  • moodCode=EVN
  • code="Immunization Forecast Status"].value
ImmunizationRecommendation / recommendation / forecastReason
OBX-3 = 30982-3
N/A
ImmunizationRecommendation / recommendation / dateCriterion
Request.occurrence[x]
  • 30980-7 = Next dose recommended
  • 59777-3 = Latest next dose should be given
  • 59778-1 = Dose is overdue
  • .outboundRelationship[typeCode='LIMIT'].target[classCode=OBS
  • moodCode=EVN
  • isCriterionInd=true]
ImmunizationRecommendation / recommendation / dateCriterion / id
n/a
ImmunizationRecommendation / recommendation / dateCriterion / extension
n/a
ImmunizationRecommendation / recommendation / dateCriterion / modifierExtension
N/A
ImmunizationRecommendation / recommendation / dateCriterion / code
OBX-3
.code
ImmunizationRecommendation / recommendation / dateCriterion / value
OBX-5
.value
ImmunizationRecommendation / recommendation / description
OBX-3 = 30956-7
.text
ImmunizationRecommendation / recommendation / series
RXA-5-administered code
.title
ImmunizationRecommendation / recommendation / doseNumber[x]
OBX-3 = 30973-2
  • .inboundRelationship[typeCode=COMP
  • .source[classCode=SBADM
  • moodCode=INT]].sequenceNumber
ImmunizationRecommendation / recommendation / seriesDoses[x]
OBX-3 = 59782-3
  • .inboundRelationship[typeCode=COMP
  • .source[classCode=SBADM
  • moodCode=DEF]].sequenceNumber
ImmunizationRecommendation / recommendation / supportingImmunization
? No clear way to associate in HL7 v2 or IG
  • .outboundRelationship[typeCode=RSON].target[classCode=SBADM
  • moodCode=EVN
  • code="immunization"]
ImmunizationRecommendation / recommendation / supportingPatientInformation
Request.supportingInfo
  • RXA-5-administered code = '998^No vaccine administered^CVX')
  • could contain the reason the vaccine was not administered
  • .outboundRelationship[typeCode=RSON].target[classCode=OBS
  • moodCode=EVN]

doco Documentation for this format