NAPKON Vaccination Module - Local Development build (v1.0.0). See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: COVID19Immunization - Mappings

Mappings for the covid19-immunization resource profile.

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

COVID19Immunization
Immunization	Event
identifier	Event.identifier
status	Event.status
statusReason	Event.statusReason
vaccineCode	Event.code
patient	Event.subject
encounter	Event.context
occurrence[x]	Event.occurrence[x]
occurrence[x] (occurrenceDateTime)	Event.occurrence[x]
location	Event.location
performer	Event.performer
function	Event.performer.function
actor	Event.performer.actor
note	Event.note
reasonCode	Event.reasonCode
reasonReference	Event.reasonReference

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

COVID19Immunization
Immunization	VXU_V04
identifier	CX / EI (occasionally, more often EI maps to a resource id or a URL)
statusReason	CE/CNE/CWE
vaccineCode	CE/CNE/CWE, RXA-5
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
coding (snomed)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 (atc)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 (pzn)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 (absentOrUnknownImmunization)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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 (COVID19VaccineName)	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
text	C*E.9. But note many systems use C*E.2 for this
patient	PID-3
encounter	PV1-19
occurrence[x]	RXA-3
occurrence[x] (occurrenceDateTime)	RXA-3
primarySource	RXA-9
reportOrigin	CE/CNE/CWE, RXA-9
location	RXA-27 (or RXA-11, deprecated as of v2.7)
manufacturer	RXA-17
lotNumber	RXA-15
expirationDate	RXA-16
site	CE/CNE/CWE, RXR-2
route	CE/CNE/CWE, RXR-1
doseQuantity	SN (see also Range) or CQ, RXA-6 / RXA-7
performer	ORC-12 / RXA-10
function	CE/CNE/CWE
note	N/A, OBX-5 : OBX-3 = 48767-8
reasonCode	CE/CNE/CWE
isSubpotent	RXA-20 = PA (partial administration)
subpotentReason	CE/CNE/CWE
education
documentType	OBX-5 : OBX-3 = 69764-9
publicationDate	OBX-5 : OBX-3 = 29768-9
presentationDate	OBX-5 : OBX-3 = 29769-7
programEligibility	CE/CNE/CWE, OBX-5 : OBX-3 = 64994-7
fundingSource	CE/CNE/CWE
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	(HL7 v2 doesn't seem to provide for this)
protocolApplied
targetDisease	CE/CNE/CWE
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, 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

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

COVID19Immunization
Immunization	Entity. Role, or Act, SubstanceAdministration
meta	n/a, N/A
implicitRules	n/a
language	n/a
text	n/a, N/A, Act.text?
contained	Entity. Role, or Act, N/A
extension	n/a, N/A
modifierExtension	n/a, N/A
identifier	n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT], .id
status	n/a, statusCode
statusReason	n/a, CD, .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
vaccineCode	n/a, CD, .code
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
coding (snomed)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (atc)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (pzn)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (absentOrUnknownImmunization)	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
coding (COVID19VaccineName)	n/a, CV, union(., ./translation)
text	n/a, ./originalText[mediaType/code="text/plain"]/data
patient	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .partipication[ttypeCode=].role
encounter	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), component->EncounterEvent
occurrence[x]	n/a, .effectiveTime
occurrence[x] (occurrenceDateTime)	n/a, .effectiveTime
recorded	n/a, .participation[typeCode=AUT].time
primarySource	n/a, immunization.uncertaintycode (if primary source=false, uncertainty=U)
reportOrigin	n/a, CD, .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	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode=LOC].COCT_MT240000UV
manufacturer	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
lotNumber	n/a, .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
expirationDate	n/a, .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
site	n/a, CD, observation.targetSiteCode
route	n/a, CD, .routeCode
doseQuantity	n/a, PQ, IVL<PQ>, MO, CO, depending on the values, .doseQuantity
performer	n/a, .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
function	n/a, CD, .participation.functionCode
actor	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .player
note	n/a, Act, note
reasonCode	n/a, CD, [actionNegationInd=false].reasonCode
reasonReference	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), N/A
isSubpotent	n/a, N/A
subpotentReason	n/a, CD, N/A
education	n/a, N/A
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
documentType	n/a, N/A
reference	n/a, N/A
publicationDate	n/a, N/A
presentationDate	n/a, N/A
programEligibility	n/a, CD, N/A
fundingSource	n/a, CD, N/A
reaction	n/a, Observation[classCode=obs].code
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
date	n/a, .effectiveTime
detail	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .value
reported	n/a, .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
protocolApplied	n/a, N/A
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
series	n/a, N/A
authority	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), N/A
targetDisease	n/a, CD, N/A
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
doseNumber[x]	n/a, N/A
doseNumber[x] (doseNumberPositiveInt)	n/a, N/A
seriesDoses[x]	n/a, N/A

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

COVID19Immunization
Immunization
identifier	FiveWs.identifier
status	FiveWs.status
vaccineCode	FiveWs.what[x]
patient	FiveWs.subject[x], FiveWs.subject
encounter	FiveWs.context
occurrence[x]	FiveWs.done[x]
occurrence[x] (occurrenceDateTime)	FiveWs.done[x]
recorded	FiveWs.recorded
primarySource	FiveWs.source
reportOrigin	FiveWs.source
location	FiveWs.where[x]
performer
actor	FiveWs.actor

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

COVID19Immunization
Immunization
identifier	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
vaccineCode	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
occurrence[x]	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
occurrence[x] (occurrenceDateTime)	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