FHIR Implementation Guide for NDHM CI Build v2.0
banner

NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.

Mappings for the StructureDefinition-ImmunizationRecommendation Profile.

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

ImmunizationRecommendation
ImmunizationRecommendationRequest
   identifierRequest.identifier
   patientRequest.subject
   dateRequest.authoredOn
   recommendation
      vaccineCodeRequest.code
      dateCriterionRequest.occurrence[x]
      supportingPatientInformationRequest.supportingInfo

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

ImmunizationRecommendation
ImmunizationRecommendationVXU_V04
   patientPID-3
   dateOBX-15
   authorityOBX-5 : OBX-3 = 59779-9
   recommendation
      vaccineCodeOBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      targetDiseaseOBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      contraindicatedVaccineCode
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      forecastStatusOBX-5 : OBX-3 = 59783-1
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      forecastReasonOBX-5 : OBX-3 = 30982-3
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      dateCriterionOBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue
         codeOBX-3
            codingC*E.1-8, C*E.10-22
               systemC*E.3
               versionC*E.7
               codeC*E.1
               displayC*E.2 - but note this is not well followed
               userSelectedSometimes implied by being first
            textC*E.9. But note many systems use C*E.2 for this
         valueOBX-5
      descriptionOBX-5 : OBX-3 = 30956-7
      seriesRXA-5-administered code
      doseNumber[x]OBX-5 : OBX-3 = 30973-2
      seriesDoses[x]OBX-5 : OBX-3 = 59782-3
      supportingImmunization? No clear way to associate in HL7 v2 or IG
      supportingPatientInformationOBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX'), could contain the reason the vaccine was not administered

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

ImmunizationRecommendation
ImmunizationRecommendationEntity. Role, or Act, SubstanceAdministration[moodCode=RMD]
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   patient.partipication[typeCode=SUBJ].role
   date.partipication[typeCode=AUTH].time
   authority.participation[typeCode=AUT]
   recommendation.outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]
      idn/a
      extensionn/a
      modifierExtensionN/A
      vaccineCode.partipication[typeCode=CSM].role[classCode=ADMM].code
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      targetDisease.partipication[typeCode=CSM].role[classCode=ADMM].code
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      contraindicatedVaccineCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      forecastStatus.inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code="Immunization Forecast Status"].value
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      forecastReasonN/A
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      dateCriterion.outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]
         idn/a
         extensionn/a
         modifierExtensionN/A
         code.code
            idn/a
            extensionn/a
            codingunion(., ./translation)
               idn/a
               extensionn/a
               system./codeSystem
               version./codeSystemVersion
               code./code
               displayCV.displayName
               userSelectedCD.codingRationale
            text./originalText[mediaType/code="text/plain"]/data
         value.value
      description.text
      series.title
      doseNumber[x].inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber
      seriesDoses[x].inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber
      supportingImmunization.outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code="immunization"]
      supportingPatientInformation.outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

ImmunizationRecommendation
ImmunizationRecommendation
   identifierFiveWs.identifier
   patientFiveWs.subject[x], FiveWs.subject