Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot3 - STU 1 Ballot 3 World

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: Guideline - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the guideline resource profile

See the documentation on how to interpret the contents of this table

0. Composition
Definition

Composition provides the structural backbone for assembling a set of healthcare-related information into a single logical package that provides a single coherent statement of meaning, establishes its own context and has traceability to the author who is making the statement.

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..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Composition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. Composition.extension:versionAlgorithm
Slice NameversionAlgorithm
Definition

Indicates the mechanism used to compare versions to determine which is more current.

ShortHow to compare versions
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Control0..1
TypeExtension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Composition.extension:experimental
Slice Nameexperimental
Definition

A Boolean value to indicate that this artifact is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

ShortFor testing purposes, not real usage
Control0..1
TypeExtension(Artifact Experimental) (Extension Type: boolean)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Composition.extension:description
Slice Namedescription
Definition

A free text natural language description of the artifact from a consumer's perspective.

ShortNatural language description of the artifact
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).

Control0..1
TypeExtension(Artifact Description) (Extension Type: markdown)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Composition.extension:purpose
Slice Namepurpose
Definition

Explanation of why this artifact is needed and why it has been designed as it has.

ShortWhy this artifact is defined
Comments

This element does not describe the usage of the artifact. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this artifact.

Control0..1
TypeExtension(Artifact Purpose) (Extension Type: markdown)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Composition.extension:copyright
Slice Namecopyright
Definition

A copyright statement relating to the artifact and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact.

ShortUse and/or publishing restrictions
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

Control0..1
TypeExtension(Artifact Copyright) (Extension Type: markdown)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Composition.extension:copyrightLabel
Slice NamecopyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

ShortCopyright holder and year(s)
Comments

Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Control0..1
TypeExtension(Artifact Copyright Label) (Extension Type: string)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Composition.extension:approvalDate
Slice NameapprovalDate
Definition

The date on which the artifact content was approved by the publisher. Approval happens once when the content is officially approved for usage.

ShortWhen the artifact was approved by publisher
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Control0..1
TypeExtension(Artifact Approval Date) (Extension Type: date)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Composition.extension:lastReviewDate
Slice NamelastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

ShortWhen the artifact was approved by publisher
Comments

If specified, this date follows the original approval date.

Control0..1
TypeExtension(Artifact Last Review Date) (Extension Type: date)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Composition.extension:effectivePeriod
Slice NameeffectivePeriod
Definition

The period during which the artifact content was or is planned to be in active use.

ShortWhen the artifact is expected to be used
Comments

The effective period for an artifact determines when the content is applicable for usage and is independent of publication and review dates. For example, an artifact intended to be used for the year 2016 might be published in 2015.

Control0..1
TypeExtension(Artifact Effective Period) (Extension Type: Period)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Composition.extension:additionalLanguage
Slice NameadditionalLanguage
Definition

The Resource contains content in a language additional to the one in the language element.

ShortThe additional language
Control0..*
TypeExtension(Additional Language) (Extension Type: code)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Composition.extension:extendedContactDetail
Slice NameextendedContactDetail
Definition

Contact details to assist a user in finding and communicating with the publisher.

ShortContact details for the publisher
Comments

May be a web site, an email address, a physical address, a telephone number, etc.

Control0..*
TypeExtension(Artifact Extended Contact Detail) (Extension Type: ExtendedContactDetail)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Composition.extension:publicationDate
Slice NamepublicationDate
Definition

Specifies the publication date of the Resource.

ShortPublication date of Resource
Control0..1
TypeExtension(Publication Date) (Extension Type: date)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Composition.extension:publicationStatus
Slice NamepublicationStatus
Definition

The status of the processing for making the artifact publicly available, not necessarily the same as artifact status (Resource.status).

ShortPublication status
Control0..1
TypeExtension(ArtifactPublicationStatus) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Composition.extension:registrationStatus
Slice NameregistrationStatus
Definition

Starting and/or ending dates for an activity related to inclusion of a guideline in a registry.

ShortDates for a guideline registration activity
Control0..*
TypeExtension(GuidelineRegistration) (Complex Extension)
Is Modifierfalse
Must Supportfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
36. Composition.status
Definition

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

Shortregistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Comments

See section 2.8.3.2, The workflow/clinical status of the composition, for guidance. Because the entered-in-error flag changes how this resource and its related elements must be interpreted, status is labeled as a modifier element. Some reporting workflows 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 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 CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|6.0.0-snapshot1
(required to http://hl7.org/fhir/ValueSet/composition-status|6.0.0-snapshot1)

The workflow status of the composition.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. 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 FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes|6.0.0-snapshot1
(preferred to http://hl7.org/fhir/ValueSet/doc-typecodes|6.0.0-snapshot1)

Type of a composition.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Composition.type.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control10..1*
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "Guideline",
  "display" : "Guideline"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="Guideline"/>
  <display value="Guideline"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. 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 the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.

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

dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring this version of the Composition. When packaged in a document, Bundle.timestamp is the date of packaging.

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

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

46. Composition.relatesTo.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
50. Composition.relatesTo.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Composition.relatesTo.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Composition.relatesTo:citeAs
Slice NameciteAs
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..1*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
56. Composition.relatesTo:citeAs.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Composition.relatesTo:citeAs.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
60. Composition.relatesTo:citeAs.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "cite-as"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="cite-as"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Composition.relatesTo:citeAs.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Composition.relatesTo:partOf
Slice NamepartOf
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
66. Composition.relatesTo:partOf.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Composition.relatesTo:partOf.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
70. Composition.relatesTo:partOf.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "part-of"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="part-of"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Composition.relatesTo:partOf.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Composition.relatesTo:derivedFrom
Slice NamederivedFrom
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
76. Composition.relatesTo:derivedFrom.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Composition.relatesTo:derivedFrom.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
80. Composition.relatesTo:derivedFrom.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "derived-from"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="derived-from"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. Composition.relatesTo:derivedFrom.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Composition.relatesTo:specificationOf
Slice NamespecificationOf
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
86. Composition.relatesTo:specificationOf.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Composition.relatesTo:specificationOf.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
90. Composition.relatesTo:specificationOf.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "specification-of"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="specification-of"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Composition.relatesTo:specificationOf.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Composition.relatesTo:dependsOn
Slice NamedependsOn
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
96. Composition.relatesTo:dependsOn.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Composition.relatesTo:dependsOn.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
100. Composition.relatesTo:dependsOn.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "depends-on"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="depends-on"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Composition.relatesTo:dependsOn.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Composition.relatesTo:supportedWith
Slice NamesupportedWith
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
106. Composition.relatesTo:supportedWith.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Composition.relatesTo:supportedWith.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
110. Composition.relatesTo:supportedWith.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "supported-with"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="supported-with"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Composition.relatesTo:supportedWith.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. Composition.relatesTo:similarTo
Slice NamesimilarTo
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
116. Composition.relatesTo:similarTo.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Composition.relatesTo:similarTo.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
120. Composition.relatesTo:similarTo.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Typehttp://terminology.hl7.org/ValueSet/artifact-relationship-type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "similar-to"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="similar-to"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. Composition.relatesTo:similarTo.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Composition.section
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ code.coding

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

126. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
128. 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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
130. 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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
132. Composition.section:summary
Slice Namesummary
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
134. Composition.section:summary.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
136. Composition.section:summary.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Composition.section:summary.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Composition.section:introduction
Slice Nameintroduction
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
142. Composition.section:introduction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
144. Composition.section:introduction.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. Composition.section:introduction.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. Composition.section:discussion
Slice Namediscussion
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
150. Composition.section:discussion.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
152. Composition.section:discussion.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. Composition.section:discussion.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. Composition.section:methods
Slice Namemethods
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
158. Composition.section:methods.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
160. Composition.section:methods.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. Composition.section:methods.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. Composition.section:references
Slice Namereferences
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
166. Composition.section:references.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
168. Composition.section:references.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. Composition.section:references.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-1, cmp-2
TypeReference(PublicationRecord, Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. Composition.section:competingInterests
Slice NamecompetingInterests
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
174. Composition.section:competingInterests.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
176. Composition.section:competingInterests.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. Composition.section:competingInterests.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. Composition.section:acknowledgements
Slice Nameacknowledgements
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
182. Composition.section:acknowledgements.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
184. Composition.section:acknowledgements.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. Composition.section:acknowledgements.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. Composition.section:appendices
Slice Nameappendices
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
190. Composition.section:appendices.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
192. Composition.section:appendices.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. Composition.section:appendices.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. Composition.section:attachments
Slice Nameattachments
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
198. Composition.section:attachments.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
200. Composition.section:attachments.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
202. Composition.section:attachments.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-1, cmp-2
TypeReference(DocumentReference, Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. Composition.section:recommendations
Slice Namerecommendations
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
206. Composition.section:recommendations.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
208. Composition.section:recommendations.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. Composition.section:recommendations.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-1, cmp-2
TypeReference(Recommendation, Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

See the documentation on how to interpret the contents of this table

0. Composition
2. Composition.extension:registrationStatus
Slice NameregistrationStatus
Control0..*
TypeExtension(GuidelineRegistration) (Complex Extension)
4. Composition.type
6. Composition.type.coding
Control1..1
Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "Guideline",
  "display" : "Guideline"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="Guideline"/>
  <display value="Guideline"/>
</coding>
8. Composition.section:recommendations
Slice Namerecommendations
Control0..1
Must Supporttrue
10. Composition.section:recommendations.code
12. Composition.section:recommendations.code.coding
Control1..1
Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "recommendations",
  "display" : "Recommendations"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="recommendations"/>
  <display value="Recommendations"/>
</coding>
14. Composition.section:recommendations.entry
TypeReference(Recommendation)

See the documentation on how to interpret the contents of this table

0. Composition
Definition

Composition provides the structural backbone for assembling a set of healthcare-related information into a single logical package that provides a single coherent statement of meaning, establishes its own context and has traceability to the author who is making the statement.

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..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
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

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. Composition.meta
Definition

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

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the additionalImplicitRules extension.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-snapshot1)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Composition.text
Definition

A human-readable narrative that contains a summary of the resource and can 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 a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Composition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Composition.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
16. Composition.extension:versionAlgorithm
Slice NameversionAlgorithm
Definition

Indicates the mechanism used to compare versions to determine which is more current.

ShortHow to compare versions
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Control0..1
TypeExtension(Artifact Version Algorithm) (Extension Type: Choice of: string, Coding)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Composition.extension:experimental
Slice Nameexperimental
Definition

A Boolean value to indicate that this artifact is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

ShortFor testing purposes, not real usage
Control0..1
TypeExtension(Artifact Experimental) (Extension Type: boolean)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Composition.extension:description
Slice Namedescription
Definition

A free text natural language description of the artifact from a consumer's perspective.

ShortNatural language description of the artifact
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the artifact as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the artifact is presumed to be the predominant language in the place the artifact was created).

Control0..1
TypeExtension(Artifact Description) (Extension Type: markdown)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Composition.extension:purpose
Slice Namepurpose
Definition

Explanation of why this artifact is needed and why it has been designed as it has.

ShortWhy this artifact is defined
Comments

This element does not describe the usage of the artifact. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this artifact.

Control0..1
TypeExtension(Artifact Purpose) (Extension Type: markdown)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Composition.extension:copyright
Slice Namecopyright
Definition

A copyright statement relating to the artifact and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the artifact.

ShortUse and/or publishing restrictions
Comments

The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.

Control0..1
TypeExtension(Artifact Copyright) (Extension Type: markdown)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Composition.extension:copyrightLabel
Slice NamecopyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

ShortCopyright holder and year(s)
Comments

Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It is expected to be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Control0..1
TypeExtension(Artifact Copyright Label) (Extension Type: string)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Composition.extension:approvalDate
Slice NameapprovalDate
Definition

The date on which the artifact content was approved by the publisher. Approval happens once when the content is officially approved for usage.

ShortWhen the artifact was approved by publisher
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Control0..1
TypeExtension(Artifact Approval Date) (Extension Type: date)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Composition.extension:lastReviewDate
Slice NamelastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

ShortWhen the artifact was approved by publisher
Comments

If specified, this date follows the original approval date.

Control0..1
TypeExtension(Artifact Last Review Date) (Extension Type: date)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Composition.extension:effectivePeriod
Slice NameeffectivePeriod
Definition

The period during which the artifact content was or is planned to be in active use.

ShortWhen the artifact is expected to be used
Comments

The effective period for an artifact determines when the content is applicable for usage and is independent of publication and review dates. For example, an artifact intended to be used for the year 2016 might be published in 2015.

Control0..1
TypeExtension(Artifact Effective Period) (Extension Type: Period)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Composition.extension:additionalLanguage
Slice NameadditionalLanguage
Definition

The Resource contains content in a language additional to the one in the language element.

ShortThe additional language
Control0..*
TypeExtension(Additional Language) (Extension Type: code)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Composition.extension:extendedContactDetail
Slice NameextendedContactDetail
Definition

Contact details to assist a user in finding and communicating with the publisher.

ShortContact details for the publisher
Comments

May be a web site, an email address, a physical address, a telephone number, etc.

Control0..*
TypeExtension(Artifact Extended Contact Detail) (Extension Type: ExtendedContactDetail)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Composition.extension:publicationDate
Slice NamepublicationDate
Definition

Specifies the publication date of the Resource.

ShortPublication date of Resource
Control0..1
TypeExtension(Publication Date) (Extension Type: date)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Composition.extension:publicationStatus
Slice NamepublicationStatus
Definition

The status of the processing for making the artifact publicly available, not necessarily the same as artifact status (Resource.status).

ShortPublication status
Control0..1
TypeExtension(ArtifactPublicationStatus) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Composition.extension:registrationStatus
Slice NameregistrationStatus
Definition

Starting and/or ending dates for an activity related to inclusion of a guideline in a registry.

ShortDates for a guideline registration activity
Control0..*
TypeExtension(GuidelineRegistration) (Complex Extension)
Is Modifierfalse
Must Supportfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
46. Composition.url
Definition

An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers.

ShortCanonical identifier for this Composition, represented as a URI (globally unique)
Comments

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
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Allows the Composition to be referenced by a single globally unique identifier.

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

A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

ShortVersion-independent identifier for the Composition
Comments

Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Composition.version
Definition

An explicitly assigned identifier of a variation of the content in the Composition.

ShortAn explicitly assigned identifier of a variation of the content in the Composition
Comments

This element is the author-assigned business version of the Composition (analogous to CDA ClinicalDocument.versionNumber). It is distinct from Resource.meta.versionId, which is a server-assigned technical version that every resource carries and that may change whenever the resource is updated on a server. Composition.version reflects the version of a logical document's content and remains constant even if the Composition or its referenced resources are moved between servers and receive new meta.versionId values.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Composition.consent
Definition

References the consents associated with this document. Examples include a consent to perform the clinical service being documented (.event) or a consent for the information contained in the document to be released to a third party.

ShortRepresents informed consents and medico-legal transactions
Control0..*
TypeReference(Consent)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Composition.basedOn
Definition

A plan, proposal or order that is fulfilled in whole or in part by this composition.

ShortFulfills plan, proposal or order
Control0..*
TypeReference(Appointment, AppointmentResponse, CarePlan, Claim, CommunicationRequest, CoverageEligibilityRequest, DeviceRequest, MedicationRequest, NutritionOrder, RequestOrchestration, ServiceRequest, Task, VisionPrescription)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Alternate Namesfulfills
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Composition.status
Definition

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

Shortregistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Comments

See section 2.8.3.2, The workflow/clinical status of the composition, for guidance. Because the entered-in-error flag changes how this resource and its related elements must be interpreted, status is labeled as a modifier element. Some reporting workflows 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 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|6.0.0-snapshot1)

The workflow status of the composition.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. 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 FHIRDocumentTypeCodes
(preferred to http://hl7.org/fhir/ValueSet/doc-typecodes|6.0.0-snapshot1)

Type of a composition.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

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

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
62. Composition.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.type.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
64. Composition.type.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "Guideline",
  "display" : "Guideline"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="Guideline"/>
  <display value="Guideline"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Composition.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

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

ShortCategorization of Composition
Control0..*
BindingFor example codes, see ReferencedItemCategoryValueSet
(example to http://hl7.org/fhir/ValueSet/referenced-item-category|6.0.0-snapshot1)

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

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. 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

Reference a PublicationRecord Resource, ArtifactAssessment Resource (Classification Profile), Group Resource (EvidenceReportSubject Profile), ReserchStudy Resource, or any Resource to define a subject of this EvidenceReport.

Control0..*
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

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

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

ShortContext of the Composition
Control0..1
TypeReference(Encounter)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Provides context for the composition and supports searching.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. 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 the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.

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

dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring this version of the Composition. When packaged in a document, Bundle.timestamp is the date of packaging.

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

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances.

ShortThe context that the content is intended to support
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Control0..*
TypeUsageContext
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Assist in searching for appropriate content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. 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
Comments

When the Composition is software-generated, a Device can be referenced. When a software-generated Composition is verified by a human (but not authored by that human), use the attester element to identify the human(s) who performed the verification.

Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Identifies who is responsible for the content.

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

Identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient. A supporting person or organization is an individual or an organization with a relationship to the patient. A supporting person who is playing multiple roles would be recorded in multiple participants (e.g., emergency contact and next-of-kin).

ShortIdentifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
82. Composition.participant.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
84. Composition.participant.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.participant.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
86. Composition.participant.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.participant.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
88. Composition.participant.type
Definition

Meaning and purpose of participation, in creation of the clinical document. The list includes: data entry person, informant, primary information recipient, and tracker. Other types are allowed.

ShortMeaning and purpose of participation, in creation of the clinical document
Control1..*
BindingThe codes SHOULD be taken from FHIR Clinical Document Participant Types Value set
(preferred to http://terminology.hl7.org/ValueSet/fhir-clinical-doc-participant)

FHIR Clinical Document Participant Types. Author, Authenticator, Custodian, Legal Authenticator, Record Target and Subject are found in distinct, named fields in FHIR. Thus, these types are excluded.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
90. Composition.participant.function
Definition

Exact function of the participant in the creation of the clinical document. This is more granular than type.

Control0..*
BindingThe codes SHOULD be taken from ParticipationFunction
(preferred to http://terminology.hl7.org/ValueSet/v3-ParticipationFunction)

To specify the exact function an actor had in a service in all necessary detail.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
92. Composition.participant.time
Definition

Time period of participation.

ShortTime period of participation
Control0..1
TypePeriod
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
94. Composition.participant.party
Definition

Who the participant is.

ShortWho the participant is
Control1..1
TypeReference(Practitioner, PractitionerRole, Patient, RelatedPerson, Device, Organization, CareTeam, Group)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Composition.name
Definition

A machine-friendly identifier suitable for code generation. For example, 'ClinicalDocument' or 'Composition_v2'. See the Constraint description.

ShortComputer friendly name
Comments

The name is not expected to be globally unique. This field is used primarily by computers while the title field includes information for human-display. Composition.type is used to provide a CodeableConcept for the document type when available while Composition.name is an uncoded string. Composition.identifier is used to identify the specific instance of a document.

Control0..1
This element is affected by the following invariants: cmp-4
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Support human navigation and code generation.

Invariantscmp-4: Name should start with an uppercase letter (A–Z), be 2 to 255 characters long, and contain only letters, digits, and underscores. Whitespace, hyphens, and other punctuation are not permitted (%resource.name.exists() implies %resource.name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. 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").

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Composition.note
Definition

For any additional notes.

ShortFor any additional notes
Comments

A comment, general note or annotation not coded elsewhere.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Composition.classification
Definition

The assignment to an organizing scheme, including the type of classification and one or more classifier values.

ShortThe assignment to an organizing scheme
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
104. Composition.classification.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
106. Composition.classification.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.classification.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
108. Composition.classification.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.classification.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
110. Composition.classification.type
Definition

The kind of classifier (e.g. population, intervention, comparator, outcome).

ShortThe kind of classifier (e.g. population, intervention)
Control0..1
BindingFor example codes, see EvidenceClassifierTypeExample
(example to http://hl7.org/fhir/ValueSet/evidence-classifier-type-example|6.0.0-snapshot1)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Composition.classification.classifier
Definition

The specific classification value.

ShortThe specific classification value
Control0..*
BindingFor example codes, see ConditionProblemDiagnosisCodes
(example to http://hl7.org/fhir/ValueSet/condition-code|6.0.0-snapshot1)
TypeCodeableReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. 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..*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies responsibility for the accuracy of the composition content.

Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
116. 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.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
118. Composition.attester.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.attester.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
120. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.attester.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
122. Composition.attester.mode
Definition

The type of attestation the authenticator offers.

Shortreviewer | editor | endorser | informant | recorder
Control1..1
BindingThe codes SHOULD be taken from Contributor Role
(preferred to http://terminology.hl7.org/ValueSet/contributor-role)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Indicates the level of authority of the attestation.

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

When the composition was attested by the party.

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

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

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

Who attested the composition in the specified way.

ShortWho attested the composition
Control0..1
TypeReference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization, Group)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. 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, Patient, Group)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

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

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
134. Composition.relatesTo.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
136. Composition.relatesTo.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
140. Composition.relatesTo.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
142. Composition.relatesTo.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. Composition.relatesTo:citeAs
Slice NameciteAs
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..1
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
146. Composition.relatesTo:citeAs.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
148. Composition.relatesTo:citeAs.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
150. Composition.relatesTo:citeAs.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. Composition.relatesTo:citeAs.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
154. Composition.relatesTo:citeAs.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "cite-as"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="cite-as"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. Composition.relatesTo:citeAs.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. Composition.relatesTo:partOf
Slice NamepartOf
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
160. Composition.relatesTo:partOf.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
162. Composition.relatesTo:partOf.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
164. Composition.relatesTo:partOf.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. Composition.relatesTo:partOf.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
168. Composition.relatesTo:partOf.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "part-of"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="part-of"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. Composition.relatesTo:partOf.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
172. Composition.relatesTo:derivedFrom
Slice NamederivedFrom
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
174. Composition.relatesTo:derivedFrom.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
176. Composition.relatesTo:derivedFrom.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
178. Composition.relatesTo:derivedFrom.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. Composition.relatesTo:derivedFrom.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
182. Composition.relatesTo:derivedFrom.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "derived-from"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="derived-from"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. Composition.relatesTo:derivedFrom.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. Composition.relatesTo:specificationOf
Slice NamespecificationOf
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
188. Composition.relatesTo:specificationOf.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
190. Composition.relatesTo:specificationOf.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
192. Composition.relatesTo:specificationOf.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. Composition.relatesTo:specificationOf.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
196. Composition.relatesTo:specificationOf.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "specification-of"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="specification-of"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. Composition.relatesTo:specificationOf.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. Composition.relatesTo:dependsOn
Slice NamedependsOn
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
202. Composition.relatesTo:dependsOn.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
204. Composition.relatesTo:dependsOn.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
206. Composition.relatesTo:dependsOn.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. Composition.relatesTo:dependsOn.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
210. Composition.relatesTo:dependsOn.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "depends-on"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="depends-on"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
212. Composition.relatesTo:dependsOn.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
214. Composition.relatesTo:supportedWith
Slice NamesupportedWith
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
216. Composition.relatesTo:supportedWith.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
218. Composition.relatesTo:supportedWith.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
220. Composition.relatesTo:supportedWith.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. Composition.relatesTo:supportedWith.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
224. Composition.relatesTo:supportedWith.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "supported-with"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="supported-with"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
226. Composition.relatesTo:supportedWith.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
228. Composition.relatesTo:similarTo
Slice NamesimilarTo
Definition

Relationships that this composition has with other compositions or documents (FHIR or non-FHIR resources) that already exist.

ShortRelationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a targetReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "targetReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
230. Composition.relatesTo:similarTo.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
232. Composition.relatesTo:similarTo.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
234. Composition.relatesTo:similarTo.extension:classifier
Slice Nameclassifier
Definition

A classifier of the target artifact in a relatesTo element.

ShortA classifier of the target artifact in a relatesTo element
Control0..1
TypeExtension(RelatesToClassifier) (Extension Type: CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. Composition.relatesTo:similarTo.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.relatesTo.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
238. Composition.relatesTo:similarTo.type
Definition

The type of relationship to the related artifact.

Shortdocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Artifact Relationship Type
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type)

The type of relationship to the related artifact.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Pattern Value
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/artifact-relationship-type",
      "code" : "similar-to"
    }
  ]
}
<type>
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/artifact-relationship-type"/>
    <code value="similar-to"/>
  </coding>
</type>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. Composition.relatesTo:similarTo.target[x]
Definition

The artifact that is related to this Composition Resource.

ShortThe artifact that is related to this Composition
Control1..1
TypeChoice of: uri, Attachment, canonical(Resource), Reference(Resource), markdown
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. 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 it can provide further information if desired.

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
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 or both (hasValue() or (children().count() > id.count()))
244. 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.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
246. Composition.event.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.event.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
248. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.event.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
250. 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
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. Composition.event.detail
Definition

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 case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to another resource.

ShortThe event(s) being documented, as code(s), reference(s), or both
Comments

An event can further specialize the act inherent in Composition.type, 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 Composition.type 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 v3 Code System ActCode
(example to http://terminology.hl7.org/ValueSet/v3-ActCode)

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

TypeCodeableReference(Resource)
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
254. Composition.section
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..*
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ code.coding

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
258. Composition.section.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
260. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
262. 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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
264. 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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. Composition.section.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. Composition.section.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. 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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. Composition.section.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. 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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. 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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. 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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
280. 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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
282. Composition.section:summary
Slice Namesummary
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
284. Composition.section:summary.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
286. Composition.section:summary.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
288. Composition.section:summary.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
290. Composition.section:summary.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
292. Composition.section:summary.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. Composition.section:summary.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
296. Composition.section:summary.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
298. Composition.section:summary.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "summary",
  "display" : "Summary"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="summary"/>
  <display value="Summary"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
300. Composition.section:summary.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
302. Composition.section:summary.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
304. Composition.section:summary.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. Composition.section:summary.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
308. Composition.section:summary.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. Composition.section:summary.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. Composition.section:summary.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. Composition.section:summary.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
316. Composition.section:summary.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
318. Composition.section:introduction
Slice Nameintroduction
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
320. Composition.section:introduction.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
322. Composition.section:introduction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
324. Composition.section:introduction.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
326. Composition.section:introduction.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
328. Composition.section:introduction.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
330. Composition.section:introduction.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
332. Composition.section:introduction.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
334. Composition.section:introduction.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "introduction",
  "display" : "Introduction"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="introduction"/>
  <display value="Introduction"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
336. Composition.section:introduction.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
338. Composition.section:introduction.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
340. Composition.section:introduction.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
342. Composition.section:introduction.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. Composition.section:introduction.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. Composition.section:introduction.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
348. Composition.section:introduction.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
350. Composition.section:introduction.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
352. Composition.section:introduction.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
354. Composition.section:discussion
Slice Namediscussion
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
356. Composition.section:discussion.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
358. Composition.section:discussion.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
360. Composition.section:discussion.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
362. Composition.section:discussion.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
364. Composition.section:discussion.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
366. Composition.section:discussion.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
368. Composition.section:discussion.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
370. Composition.section:discussion.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "discussion",
  "display" : "Discussion"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="discussion"/>
  <display value="Discussion"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
372. Composition.section:discussion.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
374. Composition.section:discussion.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
376. Composition.section:discussion.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
378. Composition.section:discussion.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
380. Composition.section:discussion.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
382. Composition.section:discussion.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
384. Composition.section:discussion.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
386. Composition.section:discussion.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
388. Composition.section:discussion.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
390. Composition.section:methods
Slice Namemethods
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
392. Composition.section:methods.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
394. Composition.section:methods.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
396. Composition.section:methods.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
398. Composition.section:methods.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
400. Composition.section:methods.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
402. Composition.section:methods.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
404. Composition.section:methods.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
406. Composition.section:methods.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "methods",
  "display" : "Methods"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="methods"/>
  <display value="Methods"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
408. Composition.section:methods.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
410. Composition.section:methods.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
412. Composition.section:methods.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
414. Composition.section:methods.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
416. Composition.section:methods.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
418. Composition.section:methods.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
420. Composition.section:methods.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
422. Composition.section:methods.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
424. Composition.section:methods.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
426. Composition.section:references
Slice Namereferences
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
428. Composition.section:references.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
430. Composition.section:references.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
432. Composition.section:references.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
434. Composition.section:references.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
436. Composition.section:references.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
438. Composition.section:references.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
440. Composition.section:references.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
442. Composition.section:references.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "references",
  "display" : "References"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="references"/>
  <display value="References"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
444. Composition.section:references.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
446. Composition.section:references.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
448. Composition.section:references.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
450. Composition.section:references.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
452. Composition.section:references.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
454. Composition.section:references.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
456. Composition.section:references.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-1, cmp-2
TypeReference(PublicationRecord)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
458. Composition.section:references.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
460. Composition.section:references.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
462. Composition.section:competingInterests
Slice NamecompetingInterests
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
464. Composition.section:competingInterests.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
466. Composition.section:competingInterests.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
468. Composition.section:competingInterests.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
470. Composition.section:competingInterests.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
472. Composition.section:competingInterests.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
474. Composition.section:competingInterests.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
476. Composition.section:competingInterests.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
478. Composition.section:competingInterests.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "competing-interests",
  "display" : "Competing Interests"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="competing-interests"/>
  <display value="Competing Interests"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
480. Composition.section:competingInterests.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
482. Composition.section:competingInterests.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
484. Composition.section:competingInterests.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
486. Composition.section:competingInterests.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
488. Composition.section:competingInterests.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
490. Composition.section:competingInterests.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
492. Composition.section:competingInterests.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
494. Composition.section:competingInterests.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
496. Composition.section:competingInterests.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
498. Composition.section:acknowledgements
Slice Nameacknowledgements
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
500. Composition.section:acknowledgements.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
502. Composition.section:acknowledgements.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
504. Composition.section:acknowledgements.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
506. Composition.section:acknowledgements.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
508. Composition.section:acknowledgements.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
510. Composition.section:acknowledgements.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
512. Composition.section:acknowledgements.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
514. Composition.section:acknowledgements.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "acknowledgements",
  "display" : "Acknowledgements"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="acknowledgements"/>
  <display value="Acknowledgements"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
516. Composition.section:acknowledgements.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
518. Composition.section:acknowledgements.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
520. Composition.section:acknowledgements.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
522. Composition.section:acknowledgements.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
524. Composition.section:acknowledgements.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
526. Composition.section:acknowledgements.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
528. Composition.section:acknowledgements.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
530. Composition.section:acknowledgements.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
532. Composition.section:acknowledgements.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
534. Composition.section:appendices
Slice Nameappendices
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
536. Composition.section:appendices.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
538. Composition.section:appendices.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
540. Composition.section:appendices.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
542. Composition.section:appendices.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
544. Composition.section:appendices.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
546. Composition.section:appendices.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
548. Composition.section:appendices.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
550. Composition.section:appendices.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "appendices",
  "display" : "Appendices"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="appendices"/>
  <display value="Appendices"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
552. Composition.section:appendices.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
554. Composition.section:appendices.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
556. Composition.section:appendices.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
558. Composition.section:appendices.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
560. Composition.section:appendices.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
562. Composition.section:appendices.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
564. Composition.section:appendices.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-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
566. Composition.section:appendices.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
568. Composition.section:appendices.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
570. Composition.section:attachments
Slice Nameattachments
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
572. Composition.section:attachments.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
574. Composition.section:attachments.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
576. Composition.section:attachments.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
578. Composition.section:attachments.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
580. Composition.section:attachments.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
582. Composition.section:attachments.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
584. Composition.section:attachments.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
586. Composition.section:attachments.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "attachments",
  "display" : "Attachments"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="attachments"/>
  <display value="Attachments"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
588. Composition.section:attachments.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
590. Composition.section:attachments.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
592. Composition.section:attachments.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
594. Composition.section:attachments.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
596. Composition.section:attachments.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
598. Composition.section:attachments.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
600. Composition.section:attachments.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-1, cmp-2
TypeReference(DocumentReference)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
602. Composition.section:attachments.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
604. Composition.section:attachments.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
606. Composition.section:recommendations
Slice Namerecommendations
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control0..1
This element is affected by the following invariants: cmp-3
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantscmp-1: A section must contain 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 no entries are included (emptyReason.empty() or entry.empty())
cmp-3: If attester exists then the Composition either needs a text or a section (%resource.attester.exists() implies(text.exists() or section.exists()))
ele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
608. Composition.section:recommendations.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
610. Composition.section:recommendations.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
612. Composition.section:recommendations.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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 Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.modifierExtension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
614. Composition.section:recommendations.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 a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
616. Composition.section:recommendations.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.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from EvidenceReportSectionCode Value Set
(extensible to https://fevir.net/resources/ValueSet/179431)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
618. Composition.section:recommendations.code.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
620. Composition.section:recommendations.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.section.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
622. Composition.section:recommendations.code.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control1..1
TypeCoding
Is Modifierfalse
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Pattern Value
{
  "system" : "https://fevir.net/resources/CodeSystem/179423",
  "code" : "recommendations",
  "display" : "Recommendations"
}
<coding>
  <system value="https://fevir.net/resources/CodeSystem/179423"/>
  <code value="recommendations"/>
  <display value="Recommendations"/>
</coding>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
624. Composition.section:recommendations.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

ShortPlain text representation of the concept
Comments

Very often the text is the same as a displayName of one of the codings.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
626. Composition.section:recommendations.author
Definition

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

The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition.

ShortWho and/or what authored the section, when the section is authored by someone other than the composition.author
Control0..*
TypeReference(Practitioner, PractitionerRole, CareTeam, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
628. Composition.section:recommendations.focus
Definition

The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If no focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).

ShortWho/what the section is about, when it is not about the subject of the composition
Comments

Typically, sections in a document are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kinds 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
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
630. Composition.section:recommendations.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, cmp-3
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
632. Composition.section:recommendations.note
Definition

Information about the section contents that is not represented by any of the section entries.

ShortInformation about the section contents that is not represented by any of the section entries
Comments

A comment, general note or annotation not coded elsewhere in the section.

Control0..*
TypeAnnotation
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
634. Composition.section:recommendations.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://terminology.hl7.org/ValueSet/list-order)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
636. Composition.section:recommendations.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-1, cmp-2
TypeReference(Recommendation)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
638. Composition.section:recommendations.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 difference 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 ListEmptyReasons
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason|6.0.0-snapshot1)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
640. Composition.section:recommendations.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..*
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))