RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.8.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: Patient - Mappings

Active as of 2024-11-25

Mappings for the Patient resource profile.

Mappings for HCIM Patient-v3.1(2017EN) (https://zibs.nl/wiki/Patient-v3.1(2017EN))

Patient
Patient	NL-CM:0.1.1	Patient
identifier	NL-CM:0.1.7	PatientIdentificationNumber
name	NL-CM:0.1.6	NameInformation
telecom	NL-CM:0.1.5	ContactInformation
gender	NL-CM:0.1.9	Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender
birthDate	NL-CM:0.1.10	DateOfBirth
deceased[x]	NL-CM:0.1.32, NL-CM:0.1.33	DeathIndicator , DateOfDeath
address	NL-CM:0.1.4	AddressInformation
multipleBirth[x]	NL-CM:0.1.31	MultipleBirthIndicator

Mappings for HCIM MaritalStatus-v3.0(2017EN) (https://zibs.nl/wiki/MaritalStatus-v3.0(2017EN))

Patient
Patient
maritalStatus	NL-CM:7.9.2	MaritalStatus

Mappings for HCIM ContactPerson-v3.1(2017EN) (https://zibs.nl/wiki/ContactPerson-v3.1(2017EN))

Patient
Patient
contact	NL-CM:3.1.1	Contact
relationship (relationship)	NL-CM:3.1.3	Relationship
relationship (role)	NL-CM:3.1.2	Role
name	NL-CM:3.1.4	NameInformation
telecom	NL-CM:3.1.6	ContactInformation
address	NL-CM:3.1.5	AddressInformation

Mappings for HCIM HealthcareProvider-v3.1.1(2017EN) (https://zibs.nl/wiki/HealthcareProvider-v3.1.1(2017EN))

Patient
Patient
generalPractitioner	NL-CM:17.2.1	HealthcareProvider

Mappings for HCIM HealthProfessional-v3.2(2017EN) (https://zibs.nl/wiki/HealthProfessional-v3.2(2017EN))

Patient
Patient
generalPractitioner	NL-CM:17.1.1	HealthProfessional

Mappings for HCIM Nationality-v3.0(2017EN) (https://zibs.nl/wiki/Nationality-v3.0(2017EN))

Patient
Patient
extension (nationality)	NL-CM:7.6.3	Nationality

Mappings for HCIM Payer-v3.1(2017EN) (https://zibs.nl/wiki/Payer-v3.1(2017EN))

Patient
Patient	NL-CM:1.1.2	PayerPerson
name	NL-CM:1.1.5	PayerName
text	NL-CM:1.1.5	PayerName
telecom	NL-CM:1.1.12	ContactInformation
address	NL-CM:1.1.17	AddressInformation
contact
name
text	NL-CM:1.1.5	PayerName

Mappings for HCIM ContactInformation-v1.0(2017EN) (https://zibs.nl/wiki/ContactInformation-v1.0(2017EN))

ContactInformation has become an independent information model as of release 2017 of the HCIMs.

Patient
Patient
telecom	NL-CM:20.6.1	ContactInformation
contact
telecom	NL-CM:20.6.1	ContactInformation

Mappings for HCIM LanguageProficiency-v3.1(2017EN) (https://zibs.nl/wiki/LanguageProficiency-v3.1(2017EN))

Patient
Patient
communication	NL-CM:7.12.1	LanguageProficiency
extension (languageProficiency)	NL-CM:7.12.6, NL-CM:7.12.7, NL-CM:7.12.8	LanguageControlListening , LanguageControlSpeaking , LanguageControlReading
extension (comment)	NL-CM:7.12.5	Comment
language	NL-CM:7.12.3	CommunicationLanguage

Mappings for HCIM FreedomRestrictingMeasures-v3.1(2017EN) (https://zibs.nl/wiki/FreedomRestrictingMeasures-v3.1(2017EN))

Concerns only LegalStatus concept. This will become an independent information model as of release 2018 of the HCIMs.

Patient
Patient
extension (legalStatus)	NL-CM:14.3.2	LegalStatus

Mappings for HCIM BasicElements-v1.0(2017EN) (https://zibs.nl/wiki/BasicElements-v1.0(2017EN))

Patient
Patient	NL-CM:0.0.3, NL-CM:0.0.8, NL-CM:0.0.12	PatientAsInformationSource::Patient , PatientAsAuthor::Patient , Patient
identifier	NL-CM:0.0.6	IdentificationNumber

Mappings for HCIM FamilySituation-v3.0(2017EN) (https://zibs.nl/wiki/FamilySituation-v3.0(2017EN))

Patient
Patient
maritalStatus	NL-CM:7.13.7	FamilySituation

Mappings for HCIM LifeStance-v3.1(2017EN) (https://zibs.nl/wiki/LifeStance-v3.1(2017EN))

Patient
Patient
extension
extension (preferredPharmacy)
extension (nationality)
extension (legalStatus)
extension (lifeStance)
value[x] (valueCodeableConcept)	NL-CM:7.5.2	LifeStance

Mappings for HCIM Patient-v3.0(2016EN) (https://zibs.nl/wiki/Patient-v3.0(2016EN))

Patient
Patient	NL-CM:0.1.1	Patient
identifier	NL-CM:0.1.7	PatientIdentificationNumber
name	NL-CM:0.1.6	NameInformation
telecom	NL-CM:0.1.5	ContactInformation
gender	NL-CM:0.1.9	Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender
birthDate	NL-CM:0.1.10	DateOfBirth
deceased[x]	NL-CM:0.1.32, NL-CM:0.1.33	DeathIndicator , DateOfDeath
address	NL-CM:0.1.4	AddressInformation
multipleBirth[x]	NL-CM:0.1.31	MultipleBirthIndicator

Mappings for HCIM MaritalStatus-v3.0(2016EN) (https://zibs.nl/wiki/MaritalStatus-v3.0(2016EN))

Patient
Patient
maritalStatus	NL-CM:7.9.2	MaritalStatus

Mappings for HCIM ContactPerson-v3.0(2016EN) (https://zibs.nl/wiki/ContactPerson-v3.0(2016EN))

Patient
Patient
contact	NL-CM:3.1.1	Contact
relationship (relationship)	NL-CM:3.1.3	Relationship
relationship (role)	NL-CM:3.1.2	Role
name	NL-CM:3.1.4	NameInformation
telecom	NL-CM:3.1.6	TelephoneEmail::ContactInformation
address	NL-CM:3.1.5	AddressInformation

Mappings for HCIM HealthcareProvider-v3.0(2016EN) (https://zibs.nl/wiki/HealthcareProvider-v3.0(2016EN))

Patient
Patient
generalPractitioner	NL-CM:17.2.1	HealthcareProvider

Mappings for HCIM HealthProfessional-v3.0(2016EN) (https://zibs.nl/wiki/HealthProfessional-v3.0(2016EN))

Patient
Patient
generalPractitioner	NL-CM:17.1.1	HealthProfessional

Mappings for HCIM Nationality-v3.0(2016EN) (https://zibs.nl/wiki/Nationality-v3.0(2016EN))

Patient
Patient
extension (nationality)	NL-CM:7.6.3	Nationality

Mappings for HCIM Payer-v3.0(2016EN) (https://zibs.nl/wiki/Payer-v3.0(2016EN))

Patient
Patient	NL-CM:1.1.2	PayerPerson
name	NL-CM:1.1.5	PayerName
text	NL-CM:1.1.5	PayerName
telecom	NL-CM:1.1.12	TelephoneEmail::ContactInformation
address	NL-CM:1.1.17	Address
contact
name
text	NL-CM:1.1.5	PayerName

Mappings for HCIM FamilySituation-v3.0(2016EN) (https://zibs.nl/wiki/FamilySituation-v3.0(2016EN))

Patient
Patient
maritalStatus	NL-CM:7.13.7	FamilySituation

Mappings for HCIM Patient-v2.0.1(2015EN) (https://zibs.nl/wiki/Patient-v2.0.1(2015EN))

Patient
Patient	NL-CM:0.1.1	Patient
identifier	NL-CM:0.1.7	PatientIdentificationNumber
name	NL-CM:0.1.6	NameInformation
telecom	NL-CM:0.1.5	ContactInformation
gender	NL-CM:0.1.9	Gender. Use FHIR Core ConceptMap for HCIM mapping: http://nictiz.nl/fhir/ConceptMap/GeslachtCodelijst-to-AdministrativeGender
birthDate	NL-CM:0.1.10	DateOfBirth
deceased[x]	NL-CM:0.1.32, NL-CM:0.1.33	DeathIndicator , DateOfDeath
address	NL-CM:0.1.4	AddressInformation
multipleBirth[x]	NL-CM:0.1.31	MultipleBirthIndicator

Mappings for HCIM MaritalStatus-v1.2.1(2015EN) (https://zibs.nl/wiki/MaritalStatus-v1.2.1(2015EN))

Patient
Patient
maritalStatus	NL-CM:7.9.2	MaritalStatus

Mappings for HCIM ContactPerson-v1.2(2015EN) (https://zibs.nl/wiki/ContactPerson-v1.2(2015EN))

Patient
Patient
contact	NL-CM:3.1.1	Contact
relationship (relationship)	NL-CM:3.1.3	Relationship
relationship (role)	NL-CM:3.1.2	Role
name	NL-CM:3.1.4	NameInformation
telecom	NL-CM:3.1.6	TelephoneEmail::ContactInformation
address	NL-CM:3.1.5	AddressInformation

Mappings for HCIM HealthcareProvider-v1.2(2015EN) (https://zibs.nl/wiki/HealthcareProvider-v1.2(2015EN))

Patient
Patient
generalPractitioner	NL-CM:17.2.1	HealthcareProvider

Mappings for HCIM HealthProfessional-v1.2.1(2015EN) (https://zibs.nl/wiki/HealthProfessional-v1.2.1(2015EN))

Patient
Patient
generalPractitioner	NL-CM:17.1.1	HealthProfessional

Mappings for HCIM Nationality-v2.0(2015EN) (https://zibs.nl/wiki/Nationality-v2.0(2015EN))

Patient
Patient
extension (nationality)	NL-CM:7.6.3	Nationality

Mappings for HCIM Payer-v1.2(2015EN) (https://zibs.nl/wiki/Payer-v1.2(2015EN))

Patient
Patient	NL-CM:1.1.2	PayerPerson
name	NL-CM:1.1.5	PayerName
text	NL-CM:1.1.5	PayerName
telecom	NL-CM:1.1.12	TelephoneEmail::ContactInformation
address	NL-CM:1.1.17	AddressInformation
contact
name
text	NL-CM:1.1.5	PayerName

Mappings for HCIM FamilySituation-v1.0(2015EN) (https://zibs.nl/wiki/FamilySituation-v1.0(2015EN))

Patient
Patient
maritalStatus	NL-CM:7.13.7	FamilySituation

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

Patient
Patient	Entity. Role, or Act, Patient[classCode=PAT]
text	Act.text?
contained	N/A
extension
extension (preferredPharmacy)	n/a, N/A
extension (nationality)
id	n/a
extension	n/a
extension (code)
id	n/a
extension	n/a
url	N/A
valueCodeableConcept (valueCodeableConcept)	N/A
extension (period)
id	n/a
extension	n/a
url	N/A
valuePeriod (valuePeriod)	N/A
url	N/A
extension (legalStatus)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
extension (lifeStance)	n/a, N/A
id	n/a
extension	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
modifierExtension	N/A
identifier	id
identifier (BSN)	id
id	n/a
extension	n/a
use	Role.code or implied by context
type	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)
period	Role.effectiveTime or implied by context
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
active	statusCode
name	n/a, EN (actually, PN)
id	n/a
extension
extension (humannameAssemblyOrder)
id	n/a
extension	n/a
url	N/A
valueCode (valueCode)	N/A
use	unique(./use)
text	./formatted
family	./part[partType = FAM]
extension
extension (humannameOwnPrefix)	ENXP where Qualifiers = (VV, R)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
extension (humannameOwnName)	ENXP where Qualifiers = (BR)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
extension (humannamePartnerPrefix)	ENXP where Qualifiers = (VV, SP)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
extension (humannamePartnerName)	ENXP where Qualifiers = (SP)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
given	./part[partType = GIV]
extension
extension (iso21090EnQualifier)	ENXP.qualifier
id	n/a
extension	n/a
url	N/A
valueCode (valueCode)	N/A
prefix	./part[partType = PFX]
suffix	./part[partType = SFX]
period	./usablePeriod[type="IVL<TS>"]
telecom	n/a, TEL
gender	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
extension
extension (GeslachtCodelijst)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
birthDate	player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
deceased[x]	player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
address	n/a, AD
maritalStatus	player[classCode=PSN]/maritalStatusCode
multipleBirth[x]	player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
photo	player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
contact	player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
id	n/a
extension	n/a
modifierExtension	N/A
relationship	code
relationship (relationship)	code
relationship (role)	code
name	n/a, EN (actually, PN)
id	n/a
extension
extension (humannameAssemblyOrder)
id	n/a
extension	n/a
url	N/A
valueCode (valueCode)	N/A
use	unique(./use)
text	./formatted
family	./part[partType = FAM]
extension
extension (humannameOwnPrefix)	ENXP where Qualifiers = (VV, R)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
extension (humannameOwnName)	ENXP where Qualifiers = (BR)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
extension (humannamePartnerPrefix)	ENXP where Qualifiers = (VV, SP)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
extension (humannamePartnerName)	ENXP where Qualifiers = (SP)
id	n/a
extension	n/a
url	N/A
valueString (valueString)	N/A
given	./part[partType = GIV]
extension
extension (iso21090EnQualifier)	ENXP.qualifier
id	n/a
extension	n/a
url	N/A
valueCode (valueCode)	N/A
prefix	./part[partType = PFX]
suffix	./part[partType = SFX]
period	./usablePeriod[type="IVL<TS>"]
telecom	n/a, TEL
address	n/a, AD
gender	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
organization	scoper
period	effectiveTime
animal	player[classCode=ANM]
id	n/a
extension	n/a
modifierExtension	N/A
species	code
breed	playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code
genderStatus	genderStatusCode
communication	LanguageCommunication
id	n/a
extension
extension (languageProficiency)
id	n/a
extension
extension (type)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
value[x] (valueCoding)	N/A
extension (level)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
value[x] (valueCoding)	N/A
url	N/A
modifierExtension	N/A
language	player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
preferred	preferenceInd
generalPractitioner	subjectOf.CareEvent.performer.AssignedEntity
id	n/a
extension (practitionerRole)	n/a, N/A
reference	N/A
identifier	.identifier
display	N/A
managingOrganization	scoper
link	outboundLink
id	n/a
extension	n/a
modifierExtension	N/A
other	id
type	typeCode

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

Patient
Patient	ClinicalDocument.recordTarget.patientRole
identifier	.id
identifier (BSN)	.id
active	n/a
gender	.patient.administrativeGenderCode
birthDate	.patient.birthTime
deceased[x]	n/a
maritalStatus	.patient.maritalStatusCode
multipleBirth[x]	n/a
photo	n/a
contact	n/a
relationship	n/a
relationship (relationship)	n/a
relationship (role)	n/a
gender	n/a
organization	n/a
period	n/a
animal	n/a
species	n/a
breed	n/a
genderStatus	n/a
communication	patient.languageCommunication
language	.languageCode
preferred	.preferenceInd
generalPractitioner	n/a
managingOrganization	.providerOrganization
link	n/a
other	n/a
type	n/a

Mappings for W5 Mapping (http://hl7.org/fhir/w5)

Patient
Patient	administrative.individual
identifier	id
identifier (BSN)	id
active	status

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

Patient
Patient
extension
extension (preferredPharmacy)
extension (nationality)
extension (legalStatus)
value[x]
value[x] (valueCodeableConcept)
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
extension (lifeStance)
value[x]
value[x] (valueCodeableConcept)
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
identifier	PID-3
identifier (BSN)	PID-3
use	N/A
type	CX.5
system	CX.4 / EI-2-4
value	CX.1 / EI.1
period	CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
name	XPN
use	XPN.7, but often indicated by which field contains the name
text	implied by XPN.11
family	XPN.1/FN.1
extension (humannameOwnPrefix)	FN.2
extension (humannameOwnName)	FN.3
extension (humannamePartnerPrefix)	FN.4
extension (humannamePartnerName)	FN.5
given	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
telecom	XTN
gender	PID-8
birthDate	PID-7
deceased[x]	PID-30 (bool) and PID-29 (datetime)
address	XAD
maritalStatus	PID-16
multipleBirth[x]	PID-24 (bool), PID-25 (integer)
photo	OBX-5 - needs a profile
contact
relationship	NK1-7, NK1-3
relationship (relationship)	NK1-7, NK1-3
relationship (role)	NK1-7, NK1-3
name	XPN
use	XPN.7, but often indicated by which field contains the name
text	implied by XPN.11
family	XPN.1/FN.1
extension (humannameOwnPrefix)	FN.2
extension (humannameOwnName)	FN.3
extension (humannamePartnerPrefix)	FN.4
extension (humannamePartnerName)	FN.5
given	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
telecom	XTN
address	XAD
gender	NK1-15
organization	NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
animal
species	PID-35
breed	PID-37
genderStatus	N/A
communication
language	PID-15, LAN-2
preferred	PID-15
generalPractitioner	PD1-4
link
other	PID-3, MRG-1

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

Patient
Patient
birthDate	21112-8