FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

11.6.7 14.6.8 Resource Immunization - Mappings

Maturity Level : N/A
Responsible Owner: Public Health and Emergency Response icon Work Group Ballot Standards Status : Informative Security Category : Patient Compartments : Patient , Practitioner

Mappings:

RIM FiveWs Pattern Mapping

CDA (R2) Workflow Pattern

HL7 v2 V2 Mapping

Workflow CDA (R2)

RIM Mapping

Mappings for the immunization resource. Immunization resource (see Mappings to Other Standards for further information & status).

11.6.7.1 14.6.8.1 Mappings for RIM FiveWs Pattern Mapping (http://hl7.org/v3) ( http://hl7.org/fhir/fivews icon )

.id .code .partipication[ttypeCode=].role .effectiveTime .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
Immunization SubstanceAdministration clinical.medication
    identifier FiveWs.identifier
    status statusCode FiveWs.status
    notGiven     vaccineCode [actionNegationInd=true].reasonCode FiveWs.what[x]
    vaccineCode     administeredProduct FiveWs.what[x]
    patient FiveWs.subject
    encounter component->EncounterEvent FiveWs.context
    date     supportingInformation FiveWs.context
    primarySource     occurrence[x] immunization.uncertaintycode (if primary source=false, uncertainty=U) FiveWs.done[x]
    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)     primarySource     location .participation[typeCode=LOC].COCT_MT240000UV FiveWs.source
    manufacturer .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]     informationSource     lotNumber .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id FiveWs.source
    expirationDate     location FiveWs.where[x]
    site         actor observation.targetSiteCode FiveWs.actor
    route .routeCode

14.6.8.2 Workflow Pattern ( http://hl7.org/fhir/workflow icon     doseQuantity ) .doseQuantity     practitioner .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

.effectiveTime .value .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true) .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 .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
        role .participation.functionCode         actor Immunization .player Event
    note     identifier note Event.identifier
    explanation     basedOn n/a Event.basedOn
        reason     status [actionNegationInd=false].reasonCode Event.status
        reasonNotGiven     statusReason [actionNegationInd=true].reasonCode Event.statusReason
    reaction     vaccineCode Observation[classCode=obs].code Event.code
        date     administeredProduct Event.code
        detail     patient Event.subject
        reported     encounter Event.encounter
    vaccinationProtocol     occurrence[x] outboundRelationship[typeCode=INST].target[classCode=SBADM] Event.occurrence[x]
        doseSequence     primarySource outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber Event.reported
        description     informationSource outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text Event.reported
        authority     location outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV Event.location
        series     performer outboundRelationship[typeCode=INST].target[classCode=SBADM] Event.performer
        seriesDoses         function outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text Event.performer.function
        targetDisease         actor outboundRelationship.target[classCode=OBS].code Event.performer.actor
        doseStatus     note Event.note
        doseStatusReason     reason Event.reason

11.6.7.2 14.6.8.3 Mappings for CDA (R2) (http://hl7.org/v3/cda) HL7 V2 Mapping ( http://hl7.org/v2 icon )

The mappings provided in this tab are indicative of how HL7 v2 fields relate to HL7 FHIR attributes in this resource, but is not complete and without critical HL7 v2 context. The HL7 v2-FHIR Implementation guide, located here icon , provides additional guidance on transforming an HL7 v2 message to FHIR resources for FHIR R4 and FHIR R6.
Immunization VXU_V04
    identifier
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id     basedOn
    status
    notGiven     statusReason
    vaccineCode ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code RXA-5
    patient     administeredProduct RXA-5
    encounter     manufacturer RXA-17
    date     lotNumber ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value RXA-15
    primarySource     expirationDate RXA-16
    reportOrigin     patient PID-3
    encounter PV1-19
    location     supportingInformation
    manufacturer     occurrence[x] ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name RXA-3
    lotNumber     primarySource ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText RXA-9
    expirationDate     informationSource RXA-9
    location RXA-27 (or RXA-11, deprecated as of v2.7)
    site ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code RXR-2
    route ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code RXR-1
    doseQuantity RXA-6 / RXA-7
    practitioner     performer ORC-12 / RXA-10
        role         function
        actor
    note OBX-5 : OBX-3 = 48767-8
    explanation     reason
        reason     isSubpotent RXA-20 = PA (partial administration)
        reasonNotGiven     subpotentReason
    reaction     programEligibility OBX-5 : OBX-3 = 64994-7
        date         program
        detail         programStatus
        reported     fundingSource
    vaccinationProtocol     reaction OBX-3
        doseSequence         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)
        description         manifestation OBX-5
        reported (HL7 V2 doesn't seem to provide for this)
        authority     protocolApplied
        series
        seriesDoses         authority
        targetDisease
        doseStatus         doseNumber
        doseStatusReason         seriesDoses

11.6.7.3 14.6.8.4 Mappings for HL7 v2 Mapping (http://hl7.org/v2) CDA (R2) ( http://hl7.org/v3/cda icon )

Immunization VXU_V04
    identifier ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
    basedOn
    status
    notGiven     statusReason
    vaccineCode RXA-5 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    patient     administeredProduct PID-3 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    encounter     manufacturer PV1-19 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
    date     lotNumber RXA-3 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
    primarySource     expirationDate RXA-9
    reportOrigin     patient RXA-9
    location     encounter RXA-27 (or RXA-11, deprecated as of v2.7)
    manufacturer     supportingInformation RXA-17
    lotNumber     occurrence[x] ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
RXA-15     primarySource
    expirationDate     informationSource
RXA-16     location
    site RXR-2 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
    route RXR-1 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
    doseQuantity RXA-6 / RXA-7.1
    practitioner     performer ORC-12 / RXA-10
        role         function
        actor
    note
    explanation     reason
        reason     isSubpotent
        reasonNotGiven     subpotentReason RXA-18
    reaction     programEligibility OBX-3
        date         program 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         programStatus OBX-5
        reported     fundingSource (no such concept seems to exist for allergy/adverse reaction in HL7 v2)
    vaccinationProtocol     reaction
(HL7 v2 doesn't seem to provide for this)         date
        doseSequence         manifestation
        description         reported
        authority     protocolApplied
        series
        seriesDoses         authority
        targetDisease
        doseStatus         doseNumber
        doseStatusReason         seriesDoses

11.6.7.4 14.6.8.5 Mappings for Workflow RIM Mapping (http://hl7.org/fhir/workflow) ( http://hl7.org/v3 icon )

Event.notDone Event.code Event.subject Event.context Event.performer Event.performer.role Event.performer.actor
Immunization SubstanceAdministration
    identifier .id
Event.identifier     basedOn N/A
    status Event.status statusCode
    notGiven     statusReason .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
    vaccineCode .code
    patient     administeredProduct .code
    encounter     manufacturer .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
    date     lotNumber .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
Event.occurrence.occurrenceDateTime     expirationDate .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
    primarySource     patient .partipication[ttypeCode=].role
    reportOrigin     encounter component->EncounterEvent
    location     occurrence[x] .effectiveTime
    manufacturer     primarySource immunization.uncertaintycode (if primary source=false, uncertainty=U)
    lotNumber     informationSource .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)
    expirationDate     location .participation[typeCode=LOC].COCT_MT240000UV
    site observation.targetSiteCode
    route .routeCode
    doseQuantity .doseQuantity
    practitioner     performer .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
        role         function .participation.functionCode
        actor .player
    note Event.note note
    explanation     reason [actionNegationInd=false].reasonCode
        reason     isSubpotent Event.reasonCodeableConcept N/A
        reasonNotGiven     subpotentReason Event.notDoneReason N/A
    reaction     programEligibility n/a
        date         program n/a
        detail         programStatus n/a
        reported     fundingSource N/A
    vaccinationProtocol     reaction Observation[classCode=obs].code
        doseSequence         date .effectiveTime
        description         manifestation .value
        authority         reported .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
    protocolApplied N/A
        series N/A
        seriesDoses         authority N/A
        targetDisease N/A
        doseStatus         doseNumber N/A
        doseStatusReason         seriesDoses N/A