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

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.28.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-08-04

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

Name | HL7 v2 Mapping | RIM Mapping | FiveWs Pattern Mapping
--- | --- | --- | ---
MessageHeader | MSH / MSA / ERR | Message |
id |  |  |
meta |  |  |
implicitRules |  |  |
language |  |  |
text |  | Act.text? |
contained |  | N/A |
Slices for extension |  |  |
extension:ImmunisationNotificationAction |  |  |
modifierExtension |  | N/A |
event[x] | MSH-9.2 | ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code | FiveWs.what[x]
destination |  | ./communicationFunction[typeCode="RCV"] | FiveWs.subject
id |  | n/a |
extension |  | n/a |
modifierExtension |  | N/A |
name | MSH-5 | unique(./entity[determinerCode="INST" and (classCode=("DEV" "PSN" "ORG"]/name[type='ST' and isNormalDatatype()]) |
target |  | unique(./entity[determinerCode="INST" and (classCode=("DEV" "PSN" "ORG"] |
endpoint | MSH-25 (or MSH-6) | ./telecom |
receiver | PRT-4='WAYR' / PRT-8:PRT-4='WAYR' | Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText | FiveWs.subject
sender | PRT-4='WAYR' / PRT-8:PRT-4='WAYR' | Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText | FiveWs.subject
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
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
source |  | unique(./communicationFunction[typeCode="SND"]) | FiveWs.actor
id |  | n/a |
extension |  | n/a |
modifierExtension |  | N/A |
name | MSH-3 | unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()]) |
software | SFT-3 ( +SFT-1) | unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()]) |
version | SFT-2 | (Not supported) |
contact | (MSH-22?) | unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()]) |
endpoint | MSH-24 | ./telecom[isNormalDatatype()] |
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
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]
response | MSA | ./conveyedAcknowledgement |
id |  | n/a |
extension |  | n/a |
modifierExtension |  | N/A |
identifier | MSA-2 | ./acknowledges.id[isNormalDatatype()] |
code | MSA-1 | ./typeCode[isNormalDatatype()] |
details | ERR | AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"] |
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) |
definition |  | Not directly supported. |
Documentation for this format