Australian Base Implementation Guide (AU Base 1.1.1)

This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: AUBaseImmunisation - Mappings

Mappings for the StructureDefinition-au-immunization Profile.

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

AUBaseImmunisation
ImmunizationVXU_V04
   vaccineCodeRXA-5
      codingC*E.1-8, C*E.10-22
      coding (amtVaccineCode)C*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
      coding (airVaccineCode)C*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
   patientPID-3
   encounterPV1-19
   dateRXA-3
   primarySourceRXA-9
   reportOriginRXA-9
   locationRXA-27 (or RXA-11, deprecated as of v2.7)
   manufacturerRXA-17
   lotNumberRXA-15
   expirationDateRXA-16
   siteRXR-2
      codingC*E.1-8, C*E.10-22
      textC*E.9. But note many systems use C*E.2 for this
   routeRXR-1
      codingC*E.1-8, C*E.10-22
      coding (snomedRoute)C*E.1-8, C*E.10-22
      textC*E.9. But note many systems use C*E.2 for this
   doseQuantityRXA-6 / RXA-7.1
   practitionerORC-12 / RXA-10
      role
   practitioner (administeredBy)ORC-12 / RXA-10
      role
         codingC*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this
   practitioner (approvedBy)ORC-12 / RXA-10
      role
         codingC*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this
   practitioner (witnessedBy)ORC-12 / RXA-10
      role
         codingC*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this
   explanation
      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)
      targetDisease
         codingC*E.1-8, C*E.10-22
         coding (snomedTargetDisease)C*E.1-8, C*E.10-22
         coding (targetDiseaseNoInformation)C*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this
      doseStatus
         codingC*E.1-8, C*E.10-22
         coding (doseStatusNotAvailable)C*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this

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

AUBaseImmunisation
ImmunizationEntity. Role, or Act, SubstanceAdministration
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   statusstatusCode
   notGiven[actionNegationInd=true].reasonCode
   vaccineCode.code
      idn/a
      extensionn/a
      codingunion(., ./translation)
      coding (amtVaccineCode)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (airVaccineCode)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   patient.partipication[ttypeCode=].role
   encountercomponent->EncounterEvent
   date.effectiveTime
   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
   siteobservation.targetSiteCode
      idn/a
      extensionn/a
      codingunion(., ./translation)
      text./originalText[mediaType/code="text/plain"]/data
   route.routeCode
      idn/a
      extensionn/a
      codingunion(., ./translation)
      coding (snomedRoute)union(., ./translation)
      text./originalText[mediaType/code="text/plain"]/data
   doseQuantity.doseQuantity
   practitioner.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      role.participation.functionCode
      actor.player
   practitioner (administeredBy).participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      role.participation.functionCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
      actor.player
   practitioner (approvedBy).participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      role.participation.functionCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
      actor.player
   practitioner (witnessedBy).participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      role.participation.functionCode
         idn/a
         extensionn/a
         codingunion(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
      actor.player
   notenote
   explanationn/a
      idn/a
      extensionn/a
      modifierExtensionN/A
      reason[actionNegationInd=false].reasonCode
      reasonNotGiven[actionNegationInd=true].reasonCode
   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)
   vaccinationProtocoloutboundRelationship[typeCode=INST].target[classCode=SBADM]
      idn/a
      extensionn/a
      modifierExtensionN/A
      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
         idn/a
         extensionn/a
         codingunion(., ./translation)
         coding (snomedTargetDisease)union(., ./translation)
         coding (targetDiseaseNoInformation)union(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
      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
         idn/a
         extensionn/a
         codingunion(., ./translation)
         coding (doseStatusNotAvailable)union(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
      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

Mappings for W5 Mapping (http://hl7.org/fhir/w5)

AUBaseImmunisation
Immunizationclinical.medication
   identifierid
   statusstatus
   notGivenstatus
   vaccineCodewhat
   patientwho.focus
   encountercontext
   datewhen.init
   primarySourcewho.source
   reportOriginwho.source
   locationwhere
   practitioner
      actorwho.actor
   practitioner (administeredBy)
      actorwho.actor
   practitioner (approvedBy)
      actorwho.actor
   practitioner (witnessedBy)
      actorwho.actor

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

AUBaseImmunisation
Immunization
   identifierEvent.identifier
   statusEvent.status
   notGivenEvent.notDone
   vaccineCodeEvent.code
   patientEvent.subject
   encounterEvent.context
   dateEvent.occurrence.occurrenceDateTime
   practitionerEvent.performer
      roleEvent.performer.role
      actorEvent.performer.actor
   practitioner (administeredBy)Event.performer
      roleEvent.performer.role
      actorEvent.performer.actor
   practitioner (approvedBy)Event.performer
      roleEvent.performer.role
      actorEvent.performer.actor
   practitioner (witnessedBy)Event.performer
      roleEvent.performer.role
      actorEvent.performer.actor
   noteEvent.note
   explanation
      reasonEvent.reasonCodeableConcept
      reasonNotGivenEvent.notDoneReason

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

AUBaseImmunisation
Immunization
   identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
   vaccineCodeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
   dateClinicalDocument/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
   siteClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
   routeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code