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

Draft as of 2026-10-12

Mappings for the air-message-header resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameHL7 v2 MappingRIM MappingFiveWs Pattern Mappingdoco
MessageHeader
MSH / MSA / ERR
Message
MessageHeader / id
MessageHeader / meta
MessageHeader / implicitRules
MessageHeader / language
MessageHeader / text
Act.text?
MessageHeader / contained
N/A
MessageHeader / Slices for extension
MessageHeader / Slices for extension / extension:ImmunisationNotificationAction
MessageHeader / modifierExtension
N/A
MessageHeader / event[x]
MSH-9.2
./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
FiveWs.what[x]
MessageHeader / destination
./communicationFunction[typeCode="RCV"]
FiveWs.subject
MessageHeader / destination / id
n/a
MessageHeader / destination / extension
n/a
MessageHeader / destination / modifierExtension
N/A
MessageHeader / destination / name
MSH-5
  • unique(./entity[determinerCode="INST" and (classCode=("DEV"
  • "PSN"
  • "ORG"]/name[type='ST' and isNormalDatatype()])
MessageHeader / destination / target
  • unique(./entity[determinerCode="INST" and (classCode=("DEV"
  • "PSN"
  • "ORG"]
MessageHeader / destination / endpoint
MSH-25 (or MSH-6)
./telecom
MessageHeader / destination / receiver
PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
FiveWs.subject
MessageHeader / sender
PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
FiveWs.subject
MessageHeader / enterer
PRT-4='EP' / ROL where ROL.3 is EP or ORC.10
  • unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV"
  • "PSN") and determinerCode="INST"])
FiveWs.author
MessageHeader / author
PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12
  • unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV"
  • "PSN") and determinerCode="INST"])
FiveWs.author
MessageHeader / source
unique(./communicationFunction[typeCode="SND"])
FiveWs.actor
MessageHeader / source / id
n/a
MessageHeader / source / extension
n/a
MessageHeader / source / modifierExtension
N/A
MessageHeader / source / name
MSH-3
unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])
MessageHeader / source / software
SFT-3 ( +SFT-1)
unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])
MessageHeader / source / version
SFT-2
(Not supported)
MessageHeader / source / contact
(MSH-22?)
unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])
MessageHeader / source / endpoint
MSH-24
./telecom[isNormalDatatype()]
MessageHeader / responsible
PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11
unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])
FiveWs.witness
MessageHeader / reason
EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication
unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()])
FiveWs.why[x]
MessageHeader / response
MSA
./conveyedAcknowledgement
MessageHeader / response / id
n/a
MessageHeader / response / extension
n/a
MessageHeader / response / modifierExtension
N/A
MessageHeader / response / identifier
MSA-2
./acknowledges.id[isNormalDatatype()]
MessageHeader / response / code
MSA-1
./typeCode[isNormalDatatype()]
MessageHeader / response / details
ERR
AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
MessageHeader / focus
unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)
MessageHeader / definition
Not directly supported.

doco Documentation for this format