Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). 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 GroupMaturity Level: N/AStandards 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)

Immunizationclinical.medication
    identifierFiveWs.identifier
    statusFiveWs.status
    vaccineCodeFiveWs.what[x]
    administeredProductFiveWs.what[x]
    patientFiveWs.subject[x]
    encounterFiveWs.context
    supportingInformationFiveWs.context
    occurrence[x]FiveWs.done[x]
    primarySourceFiveWs.source
    informationSourceFiveWs.source
    locationFiveWs.where[x]
        actorFiveWs.actor

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

ImmunizationEvent
    identifierEvent.identifier
    basedOnEvent.basedOn
    statusEvent.status
    statusReasonEvent.statusReason
    vaccineCodeEvent.code
    administeredProductEvent.code
    patientEvent.subject
    encounterEvent.encounter
    occurrence[x]Event.occurrence[x]
    primarySourceEvent.reported
    informationSourceEvent.reported
    locationEvent.location
    performerEvent.performer
        functionEvent.performer.function
        actorEvent.performer.actor
    noteEvent.note
    reasonEvent.reason

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

ImmunizationVXU_V04
    identifier
    basedOn
    status
    statusReason
    vaccineCodeRXA-5
    administeredProductRXA-5
    manufacturerRXA-17
    lotNumberRXA-15
    expirationDateRXA-16
    patientPID-3
    encounterPV1-19
    supportingInformation
    occurrence[x]RXA-3
    primarySourceRXA-9
    informationSourceRXA-9
    locationRXA-27 (or RXA-11, deprecated as of v2.7)
    siteRXR-2
    routeRXR-1
    doseQuantityRXA-6 / RXA-7
    performerORC-12 / RXA-10
        function
        actor
    noteOBX-5 : OBX-3 = 48767-8
    reason
    isSubpotentRXA-20 = PA (partial administration)
    subpotentReason
    programEligibilityOBX-5 : OBX-3 = 64994-7
        program
        programStatus
    fundingSource
    reactionOBX-3
        dateOBX-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)
        manifestationOBX-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
    identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
    basedOn
    status
    statusReason
    vaccineCodeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    administeredProductClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    manufacturerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
    lotNumberClinicalDocument/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
    siteClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
    routeClinicalDocument/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)

ImmunizationSubstanceAdministration
    identifier.id
    basedOnN/A
    statusstatusCode
    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
    encountercomponent->EncounterEvent
    occurrence[x].effectiveTime
    primarySourceimmunization.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
    siteobservation.targetSiteCode
    route.routeCode
    doseQuantity.doseQuantity
    performer.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
        function.participation.functionCode
        actor.player
    notenote
    reason[actionNegationInd=false].reasonCode
    isSubpotentN/A
    subpotentReasonN/A
    programEligibilityn/a
        programn/a
        programStatusn/a
    fundingSourceN/A
    reactionObservation[classCode=obs].code
        date.effectiveTime
        manifestation.value
        reported.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
    protocolAppliedN/A
        seriesN/A
        authorityN/A
        targetDiseaseN/A
        doseNumberN/A
        seriesDosesN/A