Mappings for the IMMZ.Immunization resource profile.
| Name | Workflow Pattern | HL7 v2 Mapping | RIM Mapping | FiveWs Pattern Mapping | CDA (R2) |
 Immunization |
Event |
VXU_V04 |
SubstanceAdministration |
|
|
  Immunization / id |
|
|
|
|
|
  Immunization / meta |
|
|
|
|
|
  Immunization / implicitRules |
|
|
|
|
|
  Immunization / language |
|
|
|
|
|
  Immunization / text |
|
|
Act.text? |
|
|
  Immunization / contained |
|
|
N/A |
|
|
  Immunization / Slices for extension |
|
|
|
|
|
   Immunization / Slices for extension / extension:typeOfPolio |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfPolio / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfPolio / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfPolio / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfPolio / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:typeOfJe |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfJe / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfJe / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfJe / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfJe / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:typeOfTbe |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfTbe / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfTbe / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfTbe / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfTbe / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:typeOfTyphoid |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfTyphoid / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfTyphoid / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfTyphoid / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfTyphoid / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:typeOfCholera |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfCholera / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfCholera / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfCholera / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfCholera / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:typeOfMeningococcal |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfMeningococcal / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfMeningococcal / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfMeningococcal / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfMeningococcal / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:typeOfHepatitisA |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisA / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisA / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisA / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisA / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:typeOfHepatitisB |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisB / id |
|
|
n/a |
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisB / extension |
|
|
|
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisB / url |
|
|
N/A |
|
|
    Immunization / Slices for extension / extension:typeOfHepatitisB / value[x] |
|
|
N/A |
|
|
   Immunization / Slices for extension / extension:vaccineBrand |
|
|
|
|
|
   Immunization / Slices for extension / extension:liveVaccine |
|
|
|
|
|
   Immunization / Slices for extension / extension:marketAuthorizationHolder |
|
|
|
|
|
  Immunization / modifierExtension |
|
|
N/A |
|
|
  Immunization / identifier |
Event.identifier |
|
.id |
FiveWs.identifier |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id |
  Immunization / status |
Event.status |
|
statusCode |
FiveWs.status |
|
  Immunization / statusReason |
Event.statusReason |
|
- .inboundRelationship[typeCode=SUBJ].source[classCode=CACT
- moodCode=EVN].reasonCOde
|
|
|
  Immunization / vaccineCode |
Event.code |
RXA-5 |
.code |
FiveWs.what[x] |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code |
  Immunization / patient |
Event.subject |
PID-3 |
.partipication[ttypeCode=].role |
FiveWs.subject |
|
  Immunization / encounter |
Event.context |
PV1-19 |
component->EncounterEvent |
FiveWs.context |
|
  Immunization / occurrence[x] |
Event.occurrence[x] |
RXA-3 |
.effectiveTime |
FiveWs.done[x] |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value |
  Immunization / recorded |
|
|
.participation[typeCode=AUT].time |
FiveWs.recorded |
|
  Immunization / primarySource |
|
RXA-9 |
- immunization.uncertaintycode (if primary source=false
- uncertainty=U)
|
FiveWs.source |
|
  Immunization / reportOrigin |
|
RXA-9 |
.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) |
FiveWs.source |
|
  Immunization / location |
Event.location |
- RXA-27 (or RXA-11
- deprecated as of v2.7)
|
.participation[typeCode=LOC].COCT_MT240000UV |
FiveWs.where[x] |
|
   Immunization / location / id |
|
|
n/a |
|
|
   Immunization / location / Slices for extension |
|
|
|
|
|
    Immunization / location / Slices for extension / extension:countryOfVaccination |
|
|
|
|
|
    Immunization / location / Slices for extension / extension:administrativeArea |
|
|
|
|
|
   Immunization / location / reference |
|
|
N/A |
|
|
   Immunization / location / type |
|
|
N/A |
|
|
   Immunization / location / identifier |
|
|
.identifier |
|
|
   Immunization / location / display |
|
|
N/A |
|
|
  Immunization / manufacturer |
|
RXA-17 |
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG] |
|
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name |
  Immunization / lotNumber |
|
RXA-15 |
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id |
|
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText |
  Immunization / expirationDate |
|
RXA-16 |
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime |
|
|
  Immunization / site |
|
RXR-2 |
observation.targetSiteCode |
|
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code |
  Immunization / route |
|
RXR-1 |
.routeCode |
|
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code |
  Immunization / doseQuantity |
|
RXA-6 / RXA-7 |
.doseQuantity |
|
|
  Immunization / performer |
Event.performer |
ORC-12 / RXA-10 |
.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE] |
|
|
   Immunization / performer / id |
|
|
n/a |
|
|
   Immunization / performer / extension |
|
|
n/a |
|
|
   Immunization / performer / modifierExtension |
|
|
N/A |
|
|
   Immunization / performer / function |
Event.performer.function |
|
.participation.functionCode |
|
|
   Immunization / performer / actor |
Event.performer.actor |
|
.player |
FiveWs.actor |
|
  Immunization / note |
Event.note |
OBX-3 = 48767-8 |
note |
|
|
  Immunization / reasonCode |
Event.reasonCode |
|
[actionNegationInd=false].reasonCode |
|
|
  Immunization / reasonReference |
Event.reasonReference |
|
N/A |
|
|
  Immunization / isSubpotent |
|
RXA-20 = PA (partial administration) |
N/A |
|
|
  Immunization / subpotentReason |
|
|
N/A |
|
|
  Immunization / education |
|
|
N/A |
|
|
   Immunization / education / id |
|
|
n/a |
|
|
   Immunization / education / extension |
|
|
n/a |
|
|
   Immunization / education / modifierExtension |
|
|
N/A |
|
|
   Immunization / education / documentType |
|
OBX-3 = 69764-9 |
N/A |
|
|
   Immunization / education / reference |
|
|
N/A |
|
|
   Immunization / education / publicationDate |
|
OBX-3 = 29768-9 |
N/A |
|
|
   Immunization / education / presentationDate |
|
OBX-3 = 29769-7 |
N/A |
|
|
  Immunization / programEligibility |
|
OBX-3 = 64994-7 |
N/A |
|
|
  Immunization / fundingSource |
|
|
N/A |
|
|
  Immunization / reaction |
|
OBX-3 |
Observation[classCode=obs].code |
|
|
   Immunization / reaction / id |
|
|
n/a |
|
|
   Immunization / reaction / extension |
|
|
n/a |
|
|
   Immunization / reaction / modifierExtension |
|
|
N/A |
|
|
   Immunization / reaction / 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)
|
.effectiveTime |
|
|
   Immunization / reaction / detail |
|
OBX-5 |
.value |
|
|
   Immunization / reaction / reported |
|
(HL7 v2 doesn't seem to provide for this) |
.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true) |
|
|
  Immunization / Slices for protocolApplied |
|
|
N/A |
|
|
   Immunization / Slices for protocolApplied / protocolApplied:All Slices |
|
|
|
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / id |
|
|
n/a |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / extension |
|
|
n/a |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / modifierExtension |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / series |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / authority |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / targetDisease |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / doseNumber[x] |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:All Slices / seriesDoses[x] |
|
|
N/A |
|
|
   Immunization / Slices for protocolApplied / protocolApplied:immzProtocol |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / id |
|
|
n/a |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / Slices for extension |
|
|
|
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / Slices for extension |
|
|
|
|
|
     Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / Slices for extension / extension:dueDateOfNextDose |
|
|
|
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / modifierExtension |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / series |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / authority |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / targetDisease |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / doseNumber[x] |
|
|
N/A |
|
|
    Immunization / Slices for protocolApplied / protocolApplied:immzProtocol / seriesDoses[x] |
|
|
N/A |
|
|
Documentation for this format |