This page is part of the RIVO-Noord Zorgviewer Implementation Guide (v1.11.0: Release) based on FHIR (HL7® FHIR® Standard) R3. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Resource Profile: Vaccination - Mappings

Active as of 2025-01-20

Mappings for the Immunization resource profile.

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

Vaccination
Immunization	NL-CM:11.1.1	Vaccination
vaccineCode	NL-CM:11.1.2	ProductCode
date	NL-CM:11.1.3	VaccinationDate
doseQuantity	NL-CM:11.1.4	Dose
practitioner
actor	NL-CM:11.1.6	Administrator
note
text	NL-CM:11.1.7	Comment

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

Vaccination
Immunization
practitioner
role
coding (healthProfessionalRole)	NL-CM:17.1.5	HealthProfessionalRole

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

Vaccination
Immunization
identifier	NL-CM:0.0.6	IdentificationNumber
patient	NL-CM:0.0.11	Subject
date	NL-CM:0.0.14	DateTime
reportOrigin	NL-CM:0.0.2	InformationSource
practitioner	NL-CM:0.0.7	Author

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

Vaccination
Immunization	NL-CM:11.1.1	Vaccination
vaccineCode	NL-CM:11.1.2	ProductCode
date	NL-CM:11.1.3	VaccinationDate
doseQuantity	NL-CM:11.1.4	Dose
practitioner
actor	NL-CM:11.1.6	Administrator
note
text	NL-CM:11.1.7	Explanation

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

Vaccination
Immunization
practitioner
role
coding (healthProfessionalRole)	NL-CM:17.1.5	HealthcareProviderRole

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

Vaccination
Immunization	NL-CM:11.1.1	Vaccination
vaccineCode	NL-CM:11.1.2	ProductCode
date	NL-CM:11.1.3	VaccinationDate
doseQuantity	NL-CM:11.1.4	Dose
practitioner
actor	NL-CM:11.1.6	Administrator
note
text	NL-CM:11.1.7	Explanation

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

Vaccination
Immunization
practitioner
role
coding (healthProfessionalRole)	NL-CM:17.1.5	HealthcareProviderRole

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

Vaccination
Immunization	VXU_V04
vaccineCode	RXA-5
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
coding (productCodeGPKCodelijst)	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
coding (productCodeHPKCodelijst)	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
coding (productCodeZICodelijst)	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
coding (productCodeATCCodelijst)	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
coding (productCodePRKCodelijst)	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
coding (productCodeGTINCodelijst)	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
patient	PID-3
encounter	PV1-19
date	RXA-3
primarySource	RXA-9
reportOrigin	RXA-9
location	RXA-27 (or RXA-11, deprecated as of v2.7)
manufacturer	RXA-17
lotNumber	RXA-15
expirationDate	RXA-16
site	RXR-2
route	RXR-1
doseQuantity	RXA-6 / RXA-7.1
practitioner	ORC-12 / RXA-10
role
coding	C*E.1-8, C*E.10-22
coding (healthProfessionalRole)	C*E.1-8, C*E.10-22
text	C*E.9. But note many systems use C*E.2 for this
note
author[x]	N/A
time	N/A
text	N/A
explanation
reasonNotGiven	RXA-18
reaction	OBX-3
date	OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)
detail	OBX-5
reported	(no such concept seems to exist for allergy/adverse reaction in HL7 v2)
vaccinationProtocol	(HL7 v2 doesn't seem to provide for this)

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

Vaccination
Immunization	Entity. Role, or Act, SubstanceAdministration
text	Act.text?
contained	N/A
extension	N/A
modifierExtension	N/A
identifier	.id
status	statusCode
notGiven	[actionNegationInd=true].reasonCode
vaccineCode	.code
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
coding (productCodeGPKCodelijst)	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
coding (productCodeHPKCodelijst)	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
coding (productCodeZICodelijst)	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
coding (productCodeATCCodelijst)	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
coding (productCodePRKCodelijst)	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
coding (productCodeGTINCodelijst)	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
patient	.partipication[ttypeCode=].role
encounter	component->EncounterEvent
date	.effectiveTime
primarySource	immunization.uncertaintycode (if primary source=false, uncertainty=U)
reportOrigin	.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)
location	.participation[typeCode=LOC].COCT_MT240000UV
manufacturer	.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
lotNumber	.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
expirationDate	.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
site	observation.targetSiteCode
route	.routeCode
doseQuantity	.doseQuantity
practitioner	.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
id	n/a
extension	n/a
modifierExtension	N/A
role	.participation.functionCode
id	n/a
extension	n/a
coding	union(., ./translation)
coding (healthProfessionalRole)	union(., ./translation)
text	./originalText[mediaType/code="text/plain"]/data
actor	.player
id	n/a
extension (practitionerRole)	n/a, N/A
reference	N/A
identifier	.identifier
display	N/A
note	note
id	n/a
extension	n/a
author[x]	Act.participant[typeCode=AUT].role
time	Act.effectiveTime
text	Act.text
explanation	n/a
id	n/a
extension	n/a
modifierExtension	N/A
reason	[actionNegationInd=false].reasonCode
reasonNotGiven	[actionNegationInd=true].reasonCode
reaction	Observation[classCode=obs].code
id	n/a
extension	n/a
modifierExtension	N/A
date	.effectiveTime
detail	.value
reported	.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
vaccinationProtocol	outboundRelationship[typeCode=INST].target[classCode=SBADM]
id	n/a
extension	n/a
modifierExtension	N/A
doseSequence	outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber
description	outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
authority	outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV
series	outboundRelationship[typeCode=INST].target[classCode=SBADM]
seriesDoses	outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
targetDisease	outboundRelationship.target[classCode=OBS].code
doseStatus	.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value
doseStatusReason	.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode

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

Vaccination
Immunization	clinical.medication
identifier	id
status	status
notGiven	status
vaccineCode	what
patient	who.focus
encounter	context
date	when.init
primarySource	who.source
reportOrigin	who.source
location	where
practitioner
actor	who.actor

Mappings for Workflow Mapping (http://hl7.org/fhir/workflow)

Vaccination
Immunization
identifier	Event.identifier
status	Event.status
notGiven	Event.notDone
vaccineCode	Event.code
patient	Event.subject
encounter	Event.context
date	Event.occurrence.occurrenceDateTime
practitioner	Event.performer
role	Event.performer.role
actor	Event.performer.actor
note	Event.note
explanation
reason	Event.reasonCodeableConcept
reasonNotGiven	Event.notDoneReason

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

Vaccination
Immunization
identifier	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
vaccineCode	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
date	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
manufacturer	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
lotNumber	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
site	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
route	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code