FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

11.7.8 Resource Immunization - Mappings

Responsible Owner: Public Health icon Work GroupStandards Status: InformativeSecurity Category: Patient Compartments: Patient, Practitioner

Mappings:

FiveWs Pattern Mapping

Workflow Pattern

HL7 V2 Mapping

CDA (R2)

RIM Mapping

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

11.7.8.1 FiveWs Pattern Mapping (http://hl7.org/fhir/fivews icon)

Immunization clinical.medication
    identifier FiveWs.identifier
    status FiveWs.status
    vaccineCode FiveWs.what[x]
    administeredProduct FiveWs.what[x]
    patient FiveWs.subject
    encounter FiveWs.context
    supportingInformation FiveWs.context
    occurrence[x] FiveWs.done[x]
    primarySource FiveWs.source
    informationSource FiveWs.source
    location FiveWs.where[x]
        actor FiveWs.actor

11.7.8.2 Workflow Pattern (http://hl7.org/fhir/workflow icon)

Immunization Event
    identifier Event.identifier
    basedOn Event.basedOn
    status Event.status
    statusReason Event.statusReason
    vaccineCode Event.code
    administeredProduct Event.code
    patient Event.subject
    encounter Event.encounter
    occurrence[x] Event.occurrence[x]
    primarySource Event.reported
    informationSource Event.reported
    location Event.location
    performer Event.performer
        function Event.performer.function
        actor Event.performer.actor
    note Event.note
    reason Event.reason

11.7.8.3 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
    basedOn
    status
    statusReason
    vaccineCode RXA-5
    administeredProduct RXA-5
    manufacturer RXA-17
    lotNumber RXA-15
    expirationDate RXA-16
    patient PID-3
    encounter PV1-19
    supportingInformation
    occurrence[x] RXA-3
    primarySource RXA-9
    informationSource RXA-9
    location RXA-27 (or RXA-11, deprecated as of v2.7)
    site RXR-2
    route RXR-1
    doseQuantity RXA-6 / RXA-7
    performer ORC-12 / RXA-10
        function
        actor
    note OBX-5 : OBX-3 = 48767-8
    reason
    isSubpotent RXA-20 = PA (partial administration)
    subpotentReason
    programEligibility OBX-5 : OBX-3 = 64994-7
        program
        programStatus
    fundingSource
    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)
        manifestation OBX-5
        reported (HL7 V2 doesn't seem to provide for this)
    protocolApplied
        series
        authority
        targetDisease
        doseNumber
        seriesDoses

11.7.8.4 CDA (R2) (http://hl7.org/v3/cda icon)

Immunization
    identifier ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
    basedOn
    status
    statusReason
    vaccineCode ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    administeredProduct ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    manufacturer ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
    lotNumber ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
    expirationDate
    patient
    encounter
    supportingInformation
    occurrence[x] ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
    primarySource
    informationSource
    location
    site ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
    route ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
    doseQuantity
    performer
        function
        actor
    note
    reason
    isSubpotent
    subpotentReason
    programEligibility
        program
        programStatus
    fundingSource
    reaction
        date
        manifestation
        reported
    protocolApplied
        series
        authority
        targetDisease
        doseNumber
        seriesDoses

11.7.8.5 RIM Mapping (http://hl7.org/v3 icon)

Immunization SubstanceAdministration
    identifier .id
    basedOn N/A
    status statusCode
    statusReason .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
    vaccineCode .code
    administeredProduct .code
    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
    patient .partipication[ttypeCode=].role
    encounter component->EncounterEvent
    occurrence[x] .effectiveTime
    primarySource immunization.uncertaintycode (if primary source=false, uncertainty=U)
    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)
    location .participation[typeCode=LOC].COCT_MT240000UV
    site observation.targetSiteCode
    route .routeCode
    doseQuantity .doseQuantity
    performer .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
        function .participation.functionCode
        actor .player
    note note
    reason [actionNegationInd=false].reasonCode
    isSubpotent N/A
    subpotentReason N/A
    programEligibility n/a
        program n/a
        programStatus n/a
    fundingSource N/A
    reaction Observation[classCode=obs].code
        date .effectiveTime
        manifestation .value
        reported .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
    protocolApplied N/A
        series N/A
        authority N/A
        targetDisease N/A
        doseNumber N/A
        seriesDoses N/A