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

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

Resource Profile: NDHOutpatient - Mappings

Active as of 2025-09-04

Mappings for the NDHOutpatient 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
... id
... meta
.... id
n/a
.... extension
n/a
.... versionId
.... lastUpdated
.... source
.... profile
.... security
.... tag
... implicitRules
... text
Act.text?
... contained
N/A
... Slices for extension
.... extension:ethnicity
.... extension:nzCitizen
.... extension:dhb
.... extension:domicile-code
.... extension:pho
.... extension:sex-at-birth
.... extension:iwi
.... extension:acc-patient-occupation
.... extension:messaging-address
.... extension:nz-residency
.... extension:interpreter-required
... modifierExtension
N/A
... Slices for identifier
id
.id
FiveWs.identifier
PID-3
.... identifier:All Slices
..... id
n/a
..... extension
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... 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)
.... identifier:NHI
id
.id
FiveWs.identifier
PID-3
..... id
n/a
..... extension
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... 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)
... active
statusCode
n/a
FiveWs.status
... name
name
.patient.name
  • PID-5
  • PID-9
.... id
n/a
.... Slices for extension
..... extension:information-source
.... use
unique(./use)
  • XPN.7
  • but often indicated by which field contains the name
.... text
./formatted
implied by XPN.11
.... family
./part[partType = FAM]
XPN.1/FN.1
.... given
./part[partType = GIV]
XPN.2 + XPN.3
.... prefix
./part[partType = PFX]
XPN.5
.... suffix
./part[partType = SFX]
XPN/4
.... period
./usablePeriod[type="IVL<TS>"]
XPN.13 + XPN.14
... telecom
TEL
XTN
.... id
n/a
.... Slices for extension
..... extension:cp-purpose
.... system
./scheme
XTN.3
.... value
./url
XTN.1 (or XTN.12)
.... use
unique(./use)
XTN.2 - but often indicated by field
.... rank
n/a
n/a
.... period
./usablePeriod[type="IVL<TS>"]
N/A
... gender
player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
.patient.administrativeGenderCode
PID-8
.... id
.... Slices for extension
..... extension:genderOriginalText
.... value
... birthDate
player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
.patient.birthTime
PID-7
21112-8
.... id
.... Slices for extension
..... extension:information-source
.... value
... 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)
.... 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)
.... 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)
..... id
..... Slices for extension
...... extension:information-source
..... value
... address
AD
XAD
.... id
n/a
.... Slices for extension
n/a
..... extension:nz-geocode
..... extension:suburb
..... extension:building-name
..... extension:domicile-code
...... id
n/a
...... extension
...... url
N/A
...... value[x]
N/A
....... id
n/a
....... extension
n/a
....... coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
........ id
n/a
........ extension
n/a
........ system
./codeSystem
C*E.3
........ version
./codeSystemVersion
C*E.7
........ code
./code
C*E.1
........ display
CV.displayName
C*E.2 - but note this is not well followed
........ userSelected
CD.codingRationale
Sometimes implied by being first
....... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
..... extension:country-name
.... use
unique(./use)
XAD.7
.... type
unique(./use)
XAD.18
.... text
./formatted
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
.... line
AD.part[parttype = AL]
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
.... city
AD.part[parttype = CTY]
XAD.3
.... district
AD.part[parttype = CNT | CPA]
XAD.9
.... state
AD.part[parttype = STA]
XAD.4
.... postalCode
AD.part[parttype = ZIP]
XAD.5
.... country
AD.part[parttype = CNT]
XAD.6
.... period
./usablePeriod[type="IVL<TS>"]
XAD.12 / XAD.13 + XAD.14
... maritalStatus
player[classCode=PSN]/maritalStatusCode
.patient.maritalStatusCode
PID-16
... 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)
... photo
player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
n/a
OBX-5 - needs a profile
... contact
player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
n/a
.... id
n/a
.... Slices for extension
..... extension:role
.... modifierExtension
N/A
.... relationship
code
n/a
  • NK1-7
  • NK1-3
.... name
name
n/a
NK1-2
..... id
n/a
..... extension
..... use
unique(./use)
  • XPN.7
  • but often indicated by which field contains the name
..... text
./formatted
implied by XPN.11
..... family
./part[partType = FAM]
XPN.1/FN.1
..... given
./part[partType = GIV]
XPN.2 + XPN.3
..... prefix
./part[partType = PFX]
XPN.5
..... suffix
./part[partType = SFX]
XPN/4
..... period
./usablePeriod[type="IVL<TS>"]
XPN.13 + XPN.14
.... telecom
telecom
n/a
  • NK1-5
  • NK1-6
  • NK1-40
..... id
n/a
..... extension
..... system
./scheme
XTN.3
..... value
./url
XTN.1 (or XTN.12)
..... use
unique(./use)
XTN.2 - but often indicated by field
..... rank
n/a
n/a
..... period
./usablePeriod[type="IVL<TS>"]
N/A
.... address
addr
n/a
NK1-4
.... gender
player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
n/a
NK1-15
.... organization
scoper
n/a
  • NK1-13
  • NK1-30
  • NK1-31
  • NK1-32
  • NK1-41
.... period
effectiveTime
n/a
... communication
LanguageCommunication
patient.languageCommunication
... generalPractitioner
subjectOf.CareEvent.performer.AssignedEntity
n/a
PD1-4
... managingOrganization
scoper
.providerOrganization
... link
outboundLink
n/a

doco Documentation for this format