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

Aotearoa Immunisation Register (AIR) FHIR Implementation Guide (API-V1) - Local Development build (v1.29.0-SNAPSHOT) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AIRPatient - Mappings

Active as of 2026-10-12

Mappings for the air-patient resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameRIM MappingCDA (R2)FiveWs Pattern MappingHL7 v2 MappingLOINC code for the elementdoco
Patient
Patient[classCode=PAT]
ClinicalDocument.recordTarget.patientRole
Patient / id
Patient / meta
Patient / meta / id
n/a
Patient / meta / Slices for extension
n/a
Patient / meta / Slices for extension / extension:ModifiedSourceSystem
Patient / meta / Slices for extension / extension:ModifiedBy
Patient / meta / versionId
Patient / meta / lastUpdated
Patient / meta / source
Patient / meta / profile
Patient / meta / security
Patient / meta / tag
Patient / implicitRules
Patient / language
Patient / text
Act.text?
Patient / contained
N/A
Patient / Slices for extension
Patient / Slices for extension / extension:ethnicity
Patient / Slices for extension / extension:nzCitizen
Patient / Slices for extension / extension:dhb
Patient / Slices for extension / extension:domicile-code
Patient / Slices for extension / extension:pho
Patient / Slices for extension / extension:sex-at-birth
Patient / Slices for extension / extension:iwi
Patient / Slices for extension / extension:NIROptOff
Patient / Slices for extension / extension:ConsumerState
Patient / Slices for extension / extension:ConsumerSubStatus
Patient / modifierExtension
N/A
Patient / Slices for identifier
id
.id
FiveWs.identifier
PID-3
Patient / Slices for identifier / identifier:NHI
id
.id
FiveWs.identifier
PID-3
Patient / Slices for identifier / identifier:NHI / id
n/a
Patient / Slices for identifier / identifier:NHI / extension
n/a
Patient / Slices for identifier / identifier:NHI / use
Role.code or implied by context
N/A
Patient / Slices for identifier / identifier:NHI / type
Role.code or implied by context
CX.5
Patient / Slices for identifier / identifier:NHI / system
II.root or Role.id.root
CX.4 / EI-2-4
Patient / Slices for identifier / identifier:NHI / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
Patient / Slices for identifier / identifier:NHI / period
Role.effectiveTime or implied by context
CX.7 + CX.8
Patient / Slices for identifier / identifier:NHI / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
Patient / active
statusCode
n/a
FiveWs.status
Patient / name
name
.patient.name
  • PID-5
  • PID-9
Patient / telecom
TEL
XTN
Patient / gender
player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
.patient.administrativeGenderCode
PID-8
Patient / birthDate
player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
.patient.birthTime
PID-7
21112-8
Patient / deceased[x]
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
n/a
PID-30 (bool) and PID-29 (datetime)
Patient / address
AD
XAD
Patient / maritalStatus
player[classCode=PSN]/maritalStatusCode
.patient.maritalStatusCode
PID-16
Patient / multipleBirth[x]
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd
  • player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
n/a
  • PID-24 (bool)
  • PID-25 (integer)
Patient / photo
player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
n/a
OBX-5 - needs a profile
Patient / contact
player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
n/a
Patient / contact / id
n/a
Patient / contact / extension
n/a
Patient / contact / modifierExtension
N/A
Patient / contact / relationship
code
n/a
  • NK1-7
  • NK1-3
Patient / contact / name
name
n/a
NK1-2
Patient / contact / telecom
telecom
n/a
  • NK1-5
  • NK1-6
  • NK1-40
Patient / contact / address
addr
n/a
NK1-4
Patient / contact / gender
player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
n/a
NK1-15
Patient / contact / organization
scoper
n/a
  • NK1-13
  • NK1-30
  • NK1-31
  • NK1-32
  • NK1-41
Patient / contact / period
effectiveTime
n/a
Patient / communication
LanguageCommunication
patient.languageCommunication
Patient / communication / id
n/a
Patient / communication / extension
n/a
Patient / communication / modifierExtension
N/A
Patient / communication / language
player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
.languageCode
  • PID-15
  • LAN-2
Patient / communication / preferred
preferenceInd
.preferenceInd
PID-15
Patient / generalPractitioner
subjectOf.CareEvent.performer.AssignedEntity
n/a
PD1-4
Patient / managingOrganization
scoper
.providerOrganization
Patient / link
outboundLink
n/a
Patient / link / id
n/a
Patient / link / extension
n/a
Patient / link / modifierExtension
N/A
Patient / link / other
id
n/a
  • PID-3
  • MRG-1
Patient / link / type
typeCode
n/a

doco Documentation for this format