Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

ConceptMap: R3ImmunizationElementMapToR4B

Official URL: http://hl7.org/fhir/uv/xver/ConceptMap/R3-Immunization-element-map-to-R4B Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: R3ImmunizationElementMapToR4B

This ConceptMap represents cross-version mappings for elements from a FHIR STU3 Immunization to FHIR R4B.

Mapping from http://hl7.org/fhir/3.0 to http://hl7.org/fhir/4.3


Group 1 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to Immunizationversion: 4.3.0)

Source Concept DetailsRelationshipTarget Concept DetailsComment
Codes from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2Codes from Immunization
Immunization.metametamaps to wider conceptImmunization.metaImmunization.metaElement `Immunization.meta` is mapped to FHIR R4B element `Immunization.meta` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.meta` do not cover the following types: Meta. The mappings for `Immunization.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.
Immunization.implicitRulesimplicitRulesis equivalent toImmunization.implicitRulesImmunization.implicitRulesElement `Immunization.implicitRules` is mapped to FHIR R4B element `Immunization.implicitRules` as `Equivalent`. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Immunization.languagelanguageis equivalent toImmunization.languageImmunization.languageElement `Immunization.language` is mapped to FHIR R4B element `Immunization.language` as `Equivalent`. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Immunization.texttextmaps to wider conceptImmunization.textImmunization.textElement `Immunization.text` is mapped to FHIR R4B element `Immunization.text` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.text` do not cover the following types: Narrative. The mappings for `Immunization.text` do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Immunization.containedcontainedis equivalent toImmunization.containedImmunization.containedElement `Immunization.contained` is mapped to FHIR R4B element `Immunization.contained` as `SourceIsBroaderThanTarget`. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Immunization.identifieridentifiermaps to wider conceptImmunization.identifierImmunization.identifierElement `Immunization.identifier` is mapped to FHIR R4B element `Immunization.identifier` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.identifier` do not cover the following types: Identifier. The mappings for `Immunization.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.
Immunization.statusstatusis equivalent toImmunization.statusImmunization.statusElement `Immunization.status` is mapped to FHIR R4B element `Immunization.status` as `SourceIsNarrowerThanTarget`. The mappings for `Immunization.status` do not allow expression of the necessary codes, per the bindings on the source and target. Will generally be set to show that the immunization has been completed. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Immunization.notGivennotGivenis related toImmunization.statusImmunization.statusElement `Immunization.notGiven` is mapped to FHIR R4B element `Immunization.status` as `SourceIsBroaderThanTarget`. Element `Immunization.notGiven` is mapped to FHIR R4B element `Immunization.statusReason` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.notGiven` do not cover the following types: boolean. The mappings for `Immunization.notGiven` do not cover the following types based on type expansion: value. This element is labeled as a modifier because it indicates that an immunization didn't happen.
is related toImmunization.statusReasonImmunization.statusReasonElement `Immunization.notGiven` is mapped to FHIR R4B element `Immunization.status` as `SourceIsBroaderThanTarget`. Element `Immunization.notGiven` is mapped to FHIR R4B element `Immunization.statusReason` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.notGiven` do not cover the following types: boolean. The mappings for `Immunization.notGiven` do not cover the following types based on type expansion: value. This element is labeled as a modifier because it indicates that an immunization didn't happen.
Immunization.vaccineCodevaccineCodeis equivalent toImmunization.vaccineCodeImmunization.vaccineCodeElement `Immunization.vaccineCode` is mapped to FHIR R4B element `Immunization.vaccineCode` as `Equivalent`.
Immunization.patientpatientmaps to wider conceptImmunization.patientImmunization.patientElement `Immunization.patient` is mapped to FHIR R4B element `Immunization.patient` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.patient` do not cover the following types based on type expansion: display, identifier, reference. The standard extension `alternate-reference` has been mapped as the representation of FHIR STU3 element `Immunization.patient` with unmapped reference targets: Patient.
Immunization.encounterencountermaps to wider conceptImmunization.encounterImmunization.encounterElement `Immunization.encounter` is mapped to FHIR R4B element `Immunization.encounter` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.encounter` do not cover the following types based on type expansion: display, identifier, reference. The standard extension `alternate-reference` has been mapped as the representation of FHIR STU3 element `Immunization.encounter` with unmapped reference targets: Encounter.
Immunization.datedateis equivalent toImmunization.occurrence[x]Immunization.occurrence[x]Element `Immunization.date` is mapped to FHIR R4B element `Immunization.occurrence[x]` as `Equivalent`. The target context `Immunization.occurrence[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Immunization`. When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known.  Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given.
Immunization.primarySourceprimarySourceis equivalent toImmunization.primarySourceImmunization.primarySourceElement `Immunization.primarySource` is mapped to FHIR R4B element `Immunization.primarySource` as `Equivalent`. Reflects the “reliability” of the content.
Immunization.reportOriginreportOriginis equivalent toImmunization.reportOriginImmunization.reportOriginElement `Immunization.reportOrigin` is mapped to FHIR R4B element `Immunization.reportOrigin` as `Equivalent`. Should not be populated if primarySource = True, will not be required even if primarySource = False.
Immunization.locationlocationmaps to wider conceptImmunization.locationImmunization.locationElement `Immunization.location` is mapped to FHIR R4B element `Immunization.location` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.location` do not cover the following types based on type expansion: display, identifier, reference. The standard extension `alternate-reference` has been mapped as the representation of FHIR STU3 element `Immunization.location` with unmapped reference targets: Location.
Immunization.manufacturermanufacturermaps to wider conceptImmunization.manufacturerImmunization.manufacturerElement `Immunization.manufacturer` is mapped to FHIR R4B element `Immunization.manufacturer` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.manufacturer` do not cover the following types based on type expansion: display, identifier, reference. The standard extension `alternate-reference` has been mapped as the representation of FHIR STU3 element `Immunization.manufacturer` with unmapped reference targets: Organization.
Immunization.lotNumberlotNumberis equivalent toImmunization.lotNumberImmunization.lotNumberElement `Immunization.lotNumber` is mapped to FHIR R4B element `Immunization.lotNumber` as `Equivalent`.
Immunization.expirationDateexpirationDateis equivalent toImmunization.expirationDateImmunization.expirationDateElement `Immunization.expirationDate` is mapped to FHIR R4B element `Immunization.expirationDate` as `Equivalent`.
Immunization.sitesiteis equivalent toImmunization.siteImmunization.siteElement `Immunization.site` is mapped to FHIR R4B element `Immunization.site` as `Equivalent`.
Immunization.routerouteis equivalent toImmunization.routeImmunization.routeElement `Immunization.route` is mapped to FHIR R4B element `Immunization.route` as `Equivalent`.
Immunization.doseQuantitydoseQuantityis equivalent toImmunization.doseQuantityImmunization.doseQuantityElement `Immunization.doseQuantity` is mapped to FHIR R4B element `Immunization.doseQuantity` as `Equivalent`.
Immunization.practitionerpractitionermaps to wider conceptImmunization.performerImmunization.performerElement `Immunization.practitioner` is mapped to FHIR R4B element `Immunization.performer` as `Equivalent`.
Immunization.practitioner.roleroleis equivalent toImmunization.performer.functionImmunization.performer.functionElement `Immunization.practitioner.role` is mapped to FHIR R4B element `Immunization.performer.function` as `Equivalent`.
Immunization.practitioner.actoractormaps to wider conceptImmunization.performer.actorImmunization.performer.actorElement `Immunization.practitioner.actor` is mapped to FHIR R4B element `Immunization.performer.actor` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.practitioner.actor` do not cover the following types based on type expansion: display, identifier, reference. The standard extension `alternate-reference` has been mapped as the representation of FHIR STU3 element `Immunization.practitioner.actor` with unmapped reference targets: Practitioner.
Immunization.notenotemaps to wider conceptImmunization.noteImmunization.noteElement `Immunization.note` is mapped to FHIR R4B element `Immunization.note` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.note` do not cover the following types: Annotation. The mappings for `Immunization.note` do not cover the following types based on type expansion: author[x], text, time.
Immunization.explanationexplanationis related toImmunizationImmunizationElement `Immunization.explanation` is mapped to FHIR R4B element `Immunization` as `SourceIsNarrowerThanTarget`.
Immunization.explanation.reasonreasonnarrowerImmunization.reasonCodeImmunization.reasonCodeElement `Immunization.explanation.reason` is mapped to FHIR R4B element `Immunization.reasonCode` as `SourceIsNarrowerThanTarget`.
Immunization.explanation.reasonNotGivenreasonNotGivennarrowerImmunization.reasonCodeImmunization.reasonCodeElement `Immunization.explanation.reasonNotGiven` is mapped to FHIR R4B element `Immunization.reasonCode` as `SourceIsNarrowerThanTarget`.
Immunization.reactionreactionmaps to wider conceptImmunization.reactionImmunization.reactionElement `Immunization.reaction` is mapped to FHIR R4B element `Immunization.reaction` as `Equivalent`. A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new [AllergyIntolerance](https://hl7.org/fhir/allergyintolerance.html) resource instance as most systems will not query against past Immunization.reaction elements.
Immunization.reaction.datedateis equivalent toImmunization.reaction.dateImmunization.reaction.dateElement `Immunization.reaction.date` is mapped to FHIR R4B element `Immunization.reaction.date` as `Equivalent`.
Immunization.reaction.detaildetailmaps to wider conceptImmunization.reaction.detailImmunization.reaction.detailElement `Immunization.reaction.detail` is mapped to FHIR R4B element `Immunization.reaction.detail` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.reaction.detail` do not cover the following types based on type expansion: display, identifier, reference. The standard extension `alternate-reference` has been mapped as the representation of FHIR STU3 element `Immunization.reaction.detail` with unmapped reference targets: Observation.
Immunization.reaction.reportedreportedis equivalent toImmunization.reaction.reportedImmunization.reaction.reportedElement `Immunization.reaction.reported` is mapped to FHIR R4B element `Immunization.reaction.reported` as `Equivalent`.
Immunization.vaccinationProtocolvaccinationProtocolmaps to wider conceptImmunization.protocolAppliedImmunization.protocolAppliedElement `Immunization.vaccinationProtocol` is mapped to FHIR R4B element `Immunization.protocolApplied` as `Equivalent`.
Immunization.vaccinationProtocol.doseSequencedoseSequenceis equivalent toImmunization.protocolApplied.doseNumber[x]Immunization.protocolApplied.doseNumber[x]Element `Immunization.vaccinationProtocol.doseSequence` is mapped to FHIR R4B element `Immunization.protocolApplied.doseNumber[x]` as `Equivalent`. The target context `Immunization.protocolApplied.doseNumber[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Immunization.protocolApplied`.
Immunization.vaccinationProtocol.authorityauthoritymaps to wider conceptImmunization.protocolApplied.authorityImmunization.protocolApplied.authorityElement `Immunization.vaccinationProtocol.authority` is mapped to FHIR R4B element `Immunization.protocolApplied.authority` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.vaccinationProtocol.authority` do not cover the following types based on type expansion: display, identifier, reference. The standard extension `alternate-reference` has been mapped as the representation of FHIR STU3 element `Immunization.vaccinationProtocol.authority` with unmapped reference targets: Organization.
Immunization.vaccinationProtocol.seriesseriesis equivalent toImmunization.protocolApplied.seriesImmunization.protocolApplied.seriesElement `Immunization.vaccinationProtocol.series` is mapped to FHIR R4B element `Immunization.protocolApplied.series` as `Equivalent`.
Immunization.vaccinationProtocol.seriesDosesseriesDosesis equivalent toImmunization.protocolApplied.seriesDoses[x]Immunization.protocolApplied.seriesDoses[x]Element `Immunization.vaccinationProtocol.seriesDoses` is mapped to FHIR R4B element `Immunization.protocolApplied.seriesDoses[x]` as `Equivalent`. The target context `Immunization.protocolApplied.seriesDoses[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Immunization.protocolApplied`.
Immunization.vaccinationProtocol.targetDiseasetargetDiseaseis equivalent toImmunization.protocolApplied.targetDiseaseImmunization.protocolApplied.targetDiseaseElement `Immunization.vaccinationProtocol.targetDisease` is mapped to FHIR R4B element `Immunization.protocolApplied.targetDisease` as `Equivalent`.

Group 2 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: meta additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.meta (meta)is equivalent toExtension (STU3: meta additional types)Element `Immunization.meta` is mapped to FHIR R4B element `Immunization.meta` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.meta` do not cover the following types: Meta. The mappings for `Immunization.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

Group 3 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: text additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.text (text)is equivalent toExtension (STU3: text additional types)Element `Immunization.text` is mapped to FHIR R4B element `Immunization.text` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.text` do not cover the following types: Narrative. The mappings for `Immunization.text` do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Group 4 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: identifier additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.identifier (identifier)is equivalent toExtension (STU3: identifier additional types)Element `Immunization.identifier` is mapped to FHIR R4B element `Immunization.identifier` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.identifier` do not cover the following types: Identifier. The mappings for `Immunization.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.

Group 5 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: Flag for whether immunization was given additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.notGiven (notGiven)maps to wider conceptExtension (STU3: Flag for whether immunization was given additional types)Element `Immunization.notGiven` is mapped to FHIR R4B element `Immunization.status` as `SourceIsBroaderThanTarget`. Element `Immunization.notGiven` is mapped to FHIR R4B element `Immunization.statusReason` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.notGiven` do not cover the following types: boolean. The mappings for `Immunization.notGiven` do not cover the following types based on type expansion: value. This element is labeled as a modifier because it indicates that an immunization didn't happen.

Group 6 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: Vaccination notes additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.note (note)is equivalent toExtension (STU3: Vaccination notes additional types)Element `Immunization.note` is mapped to FHIR R4B element `Immunization.note` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.note` do not cover the following types: Annotation. The mappings for `Immunization.note` do not cover the following types based on type expansion: author[x], text, time.

Group 7 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: Details of vaccine protocol (new)version: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.vaccinationProtocol.description (description)is equivalent toExtension (STU3: Details of vaccine protocol (new))Element `Immunization.vaccinationProtocol.description` has a context of Immunization.protocolApplied based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.vaccinationProtocol.description` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Group 8 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: Indicates if dose counts towards immunity (new)version: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.vaccinationProtocol.doseStatus (doseStatus)is equivalent toExtension (STU3: Indicates if dose counts towards immunity (new))Element `Immunization.vaccinationProtocol.doseStatus` has a context of Immunization.protocolApplied based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.vaccinationProtocol.doseStatus` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). May need to differentiate between status declarations by a provider vs. a CDS engine.

Group 9 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|3.0.2 to STU3: Why dose does (not) count (new)version: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.vaccinationProtocol.doseStatusReason (doseStatusReason)is equivalent toExtension (STU3: Why dose does (not) count (new))Element `Immunization.vaccinationProtocol.doseStatusReason` has a context of Immunization.protocolApplied based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.vaccinationProtocol.doseStatusReason` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).