Release 4 5 Preview #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v4.2.0: R5 Preview #1). 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.7 11.7.8 Resource Immunization - Mappings

Public Health and Emergency Response Work Group Maturity Level : N/A Standards Status : Informative Security 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.7.1 11.7.8.1 FiveWs Pattern Mapping ( http://hl7.org/fhir/fivews )

Immunization
    identifier FiveWs.identifier
    status FiveWs.status
    vaccineCode FiveWs.what[x]
    patient FiveWs.subject[x]
    encounter FiveWs.context
    occurrence[x] FiveWs.done[x]
    recorded FiveWs.recorded
    primarySource FiveWs.source
    reportOrigin     informationSource[x] FiveWs.source
    location FiveWs.where[x]
        actor FiveWs.actor

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

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]
    primarySource Event.reportedBoolean
    informationSource[x] Event.reportedReference
    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.7.3 11.7.8.3 HL7 v2 Mapping ( http://hl7.org/v2 )

Immunization VXU_V04
    identifier
    status
    statusReason
    vaccineCode RXA-5
    patient PID-3
    encounter PV1-19
    occurrence[x] RXA-3
    recorded
    primarySource RXA-9
    reportOrigin     informationSource[x] RXA-9
    location RXA-27 (or RXA-11, deprecated as of v2.7)
    manufacturer RXA-17
    lotNumber RXA-15
    expirationDate RXA-16
    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 OBX-5 : OBX-3 = 69764-9
        reference
        publicationDate OBX-5 : OBX-3 = 29768-9
        presentationDate OBX-5 : OBX-3 = 29769-7
    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 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
        series
        authority
        targetDisease
        doseNumber[x]
        seriesDoses[x]

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

Immunization
    identifier ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
    status
    statusReason
    vaccineCode ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    patient
    encounter
    occurrence[x] ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
    recorded
    primarySource
    reportOrigin     informationSource[x]
    location
    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
    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
    reasonCode     reasonReference     reason
    isSubpotent
    subpotentReason
    education
        documentType
        reference
        publicationDate
        presentationDate
    programEligibility
    fundingSource
    reaction
        date
        detail
        reported
    protocolApplied
        series
        authority
        targetDisease
        doseNumber[x]
        seriesDoses[x]

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

Immunization SubstanceAdministration
    identifier .id
    status statusCode
    statusReason .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
    vaccineCode .code
    patient .partipication[ttypeCode=].role
    encounter component->EncounterEvent
    occurrence[x] .effectiveTime
    recorded .participation[typeCode=AUT].time
    primarySource immunization.uncertaintycode (if primary source=false, uncertainty=U)
    reportOrigin     informationSource[x] .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 N/A
        presentationDate N/A
    programEligibility N/A
    fundingSource N/A
    reaction Observation[classCode=obs].code
        date .effectiveTime
        detail .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] N/A
        seriesDoses[x] N/A