R4ImmunizationElementMapToR3 - Extensions for Using Data Elements from FHIR R4 in FHIR STU3 v0.1.0

Immunization.meta

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

Immunization.implicitRules

implicitRules

Immunization.implicitRules

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

Immunization.language

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

Immunization.text

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

Immunization.contained

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

Immunization.identifier

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

Immunization.status

status

Immunization.notGiven

Element `Immunization.status` is mapped to FHIR STU3 element `Immunization.status` as `SourceIsBroaderThanTarget`. Element `Immunization.status` is mapped to FHIR STU3 element `Immunization.notGiven` as `SourceIsBroaderThanTarget`. 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 or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Immunization.status

Immunization.statusReason

statusReason

Immunization.notGiven

Element `Immunization.statusReason` is mapped to FHIR STU3 element `Immunization.notGiven` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.statusReason` do not cover the following types: CodeableConcept. The mappings for `Immunization.statusReason` do not cover the following types based on type expansion: coding, text. 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

Immunization.vaccineCode

Element `Immunization.vaccineCode` is mapped to FHIR STU3 element `Immunization.vaccineCode` as `Equivalent`.

Immunization.patient

patient

Immunization.patient

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

Immunization.encounter

encounter

Immunization.encounter

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

Immunization.occurrence[x]

occurrence[x]

Immunization.date

Element `Immunization.occurrence[x]` is mapped to FHIR STU3 element `Immunization.date` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.occurrence[x]` do not cover the following types: string. The mappings for `Immunization.occurrence[x]` do not cover the following types based on type expansion: value. 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

Immunization.primarySource

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

Immunization.reportOrigin

reportOrigin

Immunization.reportOrigin

Element `Immunization.reportOrigin` is mapped to FHIR STU3 element `Immunization.reportOrigin` as `Equivalent`. Should not be populated if primarySource = True, not required even if primarySource = False.

Immunization.location

location

Immunization.location

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

Immunization.manufacturer

manufacturer

Immunization.manufacturer

Element `Immunization.manufacturer` is mapped to FHIR STU3 element `Immunization.manufacturer` as `Equivalent`.

Immunization.lotNumber

lotNumber

Immunization.lotNumber

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

Immunization.expirationDate

expirationDate

Immunization.expirationDate

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

Immunization.site

site

Immunization.site

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

Immunization.route

route

Immunization.route

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

Immunization.doseQuantity

doseQuantity

Immunization.doseQuantity

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

Immunization.performer

performer

Immunization.practitioner

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

Immunization.performer.function

function

Immunization.practitioner.role

Element `Immunization.performer.function` is mapped to FHIR STU3 element `Immunization.practitioner.role` as `Equivalent`.

Immunization.performer.actor

actor

Immunization.practitioner.actor

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

Immunization.note

note

Immunization.note

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

Immunization.reasonCode

reasonCode

Immunization.explanation.reason

Element `Immunization.reasonCode` is mapped to FHIR STU3 element `Immunization.explanation.reason` as `SourceIsBroaderThanTarget`. Element `Immunization.reasonCode` is mapped to FHIR STU3 element `Immunization.explanation.reasonNotGiven` as `SourceIsBroaderThanTarget`.

Immunization.explanation.reasonNotGiven

Immunization.reaction

reaction

Immunization.reaction

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

Immunization.reaction.date

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

Immunization.reaction.detail

detail

Immunization.reaction.detail

Element `Immunization.reaction.detail` is mapped to FHIR STU3 element `Immunization.reaction.detail` as `Equivalent`.

Immunization.reaction.reported

reported

Immunization.reaction.reported

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

Immunization.protocolApplied

protocolApplied

Immunization.vaccinationProtocol

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

Immunization.protocolApplied.series

series

Immunization.vaccinationProtocol.series

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

Immunization.protocolApplied.authority

authority

Immunization.vaccinationProtocol.authority

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

Immunization.protocolApplied.targetDisease

targetDisease

Immunization.vaccinationProtocol.targetDisease

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

Immunization.protocolApplied.doseNumber[x]

doseNumber[x]

Immunization.vaccinationProtocol.doseSequence

Element `Immunization.protocolApplied.doseNumber[x]` is mapped to FHIR STU3 element `Immunization.vaccinationProtocol.doseSequence` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types: string. 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]

Immunization.vaccinationProtocol.seriesDoses

Element `Immunization.protocolApplied.seriesDoses[x]` is mapped to FHIR STU3 element `Immunization.vaccinationProtocol.seriesDoses` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types: string. 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: completed | entered-in-error | not-done additional codesversion: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.status (status)

Extension (R4: completed | entered-in-error | not-done additional codes)

Group 3 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Reason not done additional typesversion: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.statusReason (statusReason)

Extension (R4: Reason not done additional types)

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

Source Code

Relationship

Target Code

Comment

Immunization.occurrence[x] (occurrence[x])

Extension (R4: Vaccine administration date additional types)

Group 5 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 Code

Relationship

Target Code

Comment

Immunization.recorded (recorded)

Extension (R4: When the immunization was first captured in the subject's record (new))

Element `Immunization.recorded` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.recorded` has no mapping targets in FHIR STU3. 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: Why immunization occurred (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.reasonReference (reasonReference)

Extension (R4: Why immunization occurred (new))

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

Group 7 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Dose potency (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.isSubpotent (isSubpotent)

Extension (R4: Dose potency (new))

Element `Immunization.isSubpotent` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.isSubpotent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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.

Group 8 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Reason for being subpotent (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.subpotentReason (subpotentReason)

Extension (R4: Reason for being subpotent (new))

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

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

Source Code

Relationship

Target Code

Comment

Immunization.education (education)

Extension (R4: Educational material presented to patient (new))

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

Immunization.education.documentType (documentType)

Extension.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.explanation based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.documentType` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Immunization.education.reference (reference)

Extension.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.explanation based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.reference` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Immunization.education.publicationDate (publicationDate)

Extension.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.explanation based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.publicationDate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Immunization.education.presentationDate (presentationDate)

Extension.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.explanation based on following the parent source element upwards and mapping to `Immunization`. Element `Immunization.education.presentationDate` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

Group 10 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Patient eligibility for a vaccination program (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.programEligibility (programEligibility)

Extension (R4: Patient eligibility for a vaccination program (new))

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

Group 11 Mapping from http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1 to R4: Funding source for the vaccine (new)version: 0.1.0)

Source Code

Relationship

Target Code

Comment

Immunization.fundingSource (fundingSource)

Extension (R4: Funding source for the vaccine (new))

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

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

Source Code

Relationship

Target Code

Comment

Immunization.protocolApplied.doseNumber[x] (doseNumber[x])

Extension (R4: Dose number within series additional types)

Group 13 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 Code

Relationship

Target Code

Comment

Immunization.protocolApplied.seriesDoses[x] (seriesDoses[x])