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": "R4B-DocumentReference-element-map-to-R5",
  "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-r4b.r5"
          }
        ]
      }
    },
    {
      "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-r4b.r5"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/xver/ConceptMap/R4B-DocumentReference-element-map-to-R5",
  "version": "0.1.0",
  "name": "R4BDocumentReferenceElementMapToR5",
  "title": "Cross-version mapping for FHIR R4B DocumentReference to FHIR R5 DocumentReference",
  "status": "active",
  "experimental": false,
  "date": "2026-03-17T16:03:51.4081673-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 R4B DocumentReference to FHIR R5.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "sourceScopeCanonical": "http://hl7.org/fhir/4.3",
  "targetScopeUri": "http://hl7.org/fhir/5.0",
  "group": [
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/StructureDefinition/DocumentReference|5.0.0",
      "element": [
        {
          "code": "DocumentReference.meta",
          "display": "meta",
          "target": [
            {
              "code": "DocumentReference.meta",
              "display": "DocumentReference.meta",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.meta` is mapped to FHIR R5 element `DocumentReference.meta` as `Equivalent`."
            }
          ]
        },
        {
          "code": "DocumentReference.implicitRules",
          "display": "implicitRules",
          "target": [
            {
              "code": "DocumentReference.implicitRules",
              "display": "DocumentReference.implicitRules",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.implicitRules` is mapped to FHIR R5 element `DocumentReference.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. 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."
            }
          ]
        },
        {
          "code": "DocumentReference.language",
          "display": "language",
          "target": [
            {
              "code": "DocumentReference.language",
              "display": "DocumentReference.language",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.language` is mapped to FHIR R5 element `DocumentReference.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": "DocumentReference.text",
          "display": "text",
          "target": [
            {
              "code": "DocumentReference.text",
              "display": "DocumentReference.text",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.text` is mapped to FHIR R5 element `DocumentReference.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 information is added later."
            }
          ]
        },
        {
          "code": "DocumentReference.contained",
          "display": "contained",
          "target": [
            {
              "code": "DocumentReference.contained",
              "display": "DocumentReference.contained",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.contained` is mapped to FHIR R5 element `DocumentReference.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels."
            }
          ]
        },
        {
          "code": "DocumentReference.masterIdentifier",
          "display": "masterIdentifier",
          "target": [
            {
              "code": "DocumentReference.identifier",
              "display": "DocumentReference.identifier",
              "relationship": "source-is-narrower-than-target",
              "comment": "Element `DocumentReference.masterIdentifier` is mapped to FHIR R5 element `DocumentReference.identifier` as `SourceIsNarrowerThanTarget`.\nCDA Document Id extension and root."
            }
          ]
        },
        {
          "code": "DocumentReference.identifier",
          "display": "identifier",
          "target": [
            {
              "code": "DocumentReference.identifier",
              "display": "DocumentReference.identifier",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.identifier` is mapped to FHIR R5 element `DocumentReference.identifier` as `Equivalent`."
            }
          ]
        },
        {
          "code": "DocumentReference.status",
          "display": "status",
          "target": [
            {
              "code": "DocumentReference.status",
              "display": "DocumentReference.status",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.status` is mapped to FHIR R5 element `DocumentReference.status` as `Equivalent`.\nThis is the status of the DocumentReference object, which might be independent from the docStatus element.\n\nThis element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid."
            }
          ]
        },
        {
          "code": "DocumentReference.docStatus",
          "display": "docStatus",
          "target": [
            {
              "code": "DocumentReference.docStatus",
              "display": "DocumentReference.docStatus",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.docStatus` is mapped to FHIR R5 element `DocumentReference.docStatus` as `SourceIsNarrowerThanTarget`.\nThe mappings for `DocumentReference.docStatus` do not allow expression of the necessary codes, per the bindings on the source and target.\nThe document that is pointed to might be in various lifecycle states."
            }
          ]
        },
        {
          "code": "DocumentReference.type",
          "display": "type",
          "target": [
            {
              "code": "DocumentReference.type",
              "display": "DocumentReference.type",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.type` is mapped to FHIR R5 element `DocumentReference.type` as `Equivalent`.\nKey metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents."
            }
          ]
        },
        {
          "code": "DocumentReference.category",
          "display": "category",
          "target": [
            {
              "code": "DocumentReference.category",
              "display": "DocumentReference.category",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.category` is mapped to FHIR R5 element `DocumentReference.category` as `Equivalent`.\nKey metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching."
            }
          ]
        },
        {
          "code": "DocumentReference.subject",
          "display": "subject",
          "target": [
            {
              "code": "DocumentReference.subject",
              "display": "DocumentReference.subject",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.subject` is mapped to FHIR R5 element `DocumentReference.subject` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `DocumentReference.subject` with unmapped reference targets: Device, Group, Patient, Practitioner."
            }
          ]
        },
        {
          "code": "DocumentReference.date",
          "display": "date",
          "target": [
            {
              "code": "DocumentReference.date",
              "display": "DocumentReference.date",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.date` is mapped to FHIR R5 element `DocumentReference.date` as `Equivalent`.\nReferencing/indexing time is used for tracking, organizing versions and searching."
            }
          ]
        },
        {
          "code": "DocumentReference.author",
          "display": "author",
          "target": [
            {
              "code": "DocumentReference.author",
              "display": "DocumentReference.author",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.author` is mapped to FHIR R5 element `DocumentReference.author` as `Equivalent`.\nNot necessarily who did the actual data entry (i.e. typist) or who was the source (informant)."
            }
          ]
        },
        {
          "code": "DocumentReference.authenticator",
          "display": "authenticator",
          "target": [
            {
              "code": "DocumentReference.attester.mode",
              "display": "DocumentReference.attester.mode",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.authenticator` is mapped to FHIR R5 element `DocumentReference.attester.mode` as `SourceIsBroaderThanTarget`.\nThe mappings for `DocumentReference.authenticator` do not cover the following types: Reference.\nRepresents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator."
            }
          ]
        },
        {
          "code": "DocumentReference.custodian",
          "display": "custodian",
          "target": [
            {
              "code": "DocumentReference.custodian",
              "display": "DocumentReference.custodian",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.custodian` is mapped to FHIR R5 element `DocumentReference.custodian` as `Equivalent`.\nIdentifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization."
            }
          ]
        },
        {
          "code": "DocumentReference.relatesTo",
          "display": "relatesTo",
          "target": [
            {
              "code": "DocumentReference.relatesTo",
              "display": "DocumentReference.relatesTo",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.relatesTo` is mapped to FHIR R5 element `DocumentReference.relatesTo` as `Equivalent`.\nThis element is labeled as a modifier because documents that append to other documents are incomplete on their own."
            }
          ]
        },
        {
          "code": "DocumentReference.relatesTo.code",
          "display": "code",
          "target": [
            {
              "code": "DocumentReference.relatesTo.code",
              "display": "DocumentReference.relatesTo.code",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.relatesTo.code` is mapped to FHIR R5 element `DocumentReference.relatesTo.code` as `SourceIsNarrowerThanTarget`.\nThe mappings for `DocumentReference.relatesTo.code` do not allow expression of the necessary codes, per the bindings on the source and target.\nIf this document appends another document, then the document cannot be fully understood without also accessing the referenced document."
            }
          ]
        },
        {
          "code": "DocumentReference.relatesTo.target",
          "display": "target",
          "target": [
            {
              "code": "DocumentReference.relatesTo.target",
              "display": "DocumentReference.relatesTo.target",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.relatesTo.target` is mapped to FHIR R5 element `DocumentReference.relatesTo.target` as `SourceIsNarrowerThanTarget`."
            }
          ]
        },
        {
          "code": "DocumentReference.description",
          "display": "description",
          "target": [
            {
              "code": "DocumentReference.description",
              "display": "DocumentReference.description",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.description` is mapped to FHIR R5 element `DocumentReference.description` as `Equivalent`.\nWhat the document is about,  a terse summary of the document."
            }
          ]
        },
        {
          "code": "DocumentReference.securityLabel",
          "display": "securityLabel",
          "target": [
            {
              "code": "DocumentReference.securityLabel",
              "display": "DocumentReference.securityLabel",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.securityLabel` is mapped to FHIR R5 element `DocumentReference.securityLabel` as `Equivalent`.\nThe confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce.   \n\nIn the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects."
            }
          ]
        },
        {
          "code": "DocumentReference.content",
          "display": "content",
          "target": [
            {
              "code": "DocumentReference.content",
              "display": "DocumentReference.content",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.content` is mapped to FHIR R5 element `DocumentReference.content` as `Equivalent`."
            }
          ]
        },
        {
          "code": "DocumentReference.content.attachment",
          "display": "attachment",
          "target": [
            {
              "code": "DocumentReference.content.attachment",
              "display": "DocumentReference.content.attachment",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.content.attachment` is mapped to FHIR R5 element `DocumentReference.content.attachment` as `Equivalent`."
            }
          ]
        },
        {
          "code": "DocumentReference.context",
          "display": "context",
          "target": [
            {
              "code": "DocumentReference.context",
              "display": "DocumentReference.context",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context` is mapped to FHIR R5 element `DocumentReference.context` as `SourceIsNarrowerThanTarget`.\nThese values are primarily added to help with searching for interesting/relevant documents."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.authenticator|0.1.0",
      "element": [
        {
          "code": "DocumentReference.authenticator",
          "display": "authenticator",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.authenticator` is mapped to FHIR R5 element `DocumentReference.attester.mode` as `SourceIsBroaderThanTarget`.\nThe mappings for `DocumentReference.authenticator` do not cover the following types: Reference.\nRepresents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.relatesTo.code|0.1.0",
      "element": [
        {
          "code": "DocumentReference.relatesTo.code",
          "display": "code",
          "target": [
            {
              "code": "Extension",
              "relationship": "equivalent",
              "comment": "Element `DocumentReference.relatesTo.code` is mapped to FHIR R5 element `DocumentReference.relatesTo.code` as `SourceIsNarrowerThanTarget`.\nThe mappings for `DocumentReference.relatesTo.code` do not allow expression of the necessary codes, per the bindings on the source and target.\nIf this document appends another document, then the document cannot be fully understood without also accessing the referenced document."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.content.format|0.1.0",
      "element": [
        {
          "code": "DocumentReference.content.format",
          "display": "format",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.content.format` has a context of DocumentReference.content based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.content.format` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nNote that while IHE mostly issues URNs for format types, not all documents can be identified by a URI."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.context.encounter|0.1.0",
      "element": [
        {
          "code": "DocumentReference.context.encounter",
          "display": "encounter",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context.encounter` has a context of DocumentReference.context based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.context.encounter` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element)."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.context.event|0.1.0",
      "element": [
        {
          "code": "DocumentReference.context.event",
          "display": "event",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context.event` has a context of DocumentReference.context based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.context.event` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nAn event can further specialize the act inherent in the type, such as  where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.context.period|0.1.0",
      "element": [
        {
          "code": "DocumentReference.context.period",
          "display": "period",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context.period` has a context of DocumentReference.context based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.context.period` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element)."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.context.facilityType|0.1.0",
      "element": [
        {
          "code": "DocumentReference.context.facilityType",
          "display": "facilityType",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context.facilityType` has a context of DocumentReference.context based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.context.facilityType` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element)."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.context.practiceSetting|0.1.0",
      "element": [
        {
          "code": "DocumentReference.context.practiceSetting",
          "display": "practiceSetting",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context.practiceSetting` has a context of DocumentReference.context based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.context.practiceSetting` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nThis element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.context.sourcePatientInfo|0.1.0",
      "element": [
        {
          "code": "DocumentReference.context.sourcePatientInfo",
          "display": "sourcePatientInfo",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context.sourcePatientInfo` has a context of DocumentReference.context based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.context.sourcePatientInfo` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element)."
            }
          ]
        }
      ]
    },
    {
      "source": "http://hl7.org/fhir/StructureDefinition/DocumentReference|4.3.0",
      "target": "http://hl7.org/fhir/4.3/StructureDefinition/extension-DocumentReference.context.related|0.1.0",
      "element": [
        {
          "code": "DocumentReference.context.related",
          "display": "related",
          "target": [
            {
              "code": "Extension",
              "relationship": "source-is-broader-than-target",
              "comment": "Element `DocumentReference.context.related` has a context of DocumentReference.context based on following the parent source element upwards and mapping to `DocumentReference`.\nElement `DocumentReference.context.related` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).\nMay be identifiers or resources that caused the DocumentReference or referenced Document to be created."
            }
          ]
        }
      ]
    }
  ]
}