Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU International flag

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

ConceptMap: R4ImmunizationElementMapToR5

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

This ConceptMap represents cross-version mappings for elements from a FHIR R4 Immunization to FHIR R5.

Mapping from http://hl7.org/fhir/4.0 to http://hl7.org/fhir/5.0


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

Source CodeRelationshipTarget CodeComment
Immunization.meta (meta)is equivalent toImmunization.metaElement `Immunization.meta` is mapped to FHIR R5 element `Immunization.meta` as `Equivalent`.
Immunization.implicitRules (implicitRules)is equivalent toImmunization.implicitRulesElement `Immunization.implicitRules` is mapped to FHIR R5 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Immunization.language (language)is equivalent toImmunization.languageElement `Immunization.language` is mapped to FHIR R5 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.text (text)is equivalent toImmunization.textElement `Immunization.text` is mapped to FHIR R5 element `Immunization.text` as `Equivalent`. 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 information is added later.
Immunization.contained (contained)is equivalent toImmunization.containedElement `Immunization.contained` is mapped to FHIR R5 element `Immunization.contained` as `Equivalent`. 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Immunization.identifier (identifier)is equivalent toImmunization.identifierElement `Immunization.identifier` is mapped to FHIR R5 element `Immunization.identifier` as `Equivalent`.
Immunization.status (status)is equivalent toImmunization.statusElement `Immunization.status` is mapped to FHIR R5 element `Immunization.status` as `Equivalent`. Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Immunization.statusReason (statusReason)is equivalent toImmunization.statusReasonElement `Immunization.statusReason` is mapped to FHIR R5 element `Immunization.statusReason` as `Equivalent`. This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.
Immunization.vaccineCode (vaccineCode)is equivalent toImmunization.vaccineCodeElement `Immunization.vaccineCode` is mapped to FHIR R5 element `Immunization.vaccineCode` as `Equivalent`.
Immunization.patient (patient)is equivalent toImmunization.patientElement `Immunization.patient` is mapped to FHIR R5 element `Immunization.patient` as `Equivalent`.
Immunization.encounter (encounter)is equivalent toImmunization.encounterElement `Immunization.encounter` is mapped to FHIR R5 element `Immunization.encounter` as `Equivalent`.
Immunization.occurrence[x] (occurrence[x])is equivalent toImmunization.occurrence[x]Element `Immunization.occurrence[x]` is mapped to FHIR R5 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. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.
Immunization.primarySource (primarySource)is equivalent toImmunization.primarySourceElement `Immunization.primarySource` is mapped to FHIR R5 element `Immunization.primarySource` as `Equivalent`. Reflects the “reliability” of the content.
Immunization.location (location)is equivalent toImmunization.locationElement `Immunization.location` is mapped to FHIR R5 element `Immunization.location` as `Equivalent`.
Immunization.manufacturer (manufacturer)is equivalent toImmunization.manufacturerElement `Immunization.manufacturer` is mapped to FHIR R5 element `Immunization.manufacturer` as `SourceIsNarrowerThanTarget`.
Immunization.lotNumber (lotNumber)is equivalent toImmunization.lotNumberElement `Immunization.lotNumber` is mapped to FHIR R5 element `Immunization.lotNumber` as `Equivalent`.
Immunization.expirationDate (expirationDate)is equivalent toImmunization.expirationDateElement `Immunization.expirationDate` is mapped to FHIR R5 element `Immunization.expirationDate` as `Equivalent`.
Immunization.site (site)is equivalent toImmunization.siteElement `Immunization.site` is mapped to FHIR R5 element `Immunization.site` as `Equivalent`.
Immunization.route (route)is equivalent toImmunization.routeElement `Immunization.route` is mapped to FHIR R5 element `Immunization.route` as `Equivalent`.
Immunization.doseQuantity (doseQuantity)is equivalent toImmunization.doseQuantityElement `Immunization.doseQuantity` is mapped to FHIR R5 element `Immunization.doseQuantity` as `Equivalent`.
Immunization.performer (performer)is broader thanImmunization.performerElement `Immunization.performer` is mapped to FHIR R5 element `Immunization.performer` as `Equivalent`.
Immunization.performer.function (function)is equivalent toImmunization.performer.functionElement `Immunization.performer.function` is mapped to FHIR R5 element `Immunization.performer.function` as `Equivalent`.
Immunization.performer.actor (actor)is equivalent toImmunization.performer.actorElement `Immunization.performer.actor` is mapped to FHIR R5 element `Immunization.performer.actor` as `Equivalent`. When the individual practitioner who performed the action is known, it is best to send.
Immunization.note (note)is equivalent toImmunization.noteElement `Immunization.note` is mapped to FHIR R5 element `Immunization.note` as `Equivalent`.
Immunization.reasonCode (reasonCode)is narrower thanImmunization.reasonElement `Immunization.reasonCode` is mapped to FHIR R5 element `Immunization.reason` as `SourceIsNarrowerThanTarget`.
Immunization.reasonReference (reasonReference)is related toImmunization.reasonElement `Immunization.reasonReference` is mapped to FHIR R5 element `Immunization.reason` as `RelatedTo`. The mappings for `Immunization.reasonReference` do not cover the following types: Reference.
Immunization.isSubpotent (isSubpotent)is equivalent toImmunization.isSubpotentElement `Immunization.isSubpotent` is mapped to FHIR R5 element `Immunization.isSubpotent` as `Equivalent`. Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.
Immunization.subpotentReason (subpotentReason)is equivalent toImmunization.subpotentReasonElement `Immunization.subpotentReason` is mapped to FHIR R5 element `Immunization.subpotentReason` as `Equivalent`.
Immunization.programEligibility (programEligibility)is equivalent toImmunization.programEligibility.programElement `Immunization.programEligibility` is mapped to FHIR R5 element `Immunization.programEligibility.program` as `SourceIsBroaderThanTarget`.
Immunization.fundingSource (fundingSource)is equivalent toImmunization.fundingSourceElement `Immunization.fundingSource` is mapped to FHIR R5 element `Immunization.fundingSource` as `Equivalent`.
Immunization.reaction (reaction)is broader thanImmunization.reactionElement `Immunization.reaction` is mapped to FHIR R5 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 resource instance as most systems will not query against past Immunization.reaction elements.
Immunization.reaction.date (date)is equivalent toImmunization.reaction.dateElement `Immunization.reaction.date` is mapped to FHIR R5 element `Immunization.reaction.date` as `Equivalent`.
Immunization.reaction.detail (detail)is narrower thanImmunization.reaction.manifestationElement `Immunization.reaction.detail` is mapped to FHIR R5 element `Immunization.reaction.manifestation` as `SourceIsNarrowerThanTarget`.
Immunization.reaction.reported (reported)is equivalent toImmunization.reaction.reportedElement `Immunization.reaction.reported` is mapped to FHIR R5 element `Immunization.reaction.reported` as `Equivalent`.
Immunization.protocolApplied (protocolApplied)is broader thanImmunization.protocolAppliedElement `Immunization.protocolApplied` is mapped to FHIR R5 element `Immunization.protocolApplied` as `Equivalent`.
Immunization.protocolApplied.series (series)is equivalent toImmunization.protocolApplied.seriesElement `Immunization.protocolApplied.series` is mapped to FHIR R5 element `Immunization.protocolApplied.series` as `Equivalent`.
Immunization.protocolApplied.authority (authority)is equivalent toImmunization.protocolApplied.authorityElement `Immunization.protocolApplied.authority` is mapped to FHIR R5 element `Immunization.protocolApplied.authority` as `Equivalent`.
Immunization.protocolApplied.targetDisease (targetDisease)is equivalent toImmunization.protocolApplied.targetDiseaseElement `Immunization.protocolApplied.targetDisease` is mapped to FHIR R5 element `Immunization.protocolApplied.targetDisease` as `Equivalent`.
Immunization.protocolApplied.doseNumber[x] (doseNumber[x])is broader thanImmunization.protocolApplied.doseNumberElement `Immunization.protocolApplied.doseNumber[x]` is mapped to FHIR R5 element `Immunization.protocolApplied.doseNumber` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types: positiveInt. The mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types based on type expansion: value. The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).
Immunization.protocolApplied.seriesDoses[x] (seriesDoses[x])is broader thanImmunization.protocolApplied.seriesDosesElement `Immunization.protocolApplied.seriesDoses[x]` is mapped to FHIR R5 element `Immunization.protocolApplied.seriesDoses` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types: positiveInt. The mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types based on type expansion: value. The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Group 2 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: When the immunization was first captured in the subject's record (new)version: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.recorded (recorded)is equivalent toExtension (R4: When the immunization was first captured in the subject's record (new))Element `Immunization.recorded` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.recorded` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

Group 3 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Indicates the source of a secondarily reported record (new)version: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.reportOrigin (reportOrigin)is equivalent toExtension (R4: Indicates the source of a secondarily reported record (new))Element `Immunization.reportOrigin` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.reportOrigin` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Should not be populated if primarySource = True, not required even if primarySource = False.

Group 4 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: reasonReference additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.reasonReference (reasonReference)is broader thanExtension (R4: reasonReference additional types)Element `Immunization.reasonReference` is mapped to FHIR R5 element `Immunization.reason` as `RelatedTo`. The mappings for `Immunization.reasonReference` do not cover the following types: Reference.

Group 5 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Educational material presented to patient (new)version: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.education (education)is equivalent toExtension (R4: Educational material presented to patient (new))Element `Immunization.education` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Immunization.education.documentType (documentType)is equivalent toExtension.extension:documentType (R4: Educational material document identifier (new))Element `Immunization.education.documentType` is part of an existing definition because parent element `Immunization.education` requires a cross-version extension. Element `Immunization.education.documentType` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.documentType` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Immunization.education.reference (reference)is equivalent toExtension.extension:reference (R4: Educational material reference pointer (new))Element `Immunization.education.reference` is part of an existing definition because parent element `Immunization.education` requires a cross-version extension. Element `Immunization.education.reference` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.reference` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Immunization.education.publicationDate (publicationDate)is equivalent toExtension.extension:publicationDate (R4: Educational material publication date (new))Element `Immunization.education.publicationDate` is part of an existing definition because parent element `Immunization.education` requires a cross-version extension. Element `Immunization.education.publicationDate` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.publicationDate` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Immunization.education.presentationDate (presentationDate)is equivalent toExtension.extension:presentationDate (R4: Educational material presentation date (new))Element `Immunization.education.presentationDate` is part of an existing definition because parent element `Immunization.education` requires a cross-version extension. Element `Immunization.education.presentationDate` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.presentationDate` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

Group 6 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Dose number within series additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.protocolApplied.doseNumber[x] (doseNumber[x])is broader thanExtension (R4: Dose number within series additional types)Element `Immunization.protocolApplied.doseNumber[x]` is mapped to FHIR R5 element `Immunization.protocolApplied.doseNumber` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types: positiveInt. The mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types based on type expansion: value. The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Group 7 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Recommended number of doses for immunity additional typesversion: 0.1.0)

Source CodeRelationshipTarget CodeComment
Immunization.protocolApplied.seriesDoses[x] (seriesDoses[x])is broader thanExtension (R4: Recommended number of doses for immunity additional types)Element `Immunization.protocolApplied.seriesDoses[x]` is mapped to FHIR R5 element `Immunization.protocolApplied.seriesDoses` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types: positiveInt. The mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types based on type expansion: value. The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).