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)

ImmunizationSubstanceAdministration
    identifier.id
    statusstatusCode
    date.effectiveTime
    vaccineCode.code
    patient.partipication[ttypeCode=].role
    wasNotGiven[actionNegationInd=true].reasonCode
    primarySourceimmunization.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
    requesteroutboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV
    encountercomponent->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
    siteobservation.targetSiteCode
    route.routeCode
    doseQuantity.doseQuantity
    notenote
    explanationn/a
        reason[actionNegationInd=false].reasonCode
        reasonNotGiven[actionNegationInd=true].reasonCode
    reactionObservation[classCode=obs].code
        date.effectiveTime
        detail.value
        reported.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
    vaccinationProtocoloutboundRelationship[typeCode=INST].target[classCode=SBADM]
        doseSequenceoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber
        descriptionoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
        authorityoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV
        seriesoutboundRelationship[typeCode=INST].target[classCode=SBADM]
        seriesDosesoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
        targetDiseaseoutboundRelationship.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
    identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
    status
    dateClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
    vaccineCodeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
    patient
    wasNotGiven
    primarySource
    reportOrigin
    performerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name
    requester
    encounter
    manufacturerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
    location
    lotNumberClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
    expirationDate
    siteClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
    routeClinicalDocument/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)

ImmunizationVXU_V04
    identifier
    status
    dateRXA-3
    vaccineCodeRXA-5
    patientPID-3
    wasNotGiven
    primarySourceRXA-9
    reportOriginRXA-9
    performerRXA-10
    requesterORC-12
    encounterPV1-19
    manufacturerRXA-17
    locationRXA-27 (or RXA-11, deprecated as of v2.7)
    lotNumberRXA-15
    expirationDateRXA-16
    siteRXR-2
    routeRXR-1
    doseQuantityRXA-6 / RXA-7.1
    note
    explanation
        reason
        reasonNotGivenRXA-18
    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)
        detailOBX-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