Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU see ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

11.7.8 Resource Immunization - Mappings

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

Mappings:

FiveWs Pattern Mapping

Workflow Pattern

HL7 v2 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
    identifier FiveWs.identifier
    status FiveWs.status
    vaccineCode FiveWs.what[x]
    administeredProduct FiveWs.what[x]
    patient FiveWs.subject[x]
    encounter FiveWs.context
    occurrence[x]     supportingInformation FiveWs.done[x] FiveWs.context
    recorded     occurrence[x] FiveWs.recorded FiveWs.done[x]
    primarySource FiveWs.source
    reportOrigin     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.context 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
    reasonCode Event.reasonCode     reasonReference     reason Event.reasonReference Event.reason

11.7.8.3 HL7 v2 V2 Mapping ( http://hl7.org/v2 icon )

Immunization VXU_V04
    identifier
    basedOn
    status
    statusReason
    vaccineCode RXA-5
    patient     administeredProduct PID-3 RXA-5
    encounter     manufacturer PV1-19 RXA-17
    occurrence[x]     lotNumber RXA-3 RXA-15
    recorded     expirationDate RXA-16
    patient PID-3
    primarySource     encounter RXA-9 PV1-19
    reportOrigin     supportingInformation RXA-9
    location     occurrence[x] RXA-27 (or RXA-11, deprecated as of v2.7) RXA-3
    manufacturer     primarySource RXA-17 RXA-9
    lotNumber     informationSource RXA-15 RXA-9
    expirationDate     location RXA-16 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
    reasonCode     reasonReference     reason
    isSubpotent RXA-20 = PA (partial administration)
    subpotentReason
    education         documentType     programEligibility OBX-5 : OBX-3 = 69764-9 64994-7
        reference         program         publicationDate OBX-5 : OBX-3 = 29768-9
        presentationDate OBX-5 : OBX-3 = 29769-7         programStatus     programEligibility OBX-5 : OBX-3 = 64994-7
    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 V2 VXU message - most likely would appear in OBX segments if at all)
        detail         manifestation OBX-5
        reported (HL7 v2 V2 doesn't seem to provide for this)
    protocolApplied
        series
        authority
        targetDisease
        doseNumber[x]         doseNumber
        seriesDoses[x]         seriesDoses

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

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

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

.partipication[ttypeCode=].role .effectiveTime .participation[typeCode=AUT].time
Immunization SubstanceAdministration
    identifier .id
    basedOn N/A
    status statusCode
    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]
component->EncounterEvent     lotNumber .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
    occurrence[x]     expirationDate .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
    recorded     patient .partipication[ttypeCode=].role
    encounter component->EncounterEvent
    occurrence[x] .effectiveTime
    primarySource immunization.uncertaintycode (if primary source=false, uncertainty=U)
    reportOrigin     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
    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
    performer .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
        function .participation.functionCode
        actor .player
    note note
    reasonCode     reason [actionNegationInd=false].reasonCode
    reasonReference N/A     isSubpotent N/A
    subpotentReason N/A
    education N/A         documentType N/A         reference N/A         publicationDate     programEligibility N/A n/a
        presentationDate         program N/A n/a
    programEligibility         programStatus N/A n/a
    fundingSource N/A
    reaction Observation[classCode=obs].code
        date .effectiveTime
        detail         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[x]         doseNumber N/A
        seriesDoses[x]         seriesDoses N/A