MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions

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

Resource Profile: MHVimmunization - Mappings

Page standards status: Trial-use

Maturity Level: 4

Mappings for the VA.MHV.PHR.immunization resource profile.

Mappings for VIA to mhv-fhir-phr (ImmunizationTO)

Informative map to available elements in MHV FHIR API

MHVimmunization
Immunization	ImmunizationTO	Vista FileMan
identifier	{StationNbr} and {ImmunizationTO.id}
status	`completed` if not `entered-in-error`
vaccineCode
coding
code	ImmunizationTO.cptCode.id	9000010.11-.13 CREATED BY V CPT ENTRY
display	ImmunizationTO.cptCode.name
text	ImmunizationTO.name	9000010.11-.01 IMMUNIZATION
patient	patient	9000010.11-.02 PATIENT
occurrence[x]	ImmunizationTO.administeredDate	9000010.11-.1201 EVENT DATE AND TIME
recorded	ImmunizationTO.dateTime	9000010.11-.1205 DATE/TIME RECORDED
primarySource	Data Absent Reason - unknown
location	GetLocation(ImmunizationTO.encounter.location)
performer	GetPractitioner(ImmunizationTO.encounter.provider) | `AP`, GetOrganization(ImmunizationTO.encounter.facility)	,
note
text	ImmunizationTO.comments	9000010.11-.1101 REMARKS
reaction
detail
reference	contained Observation with ImmunizationTO.reaction	9000010.11-.06 REACTION
protocolApplied
series	translation of ImmunizationTO.series	9000010.11-.04 SERIES
doseNumber[x] (doseNumberString)	number from ImmunizationTO.series	9000010.11-.04 SERIES

Mappings for eVault-PHR to MHV-PHR (eVaultPHR)

Informative map that includes only the elements available in eVault PHR

MHVimmunization
Immunization	ImmunizationTO
status	`completed`
vaccineCode
text	ImmunizationTO.name	Immunization
patient	patient
occurrence[x]	ImmunizationTO.administeredDate	Event Date and Time
note
text	ImmunizationTO.comments	Remarks
reaction
detail
reference	contained Observation with ImmunizationTO.reaction	Reaction
protocolApplied
series	translation of ImmunizationTO.series	Series

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

MHVimmunization
Immunization	Event
identifier	Event.identifier
identifier (TOid)	Event.identifier
status	Event.status
vaccineCode	Event.code
patient	Event.subject
occurrence[x]	Event.occurrence[x]
location	Event.location
performer	Event.performer
function	Event.performer.function
actor	Event.performer.actor
performer (AP)	Event.performer
function	Event.performer.function
actor	Event.performer.actor
performer (@default)	Event.performer
actor	Event.performer.actor
note	Event.note

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

MHVimmunization
Immunization	VXU_V04
identifier
identifier (TOid)
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)
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
text	C*E.9. But note many systems use C*E.2 for this
patient	PID-3
occurrence[x]	RXA-3
primarySource	RXA-9
location	RXA-27 (or RXA-11, deprecated as of v2.7)
performer	ORC-12 / RXA-10
performer (AP)	ORC-12 / RXA-10
performer (@default)	ORC-12 / RXA-10
note	OBX-5 : OBX-3 = 48767-8
author[x]	N/A
time	N/A
text	N/A
reaction	OBX-3
detail	OBX-5

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

MHVimmunization
Immunization	Entity. Role, or Act, SubstanceAdministration
text	Act.text?
contained	N/A
extension	N/A
modifierExtension	N/A
identifier	.id
identifier (TOid)	.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
status	statusCode
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
text	./originalText[mediaType/code="text/plain"]/data
patient	.partipication[ttypeCode=].role
occurrence[x]	.effectiveTime
recorded	.participation[typeCode=AUT].time
primarySource	immunization.uncertaintycode (if primary source=false, uncertainty=U)
extension
extension (dar)	ANY.nullFlavor
id	n/a
url	N/A
value[x]	N/A
location	.participation[typeCode=LOC].COCT_MT240000UV
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
performer	.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
id	n/a
extension	n/a
modifierExtension	N/A
function	.participation.functionCode
actor	.player
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
performer (AP)	.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
id	n/a
extension	n/a
modifierExtension	N/A
function	.participation.functionCode
actor	.player
performer (@default)	.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
id	n/a
extension	n/a
modifierExtension	N/A
actor	.player
note	note
id	n/a
extension	n/a
author[x]	Act.participant[typeCode=AUT].role
time	Act.effectiveTime
text	Act.text
subpotentReason	N/A
reaction	Observation[classCode=obs].code
id	n/a
extension	n/a
modifierExtension	N/A
detail	.value
id	n/a
extension	n/a
reference	N/A
type	N/A
protocolApplied	N/A
id	n/a
extension	n/a
modifierExtension	N/A
series	N/A
doseNumber[x]	N/A
doseNumber[x] (doseNumberString)	N/A

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

MHVimmunization
Immunization
identifier	FiveWs.identifier
identifier (TOid)	FiveWs.identifier
status	FiveWs.status
vaccineCode	FiveWs.what[x]
patient	FiveWs.subject[x], FiveWs.subject
occurrence[x]	FiveWs.done[x]
recorded	FiveWs.recorded
primarySource	FiveWs.source
location	FiveWs.where[x]
performer
actor	FiveWs.actor
performer (AP)
actor	FiveWs.actor
performer (@default)
actor	FiveWs.actor

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

MHVimmunization
Immunization
identifier	ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
identifier (TOid)	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