New Zealand NHI IG - Local Development build (v1.6.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: NhiPatient - Mappings

Active as of 2025-04-07

Mappings for the NhiPatient resource profile.

Mappings for RIM Mapping (http://hl7.org/v3)

NhiPatient
Patient	Entity. Role, or Act, Patient[classCode=PAT]
text	Act.text?
contained	N/A
contained (GP)	N/A
extension
extension (ethnicity)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
extension (nzCitizen)
id	n/a
extension	n/a
extension (status)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
extension (source)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
url	N/A
modifierExtension	N/A
identifier	id
id	n/a
extension	n/a
use	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
identifier (NHI)	id
id	n/a
extension	n/a
use	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
name	name
id	n/a
extension
extension (information-source)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
use	unique(./use)
family	./part[partType = FAM]
given	./part[partType = GIV]
prefix	./part[partType = PFX]
telecom	n/a, TEL
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
gender	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
birthDate	player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
extension
extension (information-source)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
deceased[x]	player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
extension
extension (information-source)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
address	n/a, AD
id	n/a
extension	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
city	AD.part[parttype = CTY]
postalCode	AD.part[parttype = ZIP]
country	AD.part[parttype = CNT]
generalPractitioner	subjectOf.CareEvent.performer.AssignedEntity

Mappings for CDA (R2) (http://hl7.org/v3/cda)

NhiPatient
Patient	ClinicalDocument.recordTarget.patientRole
identifier	.id
identifier (NHI)	.id
name	.patient.name
gender	.patient.administrativeGenderCode
birthDate	.patient.birthTime
deceased[x]	n/a
generalPractitioner	n/a

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

NhiPatient
Patient
identifier	FiveWs.identifier
identifier (NHI)	FiveWs.identifier

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

NhiPatient
Patient
identifier	PID-3
use	N/A
system	CX.4 / EI-2-4
value	CX.1 / EI.1
assigner	CX.4 / (CX.4,CX.9,CX.10)
identifier (NHI)	PID-3
use	N/A
system	CX.4 / EI-2-4
value	CX.1 / EI.1
assigner	CX.4 / (CX.4,CX.9,CX.10)
name	PID-5, PID-9
use	XPN.7, but often indicated by which field contains the name
family	XPN.1/FN.1
given	XPN.2 + XPN.3
prefix	XPN.5
telecom	XTN
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
gender	PID-8
birthDate	PID-7
deceased[x]	PID-30 (bool) and PID-29 (datetime)
address	XAD
use	XAD.7
type	XAD.18
text	XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
city	XAD.3
postalCode	XAD.5
country	XAD.6
generalPractitioner	PD1-4

Mappings for LOINC code for the element (http://loinc.org)

NhiPatient
Patient
birthDate	21112-8