International Patient Summary Implementation Guide
1.1.0 - STU 1 Update 1 International flag

This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ImmunizationUvIps - Mappings

Page standards status: Trial-use Maturity Level: 2

Mappings for the Immunization-uv-ips resource profile.

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

ImmunizationUvIps
ImmunizationEvent
   identifierEvent.identifier
   statusEvent.status
   statusReasonEvent.statusReason
   patientEvent.subject
   encounterEvent.context
   occurrence[x]Event.occurrence[x]
   locationEvent.location
   performerEvent.performer
      functionEvent.performer.function
      actorEvent.performer.actor
   noteEvent.note
   reasonCodeEvent.reasonCode
   reasonReferenceEvent.reasonReference

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

ImmunizationUvIps
ImmunizationVXU_V04
   vaccineCodeCE/CNE/CWE
   patientPID-3
   encounterPV1-19
   occurrence[x]RXA-3
   primarySourceRXA-9
   reportOriginRXA-9
   locationRXA-27 (or RXA-11, deprecated as of v2.7)
   manufacturerRXA-17
   lotNumberRXA-15
   expirationDateRXA-16
   siteCE/CNE/CWE
   routeCE/CNE/CWE
   doseQuantityRXA-6 / RXA-7
   performerORC-12 / RXA-10
   noteOBX-5 : OBX-3 = 48767-8
   isSubpotentRXA-20 = PA (partial administration)
   education
      documentTypeOBX-5 : OBX-3 = 69764-9
      publicationDateOBX-5 : OBX-3 = 29768-9
      presentationDateOBX-5 : OBX-3 = 29769-7
   programEligibilityOBX-5 : OBX-3 = 64994-7
   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(HL7 v2 doesn't seem to provide for this)

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

ImmunizationUvIps
ImmunizationEntity. Role, or Act, SubstanceAdministration
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   statusstatusCode
   statusReason.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
   vaccineCoden/a, CD
   patient.partipication[ttypeCode=].role
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
      displayN/A
   encountercomponent->EncounterEvent
   occurrence[x].effectiveTime
      idn/a
      extensionn/a
      extension (data-absent-reason)ANY.nullFlavor
   recorded.participation[typeCode=AUT].time
   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)
   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
   siten/a, CD
   routen/a, CD
   doseQuantity.doseQuantity
   performer.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      function.participation.functionCode
      actor.player
   notenote
   reasonCode[actionNegationInd=false].reasonCode
   reasonReferenceN/A
   isSubpotentN/A
   subpotentReasonN/A
   educationN/A
      idn/a
      extensionn/a
      modifierExtensionN/A
      documentTypeN/A
      referenceN/A
      publicationDateN/A
      presentationDateN/A
   programEligibilityN/A
   fundingSourceN/A
   reactionObservation[classCode=obs].code
      idn/a
      extensionn/a
      modifierExtensionN/A
      date.effectiveTime
      detail.value
      reported.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
   protocolAppliedN/A
      idn/a
      extensionn/a
      modifierExtensionN/A
      seriesN/A
      authorityN/A
      targetDiseaseN/A
      doseNumber[x]N/A
      seriesDoses[x]N/A

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

ImmunizationUvIps
Immunization
   identifierFiveWs.identifier
   statusFiveWs.status
   patientFiveWs.subject[x], FiveWs.subject
   encounterFiveWs.context
   occurrence[x]FiveWs.done[x]
   recordedFiveWs.recorded
   primarySourceFiveWs.source
   reportOriginFiveWs.source
   locationFiveWs.where[x]
   performer
      actorFiveWs.actor

Mappings for CDA (R2) (http://hl7.org/v3/cda)

ImmunizationUvIps
Immunization
   identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
   occurrence[x]ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
   manufacturerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
   lotNumberClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText