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

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

Resource Profile: Profile_R5_Composition_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Composition resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Composition
Definition

A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

ShortA set of resources composed into a single coherent clinical statement with clinical attestation
Comments

While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Composition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Composition.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Composition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Composition.extension:url
    Slice Nameurl
    Definition

    R5: Composition.url (new:uri)

    ShortR5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
    Comments

    Element Composition.url has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.url has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)) (Extension Type: uri)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Composition.extension:version
    Slice Nameversion
    Definition

    R5: Composition.version (new:string)

    ShortR5: An explicitly assigned identifer of a variation of the content in the Composition (new)
    Comments

    Element Composition.version has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.version has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: An explicitly assigned identifer of a variation of the content in the Composition (new)) (Extension Type: string)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Composition.extension:useContext
    Slice NameuseContext
    Definition

    R5: Composition.useContext (new:UsageContext)

    ShortR5: The context that the content is intended to support (new)
    Comments

    Element Composition.useContext has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.useContext has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: The context that the content is intended to support (new)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Composition.extension:name
    Slice Namename
    Definition

    R5: Composition.name (new:string)

    ShortR5: Name for this Composition (computer friendly) (new)
    Comments

    Element Composition.name has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.name has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: Name for this Composition (computer friendly) (new)) (Extension Type: string)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Composition.extension:note
    Slice Namenote
    Definition

    R5: Composition.note (new:Annotation)

    ShortR5: For any additional notes (new)
    Comments

    Element Composition.note has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.note has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). A comment, general note or annotation not coded elsewhere.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R5: For any additional notes (new)) (Extension Type: Annotation)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. Composition.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    18. Composition.status
    Definition

    The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

    Shortpreliminary | final | amended | entered-in-error
    Comments

    If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.

    Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

    Control1..1
    BindingThe codes SHALL be taken from CompositionStatus .http://hl7.org/fhir/ValueSet/composition-status|3.0.2
    (required to http://hl7.org/fhir/ValueSet/composition-status|3.0.2)

    The workflow/clinical status of the composition.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be able to mark interim, amended, or withdrawn compositions or documents.

    20. Composition.status.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional Content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Alternate Namesextensions, user content
    SlicingThis element introduces a set of slices on Composition.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. Composition.status.extension:status
      Slice Namestatus
      Definition

      R5: Composition.status

      ShortR5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
      Comments

      Element Composition.status is mapped to FHIR STU3 element Composition.status as SourceIsBroaderThanTarget. The target context Composition.status is a modifier element, so this extension does not need to be defined as a modifier. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.

      Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown) (Extension Type: code)
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      24. Composition.type
      Definition

      Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

      ShortKind of composition (LOINC if possible)
      Comments

      For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.

      Control1..1
      BindingThe codes SHOULD be taken from FHIR Document Type Codeshttp://hl7.org/fhir/ValueSet/doc-typecodes|3.0.2
      (preferred to http://hl7.org/fhir/ValueSet/doc-typecodes|3.0.2)

      Type of a composition.

      TypeCodeableConcept
      Summarytrue
      Requirements

      Key metadata element describing the composition, used in searching/filtering.

      26. Composition.subject
      Definition

      Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

      ShortWho and/or what the composition is about
      Comments

      For clinical documents, this is usually the patient.

      Control1..1
      TypeReference(Resource)
      Summarytrue
      Requirements

      Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.

      28. Composition.subject.extension
      Definition

      An Extension


      May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortExtensionAdditional Content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Alternate Namesextensions, user content
      SlicingThis element introduces a set of slices on Composition.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 30. Composition.subject.extension:subject
        Slice Namesubject
        Definition

        R5: Composition.subject additional types from child elements (display, identifier, reference, type)

        ShortR5: subject additional types
        Comments

        Element Composition.subject is mapped to FHIR STU3 element Composition.subject as SourceIsBroaderThanTarget. The mappings for Composition.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.subject with unmapped reference targets: Resource. For clinical documents, this is usually the patient.

        Control0..*
        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
        32. Composition.date
        Definition

        The composition editing time, when the composition was last logically changed by the author.

        ShortComposition editing time
        Comments

        The Last Modified Date on the composition may be after the date of the document was attested without being changed.

        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        dateTime is used for tracking, organizing versions and searching.

        34. Composition.author
        Definition

        Identifies who is responsible for the information in the composition, not necessarily who typed it in.

        ShortWho and/or what authored the composition
        Control1..*
        TypeReference(Practitioner, Device, Patient, RelatedPerson)
        Summarytrue
        Requirements

        Identifies who is responsible for the content.

        36. Composition.author.extension
        Definition

        An Extension


        May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortExtensionAdditional Content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Alternate Namesextensions, user content
        SlicingThis element introduces a set of slices on Composition.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 38. Composition.author.extension:author
          Slice Nameauthor
          Definition

          R5: Composition.author

          ShortR5: author
          Comments

          Element Composition.author is mapped to FHIR STU3 element Composition.author as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.author with unmapped reference targets: Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.

          Control0..*
          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
          40. Composition.title
          Definition

          Official human-readable label for the composition.

          ShortHuman Readable name/title
          Comments

          For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.

          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          42. Composition.confidentiality
          Definition

          The code specifying the level of confidentiality of the Composition.

          ShortAs defined by affinity domain
          Comments

          The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).

          This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

          Control0..1
          BindingThe codes SHALL be taken from ConfidentialityClassification|2014-03-26http://hl7.org/fhir/ValueSet/v3-ConfidentialityClassification|2014-03-26
          (required to http://hl7.org/fhir/ValueSet/v3-ConfidentialityClassification|2014-03-26)

          Codes specifying the level of confidentiality of the composition.

          Typecode
          Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue

          Guidance on how to interpret the contents of this table can be foundhere

          0. Composition
          2. Composition.extension
          Control0..*
          SlicingThis element introduces a set of slices on Composition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 4. Composition.extension:url
            Slice Nameurl
            Definition

            R5: Composition.url (new:uri)

            ShortR5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
            Comments

            Element Composition.url has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.url has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

            Control0..1
            TypeExtension(R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)) (Extension Type: uri)
            6. Composition.extension:version
            Slice Nameversion
            Definition

            R5: Composition.version (new:string)

            ShortR5: An explicitly assigned identifer of a variation of the content in the Composition (new)
            Comments

            Element Composition.version has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.version has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

            Control0..1
            TypeExtension(R5: An explicitly assigned identifer of a variation of the content in the Composition (new)) (Extension Type: string)
            8. Composition.extension:useContext
            Slice NameuseContext
            Definition

            R5: Composition.useContext (new:UsageContext)

            ShortR5: The context that the content is intended to support (new)
            Comments

            Element Composition.useContext has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.useContext has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

            Control0..*
            TypeExtension(R5: The context that the content is intended to support (new)) (Complex Extension)
            10. Composition.extension:name
            Slice Namename
            Definition

            R5: Composition.name (new:string)

            ShortR5: Name for this Composition (computer friendly) (new)
            Comments

            Element Composition.name has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.name has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

            Control0..1
            TypeExtension(R5: Name for this Composition (computer friendly) (new)) (Extension Type: string)
            12. Composition.extension:note
            Slice Namenote
            Definition

            R5: Composition.note (new:Annotation)

            ShortR5: For any additional notes (new)
            Comments

            Element Composition.note has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.note has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). A comment, general note or annotation not coded elsewhere.

            Control0..*
            TypeExtension(R5: For any additional notes (new)) (Extension Type: Annotation)
            14. Composition.status
            16. Composition.status.extension
            Control0..*
            SlicingThis element introduces a set of slices on Composition.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 18. Composition.status.extension:status
              Slice Namestatus
              Definition

              R5: Composition.status

              ShortR5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
              Comments

              Element Composition.status is mapped to FHIR STU3 element Composition.status as SourceIsBroaderThanTarget. The target context Composition.status is a modifier element, so this extension does not need to be defined as a modifier. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.

              Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

              Control0..1
              TypeExtension(R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown) (Extension Type: code)
              20. Composition.subject
              22. Composition.subject.extension
              Control0..*
              SlicingThis element introduces a set of slices on Composition.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 24. Composition.subject.extension:subject
                Slice Namesubject
                Definition

                R5: Composition.subject additional types from child elements (display, identifier, reference, type)

                ShortR5: subject additional types
                Comments

                Element Composition.subject is mapped to FHIR STU3 element Composition.subject as SourceIsBroaderThanTarget. The mappings for Composition.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.subject with unmapped reference targets: Resource. For clinical documents, this is usually the patient.

                Control0..*
                TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                26. Composition.encounter
                28. Composition.encounter.extension
                Control0..*
                SlicingThis element introduces a set of slices on Composition.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 30. Composition.encounter.extension:encounter
                  Slice Nameencounter
                  Definition

                  R5: Composition.encounter additional types from child elements (display, identifier, reference, type)

                  ShortR5: encounter additional types
                  Comments

                  Element Composition.encounter is mapped to FHIR STU3 element Composition.encounter as SourceIsBroaderThanTarget. The mappings for Composition.encounter do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.encounter with unmapped reference targets: Encounter.

                  Control0..1
                  TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                  32. Composition.author
                  34. Composition.author.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on Composition.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 36. Composition.author.extension:author
                    Slice Nameauthor
                    Definition

                    R5: Composition.author

                    ShortR5: author
                    Comments

                    Element Composition.author is mapped to FHIR STU3 element Composition.author as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.author with unmapped reference targets: Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.

                    Control0..*
                    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                    38. Composition.attester
                    40. Composition.attester.mode
                    42. Composition.attester.mode.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on Composition.attester.mode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 44. Composition.attester.mode.extension:mode
                      Slice Namemode
                      Definition

                      R5: Composition.attester.mode additional types (CodeableConcept) additional types from child elements (coding)

                      ShortR5: mode additional types
                      Comments

                      Element Composition.attester.mode is mapped to FHIR STU3 element Composition.attester.mode as RelatedTo. The mappings for Composition.attester.mode do not cover the following types: CodeableConcept. The mappings for Composition.attester.mode do not cover the following types based on type expansion: coding.

                      Control0..1
                      TypeExtension(R5: mode additional types) (Extension Type: CodeableConcept)
                      46. Composition.attester.party
                      48. Composition.attester.party.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on Composition.attester.party.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 50. Composition.attester.party.extension:party
                        Slice Nameparty
                        Definition

                        R5: Composition.attester.party

                        ShortR5: party
                        Comments

                        Element Composition.attester.party is mapped to FHIR STU3 element Composition.attester.party as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.attester.party with unmapped reference targets: Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.

                        Control0..1
                        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                        52. Composition.custodian
                        54. Composition.custodian.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on Composition.custodian.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 56. Composition.custodian.extension:custodian
                          Slice Namecustodian
                          Definition

                          R5: Composition.custodian additional types from child elements (display, identifier, reference, type)

                          ShortR5: custodian additional types
                          Comments

                          Element Composition.custodian is mapped to FHIR STU3 element Composition.custodian as SourceIsBroaderThanTarget. The mappings for Composition.custodian do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.custodian with unmapped reference targets: Organization. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.

                          Control0..1
                          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                          58. Composition.event
                          60. Composition.event.detail
                          62. Composition.event.detail.extension
                          Control0..*
                          SlicingThis element introduces a set of slices on Composition.event.detail.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 64. Composition.event.detail.extension:detail
                            Slice Namedetail
                            Definition

                            R5: Composition.event.detail additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Resource)) additional types from child elements (concept)

                            ShortR5: The event(s) being documented, as code(s), reference(s), or both additional types
                            Comments

                            Element Composition.event.detail is mapped to FHIR STU3 element Composition.event.detail as SourceIsBroaderThanTarget. The mappings for Composition.event.detail do not cover the following types: CodeableReference. The mappings for Composition.event.detail do not cover the following types based on type expansion: concept. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.

                            Control0..*
                            TypeExtension(R5: The event(s) being documented, as code(s), reference(s), or both additional types) (Extension Type: CodeableConcept)
                            66. Composition.section
                            68. Composition.section.extension
                            Control0..*
                            SlicingThis element introduces a set of slices on Composition.section.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 70. Composition.section.extension:author
                              Slice Nameauthor
                              Definition

                              R5: Composition.section.author (new:Reference(Practitioner,PractitionerRole,Device,Patient,RelatedPerson,Organization))

                              ShortR5: Who and/or what authored the section (new)
                              Comments

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

                              Control0..*
                              TypeExtension(R5: Who and/or what authored the section (new)) (Extension Type: Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization))
                              72. Composition.section.extension:focus
                              Slice Namefocus
                              Definition

                              R5: Composition.section.focus (new:Reference(Resource))

                              ShortR5: Who/what the section is about, when it is not about the subject of composition (new)
                              Comments

                              Element Composition.section.focus has a context of Composition.section based on following the parent source element upwards and mapping to Composition. Element Composition.section.focus has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.

                              Control0..1
                              TypeExtension(R5: Who/what the section is about, when it is not about the subject of composition (new)) (Extension Type: Reference(Cross-version Profile for R5.Resource for use in FHIR STU3, Resource))
                              74. Composition.section.entry
                              76. Composition.section.entry.extension
                              Control0..*
                              SlicingThis element introduces a set of slices on Composition.section.entry.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 78. Composition.section.entry.extension:entry
                                Slice Nameentry
                                Definition

                                R5: Composition.section.entry additional types from child elements (display, identifier, reference, type)

                                ShortR5: entry additional types
                                Comments

                                Element Composition.section.entry is mapped to FHIR STU3 element Composition.section.entry as SourceIsBroaderThanTarget. The mappings for Composition.section.entry do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.section.entry with unmapped reference targets: Resource. If there are no entries in the list, an emptyReason SHOULD be provided.

                                Control0..*
                                TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)

                                Guidance on how to interpret the contents of this table can be foundhere

                                0. Composition
                                Definition

                                A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

                                ShortA set of resources composed into a single coherent clinical statement with clinical attestation
                                Comments

                                While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

                                Control0..*
                                Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
                                dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                                dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
                                2. Composition.id
                                Definition

                                The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                                ShortLogical id of this artifact
                                Comments

                                The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                                Control0..1
                                Typeid
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                4. Composition.meta
                                Definition

                                The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

                                ShortMetadata about the resource
                                Control0..1
                                TypeMeta
                                Summarytrue
                                6. Composition.implicitRules
                                Definition

                                A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

                                ShortA set of rules under which this content was created
                                Comments

                                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.

                                This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

                                Control0..1
                                Typeuri
                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                8. Composition.language
                                Definition

                                The base language in which the resource is written.

                                ShortLanguage of the resource content
                                Comments

                                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).

                                Control0..1
                                BindingUnless not suitable, these codes SHALL be taken from Common Languages .
                                (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

                                A human language.

                                Additional BindingsPurpose
                                All LanguagesMax Binding
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                10. Composition.text
                                Definition

                                A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                                ShortText summary of the resource, for human interpretation
                                Comments

                                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 in formation is added later.

                                Control0..1
                                This element is affected by the following invariants: dom-1
                                TypeNarrative
                                Alternate Namesnarrative, html, xhtml, display
                                12. Composition.contained
                                Definition

                                These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                                ShortContained, inline Resources
                                Comments

                                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.

                                Control0..*
                                TypeResource
                                Alternate Namesinline resources, anonymous resources, contained resources
                                14. Composition.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                SlicingThis element introduces a set of slices on Composition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 16. Composition.extension:url
                                  Slice Nameurl
                                  Definition

                                  R5: Composition.url (new:uri)

                                  ShortR5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
                                  Comments

                                  Element Composition.url has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.url has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)) (Extension Type: uri)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  18. Composition.extension:version
                                  Slice Nameversion
                                  Definition

                                  R5: Composition.version (new:string)

                                  ShortR5: An explicitly assigned identifer of a variation of the content in the Composition (new)
                                  Comments

                                  Element Composition.version has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.version has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the Composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(R5: An explicitly assigned identifer of a variation of the content in the Composition (new)) (Extension Type: string)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  20. Composition.extension:useContext
                                  Slice NameuseContext
                                  Definition

                                  R5: Composition.useContext (new:UsageContext)

                                  ShortR5: The context that the content is intended to support (new)
                                  Comments

                                  Element Composition.useContext has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.useContext has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

                                  Control0..*
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(R5: The context that the content is intended to support (new)) (Complex Extension)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  22. Composition.extension:name
                                  Slice Namename
                                  Definition

                                  R5: Composition.name (new:string)

                                  ShortR5: Name for this Composition (computer friendly) (new)
                                  Comments

                                  Element Composition.name has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.name has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

                                  Control0..1
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(R5: Name for this Composition (computer friendly) (new)) (Extension Type: string)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  24. Composition.extension:note
                                  Slice Namenote
                                  Definition

                                  R5: Composition.note (new:Annotation)

                                  ShortR5: For any additional notes (new)
                                  Comments

                                  Element Composition.note has a context of Composition based on following the parent source element upwards and mapping to Composition. Element Composition.note has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). A comment, general note or annotation not coded elsewhere.

                                  Control0..*
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(R5: For any additional notes (new)) (Extension Type: Annotation)
                                  Is Modifierfalse
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                  26. Composition.modifierExtension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                  ShortExtensions that cannot be ignored
                                  Comments

                                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                  Alternate Namesextensions, user content
                                  28. Composition.identifier
                                  Definition

                                  Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.

                                  ShortLogical identifier of composition (version-independent)
                                  Comments

                                  See discussion in resource definition for how these relate.

                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..1
                                  TypeIdentifier
                                  Summarytrue
                                  30. Composition.status
                                  Definition

                                  The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

                                  Shortpreliminary | final | amended | entered-in-error
                                  Comments

                                  If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.

                                  Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

                                  Control1..1
                                  BindingThe codes SHALL be taken from CompositionStatus .
                                  (required to http://hl7.org/fhir/ValueSet/composition-status|3.0.2)

                                  The workflow/clinical status of the composition.

                                  Typecode
                                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need to be able to mark interim, amended, or withdrawn compositions or documents.

                                  32. Composition.status.id
                                  Definition

                                  unique id for the element within a resource (for internal references)

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  34. Composition.status.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  SlicingThis element introduces a set of slices on Composition.status.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 36. Composition.status.extension:status
                                    Slice Namestatus
                                    Definition

                                    R5: Composition.status

                                    ShortR5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
                                    Comments

                                    Element Composition.status is mapped to FHIR STU3 element Composition.status as SourceIsBroaderThanTarget. The target context Composition.status is a modifier element, so this extension does not need to be defined as a modifier. If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.

                                    Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

                                    Control0..1
                                    This element is affected by the following invariants: ele-1
                                    TypeExtension(R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown) (Extension Type: code)
                                    Is Modifierfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    38. Composition.status.value
                                    Definition

                                    Primitive value for code

                                    ShortPrimitive value for code
                                    Control0..1
                                    Typecode
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    40. Composition.type
                                    Definition

                                    Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

                                    ShortKind of composition (LOINC if possible)
                                    Comments

                                    For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.

                                    Control1..1
                                    BindingThe codes SHOULD be taken from FHIR Document Type Codes
                                    (preferred to http://hl7.org/fhir/ValueSet/doc-typecodes|3.0.2)

                                    Type of a composition.

                                    TypeCodeableConcept
                                    Summarytrue
                                    Requirements

                                    Key metadata element describing the composition, used in searching/filtering.

                                    42. Composition.class
                                    Definition

                                    A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

                                    ShortCategorization of Composition
                                    Comments

                                    This is a metadata field from XDS/MHD.

                                    Control0..1
                                    BindingFor example codes, see FHIR Document Class Codes
                                    (example to http://hl7.org/fhir/ValueSet/doc-classcodes|3.0.2)

                                    High-level kind of a clinical document at a macro level.

                                    TypeCodeableConcept
                                    Summarytrue
                                    Requirements

                                    Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.

                                    44. Composition.subject
                                    Definition

                                    Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

                                    ShortWho and/or what the composition is about
                                    Comments

                                    For clinical documents, this is usually the patient.

                                    Control1..1
                                    TypeReference(Resource)
                                    Summarytrue
                                    Requirements

                                    Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.

                                    46. Composition.subject.id
                                    Definition

                                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                    Shortxml:id (or equivalent in JSON)
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    48. Composition.subject.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..*
                                    TypeExtension
                                    SlicingThis element introduces a set of slices on Composition.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 50. Composition.subject.extension:subject
                                      Slice Namesubject
                                      Definition

                                      R5: Composition.subject additional types from child elements (display, identifier, reference, type)

                                      ShortR5: subject additional types
                                      Comments

                                      Element Composition.subject is mapped to FHIR STU3 element Composition.subject as SourceIsBroaderThanTarget. The mappings for Composition.subject do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.subject with unmapped reference targets: Resource. For clinical documents, this is usually the patient.

                                      Control0..*
                                      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                      52. Composition.subject.reference
                                      Definition

                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                      ShortLiteral reference, Relative, internal or absolute URL
                                      Comments

                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                      Control0..1
                                      This element is affected by the following invariants: ref-1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      54. Composition.subject.identifier
                                      Definition

                                      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                      ShortLogical reference, when literal reference is not known
                                      Comments

                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      TypeIdentifier
                                      Summarytrue
                                      56. Composition.subject.display
                                      Definition

                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                      ShortText alternative for the resource
                                      Comments

                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      58. Composition.encounter
                                      Definition

                                      Describes the clinical encounter or type of care this documentation is associated with.

                                      ShortContext of the Composition
                                      Control0..1
                                      TypeReference(Encounter)
                                      Summarytrue
                                      Requirements

                                      Provides context for the composition and supports searching.

                                      60. Composition.encounter.id
                                      Definition

                                      unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      62. Composition.encounter.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      SlicingThis element introduces a set of slices on Composition.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 64. Composition.encounter.extension:encounter
                                        Slice Nameencounter
                                        Definition

                                        R5: Composition.encounter additional types from child elements (display, identifier, reference, type)

                                        ShortR5: encounter additional types
                                        Comments

                                        Element Composition.encounter is mapped to FHIR STU3 element Composition.encounter as SourceIsBroaderThanTarget. The mappings for Composition.encounter do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.encounter with unmapped reference targets: Encounter.

                                        Control0..1
                                        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                        66. Composition.encounter.reference
                                        Definition

                                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                        ShortLiteral reference, Relative, internal or absolute URL
                                        Comments

                                        Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                        Control0..1
                                        This element is affected by the following invariants: ref-1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        68. Composition.encounter.identifier
                                        Definition

                                        An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                        ShortLogical reference, when literal reference is not known
                                        Comments

                                        When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                        When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..1
                                        TypeIdentifier
                                        Summarytrue
                                        70. Composition.encounter.display
                                        Definition

                                        Plain text narrative that identifies the resource in addition to the resource reference.

                                        ShortText alternative for the resource
                                        Comments

                                        This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        72. Composition.date
                                        Definition

                                        The composition editing time, when the composition was last logically changed by the author.

                                        ShortComposition editing time
                                        Comments

                                        The Last Modified Date on the composition may be after the date of the document was attested without being changed.

                                        Control1..1
                                        TypedateTime
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        dateTime is used for tracking, organizing versions and searching.

                                        74. Composition.author
                                        Definition

                                        Identifies who is responsible for the information in the composition, not necessarily who typed it in.

                                        ShortWho and/or what authored the composition
                                        Control1..*
                                        TypeReference(Practitioner, Device, Patient, RelatedPerson)
                                        Summarytrue
                                        Requirements

                                        Identifies who is responsible for the content.

                                        76. Composition.author.id
                                        Definition

                                        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        Shortxml:id (or equivalent in JSON)
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        78. Composition.author.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        SlicingThis element introduces a set of slices on Composition.author.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 80. Composition.author.extension:author
                                          Slice Nameauthor
                                          Definition

                                          R5: Composition.author

                                          ShortR5: author
                                          Comments

                                          Element Composition.author is mapped to FHIR STU3 element Composition.author as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.author with unmapped reference targets: Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.

                                          Control0..*
                                          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                          82. Composition.author.reference
                                          Definition

                                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                          ShortLiteral reference, Relative, internal or absolute URL
                                          Comments

                                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                          Control0..1
                                          This element is affected by the following invariants: ref-1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          84. Composition.author.identifier
                                          Definition

                                          An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                          ShortLogical reference, when literal reference is not known
                                          Comments

                                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          TypeIdentifier
                                          Summarytrue
                                          86. Composition.author.display
                                          Definition

                                          Plain text narrative that identifies the resource in addition to the resource reference.

                                          ShortText alternative for the resource
                                          Comments

                                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          88. Composition.title
                                          Definition

                                          Official human-readable label for the composition.

                                          ShortHuman Readable name/title
                                          Comments

                                          For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.

                                          Control1..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          90. Composition.confidentiality
                                          Definition

                                          The code specifying the level of confidentiality of the Composition.

                                          ShortAs defined by affinity domain
                                          Comments

                                          The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).

                                          This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

                                          Control0..1
                                          BindingThe codes SHALL be taken from ConfidentialityClassification|2014-03-26
                                          (required to http://hl7.org/fhir/ValueSet/v3-ConfidentialityClassification|2014-03-26)

                                          Codes specifying the level of confidentiality of the composition.

                                          Typecode
                                          Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          92. Composition.attester
                                          Definition

                                          A participant who has attested to the accuracy of the composition/document.

                                          ShortAttests to accuracy of composition
                                          Comments

                                          Only list each attester once.

                                          Control0..*
                                          TypeBackboneElement
                                          Summarytrue
                                          Requirements

                                          Identifies responsibility for the accuracy of the composition content.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                          94. Composition.attester.id
                                          Definition

                                          unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                          Shortxml:id (or equivalent in JSON)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          96. Composition.attester.extension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                          ShortAdditional Content defined by implementations
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                          Control0..*
                                          TypeExtension
                                          Alternate Namesextensions, user content
                                          98. Composition.attester.modifierExtension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                          ShortExtensions that cannot be ignored
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                          Control0..*
                                          TypeExtension
                                          Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                          Summarytrue
                                          Alternate Namesextensions, user content, modifiers
                                          100. Composition.attester.mode
                                          Definition

                                          The type of attestation the authenticator offers.

                                          Shortpersonal | professional | legal | official
                                          Comments

                                          Use more than one code where a single attester has more than one mode (professional and legal are often paired).

                                          Control1..*
                                          BindingThe codes SHALL be taken from CompositionAttestationMode
                                          (required to http://hl7.org/fhir/ValueSet/composition-attestation-mode|3.0.2)

                                          The way in which a person authenticated a composition.

                                          Typecode
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          Indicates the level of authority of the attestation.

                                          102. Composition.attester.mode.id
                                          Definition

                                          unique id for the element within a resource (for internal references)

                                          Shortxml:id (or equivalent in JSON)
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          104. Composition.attester.mode.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..*
                                          TypeExtension
                                          SlicingThis element introduces a set of slices on Composition.attester.mode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 106. Composition.attester.mode.extension:mode
                                            Slice Namemode
                                            Definition

                                            R5: Composition.attester.mode additional types (CodeableConcept) additional types from child elements (coding)

                                            ShortR5: mode additional types
                                            Comments

                                            Element Composition.attester.mode is mapped to FHIR STU3 element Composition.attester.mode as RelatedTo. The mappings for Composition.attester.mode do not cover the following types: CodeableConcept. The mappings for Composition.attester.mode do not cover the following types based on type expansion: coding.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(R5: mode additional types) (Extension Type: CodeableConcept)
                                            Is Modifierfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            108. Composition.attester.mode.value
                                            Definition

                                            Primitive value for code

                                            ShortPrimitive value for code
                                            Control0..1
                                            Typecode
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            110. Composition.attester.time
                                            Definition

                                            When the composition was attested by the party.

                                            ShortWhen the composition was attested
                                            Control0..1
                                            TypedateTime
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

                                            112. Composition.attester.party
                                            Definition

                                            Who attested the composition in the specified way.

                                            ShortWho attested the composition
                                            Control0..1
                                            TypeReference(Patient, Practitioner, Organization)
                                            Summarytrue
                                            Requirements

                                            Identifies who has taken on the responsibility for accuracy of the composition content.

                                            114. Composition.attester.party.id
                                            Definition

                                            unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                            Shortxml:id (or equivalent in JSON)
                                            Control0..1
                                            Typestring
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            116. Composition.attester.party.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            SlicingThis element introduces a set of slices on Composition.attester.party.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 118. Composition.attester.party.extension:party
                                              Slice Nameparty
                                              Definition

                                              R5: Composition.attester.party

                                              ShortR5: party
                                              Comments

                                              Element Composition.attester.party is mapped to FHIR STU3 element Composition.attester.party as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.attester.party with unmapped reference targets: Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.

                                              Control0..1
                                              TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                              120. Composition.attester.party.reference
                                              Definition

                                              A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                              ShortLiteral reference, Relative, internal or absolute URL
                                              Comments

                                              Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                              Control0..1
                                              This element is affected by the following invariants: ref-1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              122. Composition.attester.party.identifier
                                              Definition

                                              An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                              ShortLogical reference, when literal reference is not known
                                              Comments

                                              When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                              When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                              Control0..1
                                              TypeIdentifier
                                              Summarytrue
                                              124. Composition.attester.party.display
                                              Definition

                                              Plain text narrative that identifies the resource in addition to the resource reference.

                                              ShortText alternative for the resource
                                              Comments

                                              This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                              Control0..1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              126. Composition.custodian
                                              Definition

                                              Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

                                              ShortOrganization which maintains the composition
                                              Comments

                                              This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.

                                              Control0..1
                                              TypeReference(Organization)
                                              Summarytrue
                                              Requirements

                                              Identifies where to go to find the current version, where to report issues, etc.

                                              128. Composition.custodian.id
                                              Definition

                                              unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                              Shortxml:id (or equivalent in JSON)
                                              Control0..1
                                              Typestring
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              130. Composition.custodian.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              SlicingThis element introduces a set of slices on Composition.custodian.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 132. Composition.custodian.extension:custodian
                                                Slice Namecustodian
                                                Definition

                                                R5: Composition.custodian additional types from child elements (display, identifier, reference, type)

                                                ShortR5: custodian additional types
                                                Comments

                                                Element Composition.custodian is mapped to FHIR STU3 element Composition.custodian as SourceIsBroaderThanTarget. The mappings for Composition.custodian do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.custodian with unmapped reference targets: Organization. This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.

                                                Control0..1
                                                TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                                134. Composition.custodian.reference
                                                Definition

                                                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                ShortLiteral reference, Relative, internal or absolute URL
                                                Comments

                                                Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                Control0..1
                                                This element is affected by the following invariants: ref-1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                136. Composition.custodian.identifier
                                                Definition

                                                An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                ShortLogical reference, when literal reference is not known
                                                Comments

                                                When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..1
                                                TypeIdentifier
                                                Summarytrue
                                                138. Composition.custodian.display
                                                Definition

                                                Plain text narrative that identifies the resource in addition to the resource reference.

                                                ShortText alternative for the resource
                                                Comments

                                                This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                140. Composition.relatesTo
                                                Definition

                                                Relationships that this composition has with other compositions or documents that already exist.

                                                ShortRelationships to other compositions/documents
                                                Comments

                                                A document is a version specific composition.

                                                Control0..*
                                                TypeBackboneElement
                                                Summarytrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                142. Composition.relatesTo.id
                                                Definition

                                                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                144. Composition.relatesTo.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                ShortAdditional Content defined by implementations
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..*
                                                TypeExtension
                                                Alternate Namesextensions, user content
                                                146. Composition.relatesTo.modifierExtension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                ShortExtensions that cannot be ignored
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                                Summarytrue
                                                Alternate Namesextensions, user content, modifiers
                                                148. Composition.relatesTo.code
                                                Definition

                                                The type of relationship that this composition has with anther composition or document.

                                                Shortreplaces | transforms | signs | appends
                                                Comments

                                                If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

                                                Control1..1
                                                BindingThe codes SHALL be taken from DocumentRelationshipType .
                                                (required to http://hl7.org/fhir/ValueSet/document-relationship-type|3.0.2)

                                                The type of relationship between documents.

                                                Typecode
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summarytrue
                                                150. Composition.relatesTo.target[x]
                                                Definition

                                                The target composition/document of this relationship.

                                                ShortTarget of the relationship
                                                Control1..1
                                                TypeChoice of: Identifier, Reference(Composition)
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Summarytrue
                                                152. Composition.event
                                                Definition

                                                The clinical service, such as a colonoscopy or an appendectomy, being documented.

                                                ShortThe clinical service(s) being documented
                                                Comments

                                                The event needs to be consistent with the type element, though can provide further information if desired.

                                                Control0..*
                                                TypeBackboneElement
                                                Summarytrue
                                                Requirements

                                                Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                154. Composition.event.id
                                                Definition

                                                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                156. Composition.event.extension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                                ShortAdditional Content defined by implementations
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..*
                                                TypeExtension
                                                Alternate Namesextensions, user content
                                                158. Composition.event.modifierExtension
                                                Definition

                                                May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                ShortExtensions that cannot be ignored
                                                Comments

                                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                Control0..*
                                                TypeExtension
                                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                                Summarytrue
                                                Alternate Namesextensions, user content, modifiers
                                                160. Composition.event.code
                                                Definition

                                                This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

                                                ShortCode(s) that apply to the event being documented
                                                Comments

                                                An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.

                                                Control0..*
                                                BindingFor example codes, see ActCode|2016-11-11
                                                (example to http://hl7.org/fhir/ValueSet/v3-ActCode|2016-11-11)

                                                This list of codes represents the main clinical acts being documented.

                                                TypeCodeableConcept
                                                Summarytrue
                                                162. Composition.event.period
                                                Definition

                                                The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.

                                                ShortThe period covered by the documentation
                                                Control0..1
                                                TypePeriod
                                                Summarytrue
                                                164. Composition.event.detail
                                                Definition

                                                The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.

                                                ShortThe event(s) being documented
                                                Control0..*
                                                TypeReference(Resource)
                                                Summarytrue
                                                166. Composition.event.detail.id
                                                Definition

                                                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                Shortxml:id (or equivalent in JSON)
                                                Control0..1
                                                Typestring
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                168. Composition.event.detail.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..*
                                                TypeExtension
                                                SlicingThis element introduces a set of slices on Composition.event.detail.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 170. Composition.event.detail.extension:detail
                                                  Slice Namedetail
                                                  Definition

                                                  R5: Composition.event.detail additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/Resource)) additional types from child elements (concept)

                                                  ShortR5: The event(s) being documented, as code(s), reference(s), or both additional types
                                                  Comments

                                                  Element Composition.event.detail is mapped to FHIR STU3 element Composition.event.detail as SourceIsBroaderThanTarget. The mappings for Composition.event.detail do not cover the following types: CodeableReference. The mappings for Composition.event.detail do not cover the following types based on type expansion: concept. An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more events are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.

                                                  Control0..*
                                                  TypeExtension(R5: The event(s) being documented, as code(s), reference(s), or both additional types) (Extension Type: CodeableConcept)
                                                  172. Composition.event.detail.reference
                                                  Definition

                                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                  ShortLiteral reference, Relative, internal or absolute URL
                                                  Comments

                                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                  Control0..1
                                                  This element is affected by the following invariants: ref-1
                                                  Typestring
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  174. Composition.event.detail.identifier
                                                  Definition

                                                  An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                  ShortLogical reference, when literal reference is not known
                                                  Comments

                                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                  Control0..1
                                                  TypeIdentifier
                                                  Summarytrue
                                                  176. Composition.event.detail.display
                                                  Definition

                                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                                  ShortText alternative for the resource
                                                  Comments

                                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                  Control0..1
                                                  Typestring
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  178. Composition.section
                                                  Definition

                                                  The root of the sections that make up the composition.

                                                  ShortComposition is broken into sections
                                                  Control0..*
                                                  TypeBackboneElement
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                  cmp-1: A section must at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists())
                                                  cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
                                                  180. Composition.section.id
                                                  Definition

                                                  unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                  Shortxml:id (or equivalent in JSON)
                                                  Control0..1
                                                  Typestring
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  182. Composition.section.extension
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control0..*
                                                  TypeExtension
                                                  SlicingThis element introduces a set of slices on Composition.section.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 184. Composition.section.extension:author
                                                    Slice Nameauthor
                                                    Definition

                                                    R5: Composition.section.author (new:Reference(Practitioner,PractitionerRole,Device,Patient,RelatedPerson,Organization))

                                                    ShortR5: Who and/or what authored the section (new)
                                                    Comments

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

                                                    Control0..*
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(R5: Who and/or what authored the section (new)) (Extension Type: Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR STU3, PractitionerRole, Cross-version Profile for R5.Device for use in FHIR STU3, Device, Cross-version Profile for R5.Patient for use in FHIR STU3, Patient, Cross-version Profile for R5.RelatedPerson for use in FHIR STU3, RelatedPerson, Cross-version Profile for R5.Organization for use in FHIR STU3, Organization))
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    186. Composition.section.extension:focus
                                                    Slice Namefocus
                                                    Definition

                                                    R5: Composition.section.focus (new:Reference(Resource))

                                                    ShortR5: Who/what the section is about, when it is not about the subject of composition (new)
                                                    Comments

                                                    Element Composition.section.focus has a context of Composition.section based on following the parent source element upwards and mapping to Composition. Element Composition.section.focus has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.

                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    TypeExtension(R5: Who/what the section is about, when it is not about the subject of composition (new)) (Extension Type: Reference(Cross-version Profile for R5.Resource for use in FHIR STU3, Resource))
                                                    Is Modifierfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    188. Composition.section.modifierExtension
                                                    Definition

                                                    May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                    ShortExtensions that cannot be ignored
                                                    Comments

                                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                                    Summarytrue
                                                    Alternate Namesextensions, user content, modifiers
                                                    190. Composition.section.title
                                                    Definition

                                                    The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.

                                                    ShortLabel for section (e.g. for ToC)
                                                    Comments

                                                    The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.

                                                    Control0..1
                                                    Typestring
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Requirements

                                                    Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

                                                    Alternate Namesheader, label, caption
                                                    192. Composition.section.code
                                                    Definition

                                                    A code identifying the kind of content contained within the section. This must be consistent with the section title.

                                                    ShortClassification of section (recommended)
                                                    Comments

                                                    The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

                                                    Control0..1
                                                    BindingFor example codes, see Document Section Codes
                                                    (example to http://hl7.org/fhir/ValueSet/doc-section-codes|3.0.2)

                                                    Classification of a section of a composition/document.

                                                    TypeCodeableConcept
                                                    Requirements

                                                    Provides computable standardized labels to topics within the document.

                                                    194. Composition.section.text
                                                    Definition

                                                    A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

                                                    ShortText summary of the section, for human interpretation
                                                    Comments

                                                    Document profiles may define what content should be represented in the narrative to ensure clinical safety.

                                                    Control0..1
                                                    This element is affected by the following invariants: cmp-1
                                                    TypeNarrative
                                                    196. Composition.section.mode
                                                    Definition

                                                    How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

                                                    Shortworking | snapshot | changes
                                                    Comments

                                                    This element is labeled as a modifier because a change list must not be mis-understood as a complete list.

                                                    Control0..1
                                                    BindingThe codes SHALL be taken from ListMode
                                                    (required to http://hl7.org/fhir/ValueSet/list-mode|3.0.2)

                                                    The processing mode that applies to this section.

                                                    Typecode
                                                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

                                                    198. Composition.section.orderedBy
                                                    Definition

                                                    Specifies the order applied to the items in the section entries.

                                                    ShortOrder of section entries
                                                    Comments

                                                    Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

                                                    Control0..1
                                                    BindingThe codes SHOULD be taken from List Order Codes
                                                    (preferred to http://hl7.org/fhir/ValueSet/list-order|3.0.2)

                                                    What order applies to the items in the entry.

                                                    TypeCodeableConcept
                                                    Requirements

                                                    Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

                                                    200. Composition.section.entry
                                                    Definition

                                                    A reference to the actual resource from which the narrative in the section is derived.

                                                    ShortA reference to data that supports this section
                                                    Comments

                                                    If there are no entries in the list, an emptyReason SHOULD be provided.

                                                    Control0..*
                                                    This element is affected by the following invariants: cmp-2
                                                    TypeReference(Resource)
                                                    202. Composition.section.entry.id
                                                    Definition

                                                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                                    Shortxml:id (or equivalent in JSON)
                                                    Control0..1
                                                    Typestring
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    204. Composition.section.entry.extension
                                                    Definition

                                                    An Extension

                                                    ShortExtension
                                                    Control0..*
                                                    TypeExtension
                                                    SlicingThis element introduces a set of slices on Composition.section.entry.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 206. Composition.section.entry.extension:entry
                                                      Slice Nameentry
                                                      Definition

                                                      R5: Composition.section.entry additional types from child elements (display, identifier, reference, type)

                                                      ShortR5: entry additional types
                                                      Comments

                                                      Element Composition.section.entry is mapped to FHIR STU3 element Composition.section.entry as SourceIsBroaderThanTarget. The mappings for Composition.section.entry do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Composition.section.entry with unmapped reference targets: Resource. If there are no entries in the list, an emptyReason SHOULD be provided.

                                                      Control0..*
                                                      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                                      208. Composition.section.entry.reference
                                                      Definition

                                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                                      ShortLiteral reference, Relative, internal or absolute URL
                                                      Comments

                                                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                                      Control0..1
                                                      This element is affected by the following invariants: ref-1
                                                      Typestring
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      210. Composition.section.entry.identifier
                                                      Definition

                                                      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                                      ShortLogical reference, when literal reference is not known
                                                      Comments

                                                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                      Control0..1
                                                      TypeIdentifier
                                                      Summarytrue
                                                      212. Composition.section.entry.display
                                                      Definition

                                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                                      ShortText alternative for the resource
                                                      Comments

                                                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                                      Control0..1
                                                      Typestring
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      214. Composition.section.emptyReason
                                                      Definition

                                                      If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

                                                      ShortWhy the section is empty
                                                      Comments

                                                      The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

                                                      Control0..1
                                                      This element is affected by the following invariants: cmp-2
                                                      BindingThe codes SHOULD be taken from List Empty Reasons
                                                      (preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|3.0.2)

                                                      If a section is empty, why it is empty.

                                                      TypeCodeableConcept
                                                      Requirements

                                                      Allows capturing things like "none exist" or "not asked" which can be important for most lists.

                                                      216. Composition.section.section
                                                      Definition

                                                      A nested sub-section within this section.

                                                      ShortNested Section
                                                      Comments

                                                      Nested sections are primarily used to help human readers navigate to particular portions of the document.

                                                      Control0..*
                                                      This element is affected by the following invariants: cmp-1
                                                      TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section