FHIR IG analytics

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

Note: links and images are rebased to the (stated) source

Source1

{
  "resourceType": "ConceptMap",
  "id": "R3-Immunization-element-map-to-R4",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r3.r4"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r3.r4"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/xver/ConceptMap/R3-Immunization-element-map-to-R4",
  "version": "0.1.0",
  "name": "R3ImmunizationElementMapToR4",
  "title": "Cross-version mapping for FHIR STU3 Immunization to FHIR R4 Immunization",
  "status": "active",
  "experimental": false,
  "date": "2026-03-17T16:03:23.9963516-05:00",
  "contact": [
    {
      "name": "FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description": "This ConceptMap represents cross-version mappings for elements from a FHIR STU3 Immunization to FHIR R4.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "sourceCanonical": "http://hl7.org/fhir/3.0",
  "targetUri": "http://hl7.org/fhir/4.0",
  "group": [
    {
      "source": "http://hl7.org/fhir/StructureDefinition/Immunization",
      "sourceVersion": "3.0.2",
      "target": "http://hl7.org/fhir/StructureDefinition/Immunization",
      "targetVersion": "4.0.1",
      "element": [
        {
          "code": "Immunization.meta",
          "display": "meta",
          "target": [
            {
              "code": "Immunization.meta",
              "display": "Immunization.meta",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.meta` is mapped to FHIR R4 element `Immunization.meta` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.implicitRules",
          "display": "implicitRules",
          "target": [
            {
              "code": "Immunization.implicitRules",
              "display": "Immunization.implicitRules",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.implicitRules` is mapped to FHIR R4 element `Immunization.implicitRules` as `Equivalent`.\nAsserting 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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."
            }
          ]
        },
        {
          "code": "Immunization.language",
          "display": "language",
          "target": [
            {
              "code": "Immunization.language",
              "display": "Immunization.language",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.language` is mapped to FHIR R4 element `Immunization.language` as `Equivalent`.\nLanguage 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)."
            }
          ]
        },
        {
          "code": "Immunization.text",
          "display": "text",
          "target": [
            {
              "code": "Immunization.text",
              "display": "Immunization.text",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.text` is mapped to FHIR R4 element `Immunization.text` as `Equivalent`.\nContained 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."
            }
          ]
        },
        {
          "code": "Immunization.contained",
          "display": "contained",
          "target": [
            {
              "code": "Immunization.contained",
              "display": "Immunization.contained",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.contained` is mapped to FHIR R4 element `Immunization.contained` as `Equivalent`.\nThis 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."
            }
          ]
        },
        {
          "code": "Immunization.identifier",
          "display": "identifier",
          "target": [
            {
              "code": "Immunization.identifier",
              "display": "Immunization.identifier",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.identifier` is mapped to FHIR R4 element `Immunization.identifier` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.status",
          "display": "status",
          "target": [
            {
              "code": "Immunization.status",
              "display": "Immunization.status",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.status` is mapped to FHIR R4 element `Immunization.status` as `SourceIsNarrowerThanTarget`.\nThe mappings for `Immunization.status` do not allow expression of the necessary codes, per the bindings on the source and target.\nWill generally be set to show that the immunization has been completed.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid."
            }
          ]
        },
        {
          "code": "Immunization.notGiven",
          "display": "notGiven",
          "target": [
            {
              "code": "Immunization.status",
              "display": "Immunization.status",
              "equivalence": "relatedto",
              "comment": "Element `Immunization.notGiven` is mapped to FHIR R4 element `Immunization.status` as `SourceIsBroaderThanTarget`.\nElement `Immunization.notGiven` is mapped to FHIR R4 element `Immunization.statusReason` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.notGiven` do not cover the following types: boolean.\nThe mappings for `Immunization.notGiven` do not cover the following types based on type expansion: value.\nThis element is labeled as a modifier because it indicates that an immunization didn't happen."
            },
            {
              "code": "Immunization.statusReason",
              "display": "Immunization.statusReason",
              "equivalence": "relatedto",
              "comment": "Element `Immunization.notGiven` is mapped to FHIR R4 element `Immunization.status` as `SourceIsBroaderThanTarget`.\nElement `Immunization.notGiven` is mapped to FHIR R4 element `Immunization.statusReason` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.notGiven` do not cover the following types: boolean.\nThe mappings for `Immunization.notGiven` do not cover the following types based on type expansion: value.\nThis element is labeled as a modifier because it indicates that an immunization didn't happen."
            }
          ]
        },
        {
          "code": "Immunization.vaccineCode",
          "display": "vaccineCode",
          "target": [
            {
              "code": "Immunization.vaccineCode",
              "display": "Immunization.vaccineCode",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccineCode` is mapped to FHIR R4 element `Immunization.vaccineCode` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.patient",
          "display": "patient",
          "target": [
            {
              "code": "Immunization.patient",
              "display": "Immunization.patient",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.patient` is mapped to FHIR R4 element `Immunization.patient` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.encounter",
          "display": "encounter",
          "target": [
            {
              "code": "Immunization.encounter",
              "display": "Immunization.encounter",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.encounter` is mapped to FHIR R4 element `Immunization.encounter` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.date",
          "display": "date",
          "target": [
            {
              "code": "Immunization.occurrence[x]",
              "display": "Immunization.occurrence[x]",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.date` is mapped to FHIR R4 element `Immunization.occurrence[x]` as `Equivalent`.\nThe target context `Immunization.occurrence[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `Immunization`.\nWhen 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."
            }
          ]
        },
        {
          "code": "Immunization.primarySource",
          "display": "primarySource",
          "target": [
            {
              "code": "Immunization.primarySource",
              "display": "Immunization.primarySource",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.primarySource` is mapped to FHIR R4 element `Immunization.primarySource` as `Equivalent`.\nReflects the “reliability” of the content."
            }
          ]
        },
        {
          "code": "Immunization.reportOrigin",
          "display": "reportOrigin",
          "target": [
            {
              "code": "Immunization.reportOrigin",
              "display": "Immunization.reportOrigin",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.reportOrigin` is mapped to FHIR R4 element `Immunization.reportOrigin` as `Equivalent`.\nShould not be populated if primarySource = True, will not be required even if primarySource = False."
            }
          ]
        },
        {
          "code": "Immunization.location",
          "display": "location",
          "target": [
            {
              "code": "Immunization.location",
              "display": "Immunization.location",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.location` is mapped to FHIR R4 element `Immunization.location` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.manufacturer",
          "display": "manufacturer",
          "target": [
            {
              "code": "Immunization.manufacturer",
              "display": "Immunization.manufacturer",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.manufacturer` is mapped to FHIR R4 element `Immunization.manufacturer` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.lotNumber",
          "display": "lotNumber",
          "target": [
            {
              "code": "Immunization.lotNumber",
              "display": "Immunization.lotNumber",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.lotNumber` is mapped to FHIR R4 element `Immunization.lotNumber` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.expirationDate",
          "display": "expirationDate",
          "target": [
            {
              "code": "Immunization.expirationDate",
              "display": "Immunization.expirationDate",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.expirationDate` is mapped to FHIR R4 element `Immunization.expirationDate` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.site",
          "display": "site",
          "target": [
            {
              "code": "Immunization.site",
              "display": "Immunization.site",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.site` is mapped to FHIR R4 element `Immunization.site` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.route",
          "display": "route",
          "target": [
            {
              "code": "Immunization.route",
              "display": "Immunization.route",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.route` is mapped to FHIR R4 element `Immunization.route` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.doseQuantity",
          "display": "doseQuantity",
          "target": [
            {
              "code": "Immunization.doseQuantity",
              "display": "Immunization.doseQuantity",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.doseQuantity` is mapped to FHIR R4 element `Immunization.doseQuantity` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.practitioner",
          "display": "practitioner",
          "target": [
            {
              "code": "Immunization.performer",
              "display": "Immunization.performer",
              "equivalence": "wider",
              "comment": "Element `Immunization.practitioner` is mapped to FHIR R4 element `Immunization.performer` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.practitioner.role",
          "display": "role",
          "target": [
            {
              "code": "Immunization.performer.function",
              "display": "Immunization.performer.function",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.practitioner.role` is mapped to FHIR R4 element `Immunization.performer.function` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.practitioner.actor",
          "display": "actor",
          "target": [
            {
              "code": "Immunization.performer.actor",
              "display": "Immunization.performer.actor",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.practitioner.actor` is mapped to FHIR R4 element `Immunization.performer.actor` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.note",
          "display": "note",
          "target": [
            {
              "code": "Immunization.note",
              "display": "Immunization.note",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.note` is mapped to FHIR R4 element `Immunization.note` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.explanation",
          "display": "explanation",
          "target": [
            {
              "code": "Immunization",
              "display": "Immunization",
              "equivalence": "relatedto",
              "comment": "Element `Immunization.explanation` is mapped to FHIR R4 element `Immunization` as `SourceIsNarrowerThanTarget`."
            }
          ]
        },
        {
          "code": "Immunization.explanation.reason",
          "display": "reason",
          "target": [
            {
              "code": "Immunization.reasonCode",
              "display": "Immunization.reasonCode",
              "equivalence": "narrower",
              "comment": "Element `Immunization.explanation.reason` is mapped to FHIR R4 element `Immunization.reasonCode` as `SourceIsNarrowerThanTarget`."
            }
          ]
        },
        {
          "code": "Immunization.explanation.reasonNotGiven",
          "display": "reasonNotGiven",
          "target": [
            {
              "code": "Immunization.reasonCode",
              "display": "Immunization.reasonCode",
              "equivalence": "narrower",
              "comment": "Element `Immunization.explanation.reasonNotGiven` is mapped to FHIR R4 element `Immunization.reasonCode` as `SourceIsNarrowerThanTarget`."
            }
          ]
        },
        {
          "code": "Immunization.reaction",
          "display": "reaction",
          "target": [
            {
              "code": "Immunization.reaction",
              "display": "Immunization.reaction",
              "equivalence": "wider",
              "comment": "Element `Immunization.reaction` is mapped to FHIR R4 element `Immunization.reaction` as `Equivalent`.\nA 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."
            }
          ]
        },
        {
          "code": "Immunization.reaction.date",
          "display": "date",
          "target": [
            {
              "code": "Immunization.reaction.date",
              "display": "Immunization.reaction.date",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.reaction.date` is mapped to FHIR R4 element `Immunization.reaction.date` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.reaction.detail",
          "display": "detail",
          "target": [
            {
              "code": "Immunization.reaction.detail",
              "display": "Immunization.reaction.detail",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.reaction.detail` is mapped to FHIR R4 element `Immunization.reaction.detail` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.reaction.reported",
          "display": "reported",
          "target": [
            {
              "code": "Immunization.reaction.reported",
              "display": "Immunization.reaction.reported",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.reaction.reported` is mapped to FHIR R4 element `Immunization.reaction.reported` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.vaccinationProtocol",
          "display": "vaccinationProtocol",
          "target": [
            {
              "code": "Immunization.protocolApplied",
              "display": "Immunization.protocolApplied",
              "equivalence": "wider",
              "comment": "Element `Immunization.vaccinationProtocol` is mapped to FHIR R4 element `Immunization.protocolApplied` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.vaccinationProtocol.doseSequence",
          "display": "doseSequence",
          "target": [
            {
              "code": "Immunization.protocolApplied.doseNumber[x]",
              "display": "Immunization.protocolApplied.doseNumber[x]",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.doseSequence` is mapped to FHIR R4 element `Immunization.protocolApplied.doseNumber[x]` as `Equivalent`.\nThe 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`."
            }
          ]
        },
        {
          "code": "Immunization.vaccinationProtocol.authority",
          "display": "authority",
          "target": [
            {
              "code": "Immunization.protocolApplied.authority",
              "display": "Immunization.protocolApplied.authority",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.authority` is mapped to FHIR R4 element `Immunization.protocolApplied.authority` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.vaccinationProtocol.series",
          "display": "series",
          "target": [
            {
              "code": "Immunization.protocolApplied.series",
              "display": "Immunization.protocolApplied.series",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.series` is mapped to FHIR R4 element `Immunization.protocolApplied.series` as `Equivalent`."
            }
          ]
        },
        {
          "code": "Immunization.vaccinationProtocol.seriesDoses",
          "display": "seriesDoses",
          "target": [
            {
              "code": "Immunization.protocolApplied.seriesDoses[x]",
              "display": "Immunization.protocolApplied.seriesDoses[x]",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.seriesDoses` is mapped to FHIR R4 element `Immunization.protocolApplied.seriesDoses[x]` as `Equivalent`.\nThe 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`."
            }
          ]
        },
        {
          "code": "Immunization.vaccinationProtocol.targetDisease",
          "display": "targetDisease",
          "target": [
            {
              "code": "Immunization.protocolApplied.targetDisease",
              "display": "Immunization.protocolApplied.targetDisease",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.targetDisease` is mapped to FHIR R4 element `Immunization.protocolApplied.targetDisease` as `Equivalent`."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/Immunization",
      "sourceVersion": "3.0.2",
      "target": "http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.notGiven",
      "targetVersion": "0.1.0",
      "element": [
        {
          "code": "Immunization.notGiven",
          "display": "notGiven",
          "target": [
            {
              "code": "Extension",
              "equivalence": "wider",
              "comment": "Element `Immunization.notGiven` is mapped to FHIR R4 element `Immunization.status` as `SourceIsBroaderThanTarget`.\nElement `Immunization.notGiven` is mapped to FHIR R4 element `Immunization.statusReason` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.notGiven` do not cover the following types: boolean.\nThe mappings for `Immunization.notGiven` do not cover the following types based on type expansion: value.\nThis element is labeled as a modifier because it indicates that an immunization didn't happen."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/Immunization",
      "sourceVersion": "3.0.2",
      "target": "http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.description",
      "targetVersion": "0.1.0",
      "element": [
        {
          "code": "Immunization.vaccinationProtocol.description",
          "display": "description",
          "target": [
            {
              "code": "Extension",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.description` has a context of Immunization.protocolApplied based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.vaccinationProtocol.description` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element)."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/Immunization",
      "sourceVersion": "3.0.2",
      "target": "http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatus",
      "targetVersion": "0.1.0",
      "element": [
        {
          "code": "Immunization.vaccinationProtocol.doseStatus",
          "display": "doseStatus",
          "target": [
            {
              "code": "Extension",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.doseStatus` has a context of Immunization.protocolApplied based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.vaccinationProtocol.doseStatus` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nMay need to differentiate between status declarations by a provider vs. a CDS engine."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/Immunization",
      "sourceVersion": "3.0.2",
      "target": "http://hl7.org/fhir/3.0/StructureDefinition/extension-Immunization.vaccinationProtocol.doseStatusReason",
      "targetVersion": "0.1.0",
      "element": [
        {
          "code": "Immunization.vaccinationProtocol.doseStatusReason",
          "display": "doseStatusReason",
          "target": [
            {
              "code": "Extension",
              "equivalence": "equivalent",
              "comment": "Element `Immunization.vaccinationProtocol.doseStatusReason` has a context of Immunization.protocolApplied based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.vaccinationProtocol.doseStatusReason` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element)."
            }
          ]
        }
      ]
    }
  ]
}