STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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.6.7 Resource Immunization - Mappings

Mappings:

RIM Mapping

CDA (R2)

HL7 v2 Mapping

Mappings for the immunization resource.

11.6.7.1 Mappings for RIM Mapping (http://hl7.org/v3)

Immunization SubstanceAdministration
    identifier .id
    status statusCode
    date .effectiveTime
    vaccineCode .code
    patient .partipication[ttypeCode=].role
    wasNotGiven [actionNegationInd=true].reasonCode
    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)
    performer .participation[typeCode=PRF].COCT_MT090102UV
    requester outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV
    encounter component->EncounterEvent
    manufacturer .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
    location .participation[typeCode=LOC].COCT_MT240000UV
    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
    note note
    explanation n/a
        reason [actionNegationInd=false].reasonCode
        reasonNotGiven [actionNegationInd=true].reasonCode
    reaction Observation[classCode=obs].code
        date .effectiveTime
        detail .value
        reported .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
    vaccinationProtocol outboundRelationship[typeCode=INST].target[classCode=SBADM]
        doseSequence outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber
        description outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
        authority outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV
        series outboundRelationship[typeCode=INST].target[classCode=SBADM]
        seriesDoses outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
        targetDisease outboundRelationship.target[classCode=OBS].code
        doseStatus .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
        doseStatusReason .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)

Immunization
    identifier ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
    status
    date ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
    vaccineCode ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    patient
    wasNotGiven
    primarySource
    reportOrigin
    performer ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name
    requester
    encounter
    manufacturer ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
    location
    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
    note
    explanation
        reason
        reasonNotGiven
    reaction
        date
        detail
        reported
    vaccinationProtocol
        doseSequence
        description
        authority
        series
        seriesDoses
        targetDisease
        doseStatus
        doseStatusReason

11.6.7.3 Mappings for HL7 v2 Mapping (http://hl7.org/v2)

Immunization VXU_V04
    identifier
    status
    date RXA-3
    vaccineCode RXA-5
    patient PID-3
    wasNotGiven
    primarySource RXA-9
    reportOrigin RXA-9
    performer RXA-10
    requester ORC-12
    encounter PV1-19
    manufacturer RXA-17
    location RXA-27 (or RXA-11, deprecated as of v2.7)
    lotNumber RXA-15
    expirationDate RXA-16
    site RXR-2
    route RXR-1
    doseQuantity RXA-6 / RXA-7.1
    note
    explanation
        reason
        reasonNotGiven RXA-18
    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 (no such concept seems to exist for allergy/adverse reaction in HL7 v2)
    vaccinationProtocol (HL7 v2 doesn't seem to provide for this)
        doseSequence
        description
        authority
        series
        seriesDoses
        targetDisease
        doseStatus
        doseStatusReason