Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DHOPatient - Mappings

Active as of 2026-10-13

Mappings for the DHOPatient 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 / extension
n/a
Patient / meta / versionId
Patient / meta / lastUpdated
Patient / meta / source
Patient / meta / profile
Patient / meta / security
Patient / meta / Slices for tag
Patient / meta / Slices for tag / tag:correlationId
Patient / meta / Slices for tag / tag:correlationId / id
n/a
Patient / meta / Slices for tag / tag:correlationId / extension
n/a
Patient / meta / Slices for tag / tag:correlationId / system
./codeSystem
C*E.3
Patient / meta / Slices for tag / tag:correlationId / version
./codeSystemVersion
C*E.7
Patient / meta / Slices for tag / tag:correlationId / code
./code
C*E.1
Patient / meta / Slices for tag / tag:correlationId / display
CV.displayName
C*E.2 - but note this is not well followed
Patient / meta / Slices for tag / tag:correlationId / userSelected
CD.codingRationale
Sometimes implied by being first
Patient / implicitRules
Patient / language
Patient / text
Act.text?
Patient / Slices for contained
N/A
Patient / Slices for contained / contained:GP
N/A
Patient / Slices for extension
Patient / Slices for extension / extension:ethnicity
Patient / Slices for extension / extension:ethnicity / id
n/a
Patient / Slices for extension / extension:ethnicity / extension
Patient / Slices for extension / extension:ethnicity / url
N/A
Patient / Slices for extension / extension:ethnicity / value[x]
N/A
Patient / Slices for extension / extension:nzCitizen
Patient / Slices for extension / extension:nzCitizen / id
n/a
Patient / Slices for extension / extension:nzCitizen / Slices for extension
n/a
Patient / Slices for extension / extension:nzCitizen / Slices for extension
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:status
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:status / id
n/a
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:status / extension
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:status / url
N/A
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:status / value[x]
N/A
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:source
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:source / id
n/a
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:source / extension
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:source / url
N/A
Patient / Slices for extension / extension:nzCitizen / Slices for extension / extension:source / value[x]
N/A
Patient / Slices for extension / extension:nzCitizen / url
N/A
Patient / Slices for extension / extension:nzCitizen / value[x]
N/A
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:acc-patient-occupation
Patient / Slices for extension / extension:messaging-address
Patient / Slices for extension / extension:nz-residency
Patient / Slices for extension / extension:interpreter-required
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 / name / id
n/a
Patient / name / Slices for extension
n/a
Patient / name / Slices for extension / extension:information-source
Patient / name / Slices for extension / extension:preferred
Patient / name / use
unique(./use)
  • XPN.7
  • but often indicated by which field contains the name
Patient / name / text
./formatted
implied by XPN.11
Patient / name / family
./part[partType = FAM]
XPN.1/FN.1
Patient / name / given
./part[partType = GIV]
XPN.2 + XPN.3
Patient / name / prefix
./part[partType = PFX]
XPN.5
Patient / name / suffix
./part[partType = SFX]
XPN/4
Patient / name / period
./usablePeriod[type="IVL<TS>"]
XPN.13 + XPN.14
Patient / telecom
TEL
XTN
Patient / telecom / id
n/a
Patient / telecom / Slices for extension
n/a
Patient / telecom / Slices for extension / extension:cp-purpose
Patient / telecom / Slices for extension / extension:notification-enabled
Patient / telecom / Slices for extension / extension:validation-status
Patient / telecom / system
./scheme
XTN.3
Patient / telecom / value
./url
XTN.1 (or XTN.12)
Patient / telecom / use
unique(./use)
XTN.2 - but often indicated by field
Patient / telecom / rank
n/a
n/a
Patient / telecom / period
./usablePeriod[type="IVL<TS>"]
N/A
Patient / gender
player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
.patient.administrativeGenderCode
PID-8
Patient / gender / id
Patient / gender / Slices for extension
Patient / gender / Slices for extension / extension:genderOriginalText
Patient / gender / value
Patient / birthDate
player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
.patient.birthTime
PID-7
21112-8
Patient / birthDate / id
Patient / birthDate / Slices for extension
Patient / birthDate / Slices for extension / extension:information-source
Patient / birthDate / value
Patient / Slices for 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 / Slices for deceased[x] / deceased[x]:deceasedBoolean
  • 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 / Slices for deceased[x] / deceased[x]:deceasedDateTime
  • 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 / Slices for deceased[x] / deceased[x]:deceasedDateTime / id
Patient / Slices for deceased[x] / deceased[x]:deceasedDateTime / Slices for extension
Patient / Slices for deceased[x] / deceased[x]:deceasedDateTime / Slices for extension
Patient / Slices for deceased[x] / deceased[x]:deceasedDateTime / Slices for extension / extension:information-source
Patient / Slices for deceased[x] / deceased[x]:deceasedDateTime / value
Patient / address
AD
XAD
Patient / address / id
n/a
Patient / address / Slices for extension
n/a
Patient / address / Slices for extension / extension:nz-geocode
Patient / address / Slices for extension / extension:suburb
Patient / address / Slices for extension / extension:building-name
Patient / address / Slices for extension / extension:domicile-code
Patient / address / Slices for extension / extension:domicile-code / id
n/a
Patient / address / Slices for extension / extension:domicile-code / extension
Patient / address / Slices for extension / extension:domicile-code / url
N/A
Patient / address / Slices for extension / extension:domicile-code / value[x]
N/A
Patient / address / Slices for extension / extension:domicile-code / value[x] / id
n/a
Patient / address / Slices for extension / extension:domicile-code / value[x] / extension
n/a
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding / id
n/a
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding / extension
n/a
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding / system
./codeSystem
C*E.3
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding / version
./codeSystemVersion
C*E.7
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding / code
./code
C*E.1
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding / display
CV.displayName
C*E.2 - but note this is not well followed
Patient / address / Slices for extension / extension:domicile-code / value[x] / coding / userSelected
CD.codingRationale
Sometimes implied by being first
Patient / address / Slices for extension / extension:domicile-code / value[x] / text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
Patient / address / Slices for extension / extension:country-name
Patient / address / use
unique(./use)
XAD.7
Patient / address / type
unique(./use)
XAD.18
Patient / address / text
./formatted
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
Patient / address / line
AD.part[parttype = AL]
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
Patient / address / city
AD.part[parttype = CTY]
XAD.3
Patient / address / district
AD.part[parttype = CNT | CPA]
XAD.9
Patient / address / state
AD.part[parttype = STA]
XAD.4
Patient / address / postalCode
AD.part[parttype = ZIP]
XAD.5
Patient / address / country
AD.part[parttype = CNT]
XAD.6
Patient / address / period
./usablePeriod[type="IVL<TS>"]
XAD.12 / XAD.13 + XAD.14
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 / Slices for extension
Patient / contact / Slices for extension / extension:role
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 / name / id
n/a
Patient / contact / name / extension
Patient / contact / name / use
unique(./use)
  • XPN.7
  • but often indicated by which field contains the name
Patient / contact / name / text
./formatted
implied by XPN.11
Patient / contact / name / family
./part[partType = FAM]
XPN.1/FN.1
Patient / contact / name / given
./part[partType = GIV]
XPN.2 + XPN.3
Patient / contact / name / prefix
./part[partType = PFX]
XPN.5
Patient / contact / name / suffix
./part[partType = SFX]
XPN/4
Patient / contact / name / period
./usablePeriod[type="IVL<TS>"]
XPN.13 + XPN.14
Patient / contact / telecom
telecom
n/a
  • NK1-5
  • NK1-6
  • NK1-40
Patient / contact / telecom / id
n/a
Patient / contact / telecom / extension
Patient / contact / telecom / system
./scheme
XTN.3
Patient / contact / telecom / value
./url
XTN.1 (or XTN.12)
Patient / contact / telecom / use
unique(./use)
XTN.2 - but often indicated by field
Patient / contact / telecom / rank
n/a
n/a
Patient / contact / telecom / period
./usablePeriod[type="IVL<TS>"]
N/A
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 / generalPractitioner
subjectOf.CareEvent.performer.AssignedEntity
n/a
PD1-4
Patient / managingOrganization
scoper
.providerOrganization
Patient / link
outboundLink
n/a

doco Documentation for this format