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

Active as of 2026-08-04

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

Name | Workflow Pattern | HL7 v2 Mapping | RIM Mapping | FiveWs Pattern Mapping
--- | --- | --- | --- | ---
ImmunizationRecommendation | Request | VXU_V04 | SubstanceAdministration[moodCode=RMD] |
id |  |  |  |
meta |  |  |  |
implicitRules |  |  |  |
language |  |  |  |
text |  |  | Act.text? |
contained |  |  | N/A |
extension |  |  | N/A |
modifierExtension |  |  | N/A |
identifier | Request.identifier |  | .id | FiveWs.identifier
patient | Request.subject | PID-3 | .partipication[typeCode=SUBJ].role | FiveWs.subject
date | Request.authoredOn | OBX-15 | .partipication[typeCode=AUTH].time |
authority |  | OBX-3 = 59779-9 | .participation[typeCode=AUT] |
recommendation |  |  | .outboundRelationship[typeCode='COMP'].target[classCode=SBADM moodCode=RMD] |
id |  |  | n/a |
Slices for extension |  |  |  |
extension:id |  |  |  |
extension:disease-covered |  |  |  |
extension:antigen-group |  |  |  |
extension:air-scheduled-event |  |  |  |
modifierExtension |  |  | N/A |
vaccineCode | Request.code | OBX-3 = ( 30956-7 | 38890-0 ) | .partipication[typeCode=CSM].role[classCode=ADMM].code |
targetDisease |  | OBX-3 = ( 30956-7 | 38890-0 ) | .partipication[typeCode=CSM].role[classCode=ADMM].code |
contraindicatedVaccineCode |  |  |  |
forecastStatus |  | OBX-3 = 59783-1 | .inboundRelationship[typeCode=SUBJ] .source[classCode=OBS moodCode=EVN code="Immunization Forecast Status"].value |
forecastReason |  | OBX-3 = 30982-3 | N/A |
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] |
id |  |  | n/a |
extension |  |  | n/a |
modifierExtension |  |  | N/A |
code |  | OBX-3 | .code |
value |  | OBX-5 | .value |
description |  | OBX-3 = 30956-7 | .text |
series |  | RXA-5-administered code | .title |
doseNumber[x] |  | OBX-3 = 30973-2 | .inboundRelationship[typeCode=COMP .source[classCode=SBADM moodCode=INT]].sequenceNumber |
seriesDoses[x] |  | OBX-3 = 59782-3 | .inboundRelationship[typeCode=COMP .source[classCode=SBADM moodCode=DEF]].sequenceNumber |
supportingImmunization |  | ? No clear way to associate in HL7 v2 or IG | .outboundRelationship[typeCode=RSON].target[classCode=SBADM moodCode=EVN code="immunization"] |
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] |
Documentation for this format