FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3 R2

11.6.7 11.7.7 Resource Immunization - Mappings

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

Mappings:

RIM FiveWs Pattern Mapping

CDA (R2) Workflow Pattern

HL7 v2 Mapping

Workflow CDA (R2)

RIM Mapping

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

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

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

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

.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime .routeCode .doseQuantity .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE] .participation.functionCode .player .effectiveTime .value .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
    expirationDate Immunization Event
    site     identifier observation.targetSiteCode Event.identifier
    route     status Event.status
    doseQuantity     statusReason Event.statusReason
    practitioner     vaccineCode Event.code
        role     patient Event.subject
        actor     encounter Event.context
    note     occurrence[x] note Event.occurrence[x]
    explanation     location n/a Event.location
        reason     performer [actionNegationInd=false].reasonCode Event.performer
        reasonNotGiven         function [actionNegationInd=true].reasonCode Event.performer.function
    reaction         actor Observation[classCode=obs].code Event.performer.actor
        date     note Event.note
        detail     reasonCode Event.reasonCode
        reported     reasonReference Event.reasonReference

11.7.7.3 HL7 v2 Mapping ( http://hl7.org/v2 )

.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 11.6.7.2 Mappings for CDA (R2) (http://hl7.org/v3/cda)
    vaccinationProtocol Immunization outboundRelationship[typeCode=INST].target[classCode=SBADM] VXU_V04
        doseSequence     identifier outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber
        description     status outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
        authority     statusReason outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV
        series     vaccineCode outboundRelationship[typeCode=INST].target[classCode=SBADM] RXA-5
        seriesDoses     patient outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text PID-3
        targetDisease     encounter outboundRelationship.target[classCode=OBS].code PV1-19
        doseStatus     occurrence[x] RXA-3
        doseStatusReason     recorded
Immunization     primarySource RXA-9
    identifier     reportOrigin ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id RXA-9
    status     location RXA-27 (or RXA-11, deprecated as of v2.7)
    notGiven     manufacturer RXA-17
    vaccineCode     lotNumber ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code RXA-15
    patient     expirationDate RXA-16
    encounter     site RXR-2
    date     route ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value RXR-1
    primarySource     doseQuantity RXA-6 / RXA-7
    reportOrigin     performer ORC-12 / RXA-10
    location         function
    manufacturer         actor ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
    lotNumber     note ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText OBX-5 : OBX-3 = 48767-8
    expirationDate     reasonCode
    site     reasonReference ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
    route     isSubpotent ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code RXA-20 = PA (partial administration)
    doseQuantity     subpotentReason
    practitioner     education
        role         documentType OBX-5 : OBX-3 = 69764-9
        actor         reference
    note         publicationDate OBX-5 : OBX-3 = 29768-9
    explanation         presentationDate OBX-5 : OBX-3 = 29769-7
        reason     programEligibility OBX-5 : OBX-3 = 64994-7
        reasonNotGiven     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         reported OBX-5
    vaccinationProtocol         reported         doseSequence (HL7 v2 doesn't seem to provide for this)
        description     protocolApplied         authority
        series
        seriesDoses         authority
        targetDisease
        doseStatus         doseNumber[x]
        doseStatusReason         seriesDoses[x]

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

Immunization VXU_V04
    identifier ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
    status
    notGiven     statusReason
    vaccineCode RXA-5 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    patient PID-3
    encounter PV1-19
    date     occurrence[x] RXA-3 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
    recorded
    primarySource RXA-9
    reportOrigin RXA-9
    location RXA-27 (or RXA-11, deprecated as of v2.7)
    manufacturer RXA-17 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
    lotNumber RXA-15 ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
    expirationDate RXA-16
    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     reasonCode
        reason     reasonReference
        reasonNotGiven     isSubpotent RXA-18
    reaction     subpotentReason OBX-3
        date     education 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         documentType OBX-5
        reported         reference (no such concept seems to exist for allergy/adverse reaction in HL7 v2)
    vaccinationProtocol         publicationDate (HL7 v2 doesn't seem to provide for this)
        doseSequence         presentationDate
        description     programEligibility
        authority     fundingSource
    reaction
        date
        detail
        reported
    protocolApplied
        series
        seriesDoses         authority
        targetDisease
        doseStatus         doseNumber[x]
        doseStatusReason         seriesDoses[x]

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

Event.identifier Event.notDone Event.code Event.subject
Immunization SubstanceAdministration
    identifier .id
    status Event.status statusCode
    notGiven     statusReason .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
    vaccineCode .code
    patient .partipication[ttypeCode=].role
    encounter Event.context component->EncounterEvent
    date     occurrence[x] .effectiveTime
Event.occurrence.occurrenceDateTime     recorded .participation[typeCode=AUT].time
    primarySource immunization.uncertaintycode (if primary source=false, uncertainty=U)
    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)
    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
    practitioner     performer .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
Event.performer         function .participation.functionCode
        role         actor .player
Event.performer.role     note note
        actor     reasonCode Event.performer.actor [actionNegationInd=false].reasonCode
    note     reasonReference Event.note N/A
    explanation     isSubpotent N/A
        reason     subpotentReason Event.reasonCodeableConcept N/A
        reasonNotGiven     education Event.notDoneReason N/A
    reaction         documentType N/A
        date         reference N/A
        detail         publicationDate N/A
        reported         presentationDate N/A
    vaccinationProtocol     programEligibility N/A
        doseSequence     fundingSource N/A
        description     reaction Observation[classCode=obs].code
        authority         date .effectiveTime
        detail .value
        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[x] N/A
        doseStatusReason         seriesDoses[x] N/A