R5ImmunizationElementMapToR4 - Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1.0

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

ConceptMap: R5ImmunizationElementMapToR4

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

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

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

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

Source Concept Details

Relationship

Target Concept Details

Comment

Codes from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0

Codes from Immunization

Immunization.meta

meta

is equivalent to

Immunization.meta

Element `Immunization.meta` is mapped to FHIR R4 element `Immunization.meta` as `Equivalent`.

Immunization.implicitRules

implicitRules

is equivalent to

Immunization.implicitRules

Element `Immunization.implicitRules` is mapped to FHIR R4 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 its narrative along with other profiles, value sets, etc.

Immunization.language

language

is equivalent to

Immunization.language

Element `Immunization.language` is mapped to FHIR R4 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 to

Immunization.text

Element `Immunization.text` is mapped to FHIR R4 element `Immunization.text` as `Equivalent`. Contained resources do not have a 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 to

Immunization.contained

Element `Immunization.contained` is mapped to FHIR R4 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 to

Immunization.identifier

Element `Immunization.identifier` is mapped to FHIR R4 element `Immunization.identifier` as `Equivalent`.

Immunization.status

status

is equivalent to

Immunization.status

Element `Immunization.status` is mapped to FHIR R4 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 to

Immunization.statusReason

Element `Immunization.statusReason` is mapped to FHIR R4 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 to

Immunization.vaccineCode

Element `Immunization.vaccineCode` is mapped to FHIR R4 element `Immunization.vaccineCode` as `Equivalent`. The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode.

Immunization.manufacturer

manufacturer

maps to wider concept

Immunization.manufacturer

Element `Immunization.manufacturer` is mapped to FHIR R4 element `Immunization.manufacturer` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.manufacturer` do not cover the following types: CodeableReference. The mappings for `Immunization.manufacturer` do not cover the following types based on type expansion: concept.

Immunization.lotNumber

lotNumber

is equivalent to

Immunization.lotNumber

Element `Immunization.lotNumber` is mapped to FHIR R4 element `Immunization.lotNumber` as `Equivalent`.

Immunization.expirationDate

expirationDate

is equivalent to

Immunization.expirationDate

Element `Immunization.expirationDate` is mapped to FHIR R4 element `Immunization.expirationDate` as `Equivalent`.

Immunization.patient

patient

is equivalent to

Immunization.patient

Element `Immunization.patient` is mapped to FHIR R4 element `Immunization.patient` as `Equivalent`.

Immunization.encounter

encounter

is equivalent to

Immunization.encounter

Element `Immunization.encounter` is mapped to FHIR R4 element `Immunization.encounter` as `Equivalent`.

Immunization.occurrence[x]

occurrence[x]

is equivalent to

Immunization.occurrence[x]

Element `Immunization.occurrence[x]` is mapped to FHIR R4 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 to

Immunization.primarySource

Element `Immunization.primarySource` is mapped to FHIR R4 element `Immunization.primarySource` as `Equivalent`. Reflects the “reliability” of the content.

Immunization.location

location

is equivalent to

Immunization.location

Element `Immunization.location` is mapped to FHIR R4 element `Immunization.location` as `Equivalent`.

Immunization.site

site

is equivalent to

Immunization.site

Element `Immunization.site` is mapped to FHIR R4 element `Immunization.site` as `Equivalent`.

Immunization.route

route

is equivalent to

Immunization.route

Element `Immunization.route` is mapped to FHIR R4 element `Immunization.route` as `Equivalent`.

Immunization.doseQuantity

doseQuantity

is equivalent to

Immunization.doseQuantity

Element `Immunization.doseQuantity` is mapped to FHIR R4 element `Immunization.doseQuantity` as `Equivalent`.

Immunization.performer

performer

maps to wider concept

Immunization.performer

Element `Immunization.performer` is mapped to FHIR R4 element `Immunization.performer` as `Equivalent`.

Immunization.performer.function

function

is equivalent to

Immunization.performer.function

Element `Immunization.performer.function` is mapped to FHIR R4 element `Immunization.performer.function` as `Equivalent`.

Immunization.performer.actor

actor

maps to wider concept

Immunization.performer.actor

Element `Immunization.performer.actor` is mapped to FHIR R4 element `Immunization.performer.actor` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `Immunization.performer.actor` with unmapped reference targets: Patient, RelatedPerson. When the individual practitioner who performed the action is known, it is best to send.

Immunization.note

note

is equivalent to

Immunization.note

Element `Immunization.note` is mapped to FHIR R4 element `Immunization.note` as `Equivalent`.

Immunization.reason

reason

is related to

Immunization.reasonCode

Element `Immunization.reason` is mapped to FHIR R4 element `Immunization.reasonCode` as `SourceIsBroaderThanTarget`. Element `Immunization.reason` is mapped to FHIR R4 element `Immunization.reasonReference` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.reason` do not cover the following types: CodeableReference.

is related to

Immunization.reasonReference

Immunization.isSubpotent

isSubpotent

is equivalent to

Immunization.isSubpotent

Element `Immunization.isSubpotent` is mapped to FHIR R4 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 to

Immunization.subpotentReason

Element `Immunization.subpotentReason` is mapped to FHIR R4 element `Immunization.subpotentReason` as `Equivalent`.

Immunization.programEligibility

programEligibility

maps to wider concept

Immunization.programEligibility

Element `Immunization.programEligibility` is mapped to FHIR R4 element `Immunization.programEligibility` as `Equivalent`.

Immunization.fundingSource

fundingSource

is equivalent to

Immunization.fundingSource

Element `Immunization.fundingSource` is mapped to FHIR R4 element `Immunization.fundingSource` as `Equivalent`.

Immunization.reaction

reaction

maps to wider concept

Immunization.reaction

Element `Immunization.reaction` is mapped to FHIR R4 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 to

Immunization.reaction.date

Element `Immunization.reaction.date` is mapped to FHIR R4 element `Immunization.reaction.date` as `Equivalent`.

Immunization.reaction.manifestation

manifestation

is equivalent to

Immunization.reaction.detail

Element `Immunization.reaction.manifestation` is mapped to FHIR R4 element `Immunization.reaction.detail` as `SourceIsBroaderThanTarget`.

Immunization.reaction.reported

reported

is equivalent to

Immunization.reaction.reported

Element `Immunization.reaction.reported` is mapped to FHIR R4 element `Immunization.reaction.reported` as `Equivalent`.

Immunization.protocolApplied

protocolApplied

maps to wider concept

Immunization.protocolApplied

Element `Immunization.protocolApplied` is mapped to FHIR R4 element `Immunization.protocolApplied` as `Equivalent`.

Immunization.protocolApplied.series

series

is equivalent to

Immunization.protocolApplied.series

Element `Immunization.protocolApplied.series` is mapped to FHIR R4 element `Immunization.protocolApplied.series` as `Equivalent`.

Immunization.protocolApplied.authority

authority

is equivalent to

Immunization.protocolApplied.authority

Element `Immunization.protocolApplied.authority` is mapped to FHIR R4 element `Immunization.protocolApplied.authority` as `Equivalent`.

Immunization.protocolApplied.targetDisease

targetDisease

is equivalent to

Immunization.protocolApplied.targetDisease

Element `Immunization.protocolApplied.targetDisease` is mapped to FHIR R4 element `Immunization.protocolApplied.targetDisease` as `Equivalent`.

Immunization.protocolApplied.doseNumber

doseNumber

is equivalent to

Immunization.protocolApplied.doseNumber[x]

Element `Immunization.protocolApplied.doseNumber` is mapped to FHIR R4 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`. The use of an integer is preferred if known. Text should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Immunization.protocolApplied.seriesDoses

seriesDoses

is equivalent to

Immunization.protocolApplied.seriesDoses[x]

Element `Immunization.protocolApplied.seriesDoses` is mapped to FHIR R4 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`. The use of an integer is preferred if known.

Group 2 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: Authority that the immunization event is based on (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.basedOn (basedOn)

maps to wider concept

Extension (R5: Authority that the immunization event is based on (new))

Element `Immunization.basedOn` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.basedOn` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Allows tracing of an authorization for the Immunization.

Group 3 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: Product that was administered (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.administeredProduct (administeredProduct)

maps to wider concept

Extension (R5: Product that was administered (new))

Element `Immunization.administeredProduct` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.administeredProduct` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Group 4 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: manufacturer additional typesversion: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.manufacturer (manufacturer)

is equivalent to

Extension (R5: manufacturer additional types)

Group 5 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: Additional information in support of the immunization (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.supportingInformation (supportingInformation)

maps to wider concept

Extension (R5: Additional information in support of the immunization (new))

Element `Immunization.supportingInformation` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.supportingInformation` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Group 6 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: Indicates the source of a reported record (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.informationSource (informationSource)

maps to wider concept

Extension (R5: Indicates the source of a reported record (new))

Element `Immunization.informationSource` has a context of Immunization based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.informationSource` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Typically will not be populated if primarySource = True, not required even if primarySource = False.

Group 7 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: Why immunization occurred additional typesversion: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.reason (reason)

maps to wider concept

Extension (R5: Why immunization occurred additional types)

Group 8 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: The program that eligibility is declared for (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.programEligibility.program (program)

maps to wider concept

Extension (R5: The program that eligibility is declared for (new))

Element `Immunization.programEligibility.program` has a context of Immunization.programEligibility based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.programEligibility.program` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Group 9 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|5.0.0 to R5: The patient's eligibility status for the program (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.programEligibility.programStatus (programStatus)

maps to wider concept

Extension (R5: The patient's eligibility status for the program (new))

Element `Immunization.programEligibility.programStatus` has a context of Immunization.programEligibility based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.programEligibility.programStatus` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).