Narrative

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.

Short A 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.

Control 0..*
Is Modifier false
Must Support false
Summary false
Invariants dom-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.

Short Logical 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.

Control 0..1
Type id
Is Modifier false
Must Support false
Summary true
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.

Short Metadata about the resource
Control 0..1
Type Meta
Is Modifier false
Must Support false
Summary true
Invariants ele-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.

Short A 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.

Control 0..1
Type uri
Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary true
Invariants ele-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.

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

Control 0..1
Binding The codes SHALL be taken from test
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-snapshot1
Type code
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary false
Invariants ele-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.

Short Text 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.

Control 0..1
This element is affected by the following invariants: dom-6
Type Narrative
Is Modifier false
Must Support false
Summary false
Alternate Names narrative, html, xhtml, display
Invariants ele-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.

Short Contained, 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 .

Control 0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type Resource
Is Modifier false
Must Support false
Summary false
Alternate Names inline 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Must Support false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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.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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support false
Summary true
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 Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
18. 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.

Short Canonical 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.

Control 0..1
Type uri
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary true
Requirements

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

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

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

Short Version-independent identifier for the Composition
Comments

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

Note This is a business identifier, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Is Modifier false
Must Support false
Summary true
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
22. Composition.version
Definition

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

Short An 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.

Note This is a business version Id, not a resource version Id (see discussion )
Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary true
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
24. 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.

Short Represents informed consents and medico-legal transactions
Control 0..*
Type Reference ( Consent )
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
26. Composition.basedOn
Definition

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

Short Fulfills plan, proposal or order
Control 0..*
Type Reference ( Appointment , AppointmentResponse , CarePlan , Claim , CommunicationRequest , CoverageEligibilityRequest , DeviceRequest , MedicationRequest , NutritionOrder , RequestOrchestration , ServiceRequest , Task , VisionPrescription )
Is Modifier false
Must Support false
Summary false
Requirements

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

Alternate Names fulfills
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
28. Composition.status
Definition

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

Short registered | 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.

Control 1..1
Binding The codes SHALL be taken from test
(required to http://hl7.org/fhir/ValueSet/composition-status|6.0.0-snapshot1
Type code
Is Modifier true 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 Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary true
Requirements

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

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

Short Kind 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.

Control 1..1
Binding The codes SHOULD be taken from test
(preferred to http://hl7.org/fhir/ValueSet/doc-typecodes
Type CodeableConcept
Is Modifier false
Must Support false
Summary true
Requirements

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

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

Short Categorization of Composition
Control 0..*
Binding For example codes, see test
(example to http://hl7.org/fhir/ValueSet/referenced-item-category
Type CodeableConcept
Is Modifier false
Must Support false
Summary true
Requirements

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

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

Short Who and/or what the composition is about
Comments

For clinical documents, this is usually the patient.

Control 0..*
Type Reference ( Resource )
Is Modifier false
Must Support false
Summary true
Requirements

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

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

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

Short Context of the Composition
Control 0..1
Type Reference ( Encounter )
Is Modifier false
Must Support false
Summary true
Requirements

Provides context for the composition and supports searching.

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
38. Composition.date
Definition

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

Short Composition 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.

Control 1..1
Type dateTime
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary true
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.

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

Short The 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.

Control 0..*
Type UsageContext
Is Modifier false
Must Support false
Summary true
Requirements

Assist in searching for appropriate content.

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
42. Composition.author
Definition

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

Short Who 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.

Control 0..*
Type Reference ( Practitioner , PractitionerRole , CareTeam , Device , Patient , RelatedPerson , Organization )
Is Modifier false
Must Support false
Summary true
Requirements

Identifies who is responsible for the content.

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

Short Identifies supporting entities, including parents, relatives, caregivers, insurance policyholders, guarantors, and others related in some way to the patient
Control 0..*
Type BackboneElement
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children or both ( hasValue() or (children().count() > id.count()) )
46. 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.

Short Unique id for inter-element referencing
Control 0..1
This element is affected by the following invariants: ele-1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
48. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
50. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
52. 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.

Short Meaning and purpose of participation, in creation of the clinical document
Control 1..*
Binding The codes SHOULD be taken from test
(preferred to http://terminology.hl7.org/ValueSet/fhir-clinical-doc-participant
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
54. Composition.participant.function
Definition

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

Control 0..*
Binding The codes SHOULD be taken from test
(preferred to http://terminology.hl7.org/ValueSet/v3-ParticipationFunction
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
56. Composition.participant.time
Definition

Time period of participation.

Short Time period of participation
Control 0..1
Type Period
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
58. Composition.participant.party
Definition

Who the participant is.

Short Who the participant is
Control 1..1
Type Reference ( Practitioner , PractitionerRole , Patient , RelatedPerson , Device , Organization , CareTeam , Group )
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
60. Composition.name
Definition

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

Short Computer 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.

Control 0..1
This element is affected by the following invariants: cmp-4
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary true
Requirements

Support human navigation and code generation.

Invariants cmp-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()) )
62. Composition.title
Definition

Official human-readable label for the composition.

Short Human 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").

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary true
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
64. Composition.note
Definition

For any additional notes.

Short For any additional notes
Comments

A comment, general note or annotation not coded elsewhere.

Control 0..*
Type Annotation
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
66. Composition.classification
Definition

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

Short The assignment to an organizing scheme
Control 0..*
Type BackboneElement
Is Modifier false
Must Support false
Summary true
Invariants ele-1 : All FHIR elements must have a @value or children or both ( hasValue() or (children().count() > id.count()) )
68. 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.

Short Unique id for inter-element referencing
Control 0..1
This element is affected by the following invariants: ele-1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
70. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
72. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
74. Composition.classification.type
Definition

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

Short The kind of classifier (e.g. population, intervention)
Control 0..1
Binding For example codes, see test
(example to http://hl7.org/fhir/ValueSet/evidence-classifier-type-example
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
76. Composition.classification.classifier
Definition

The specific classification value.

Short The specific classification value
Control 0..*
Binding For example codes, see test
(example to http://hl7.org/fhir/ValueSet/condition-code
Type CodeableReference ( Resource )
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
78. Composition.attester
Definition

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

Short Attests to accuracy of composition
Comments

Only list each attester once.

Control 0..*
This element is affected by the following invariants: cmp-3
Type BackboneElement
Is Modifier false
Must Support false
Summary false
Requirements

Identifies responsibility for the accuracy of the composition content.

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

Short Unique id for inter-element referencing
Control 0..1
This element is affected by the following invariants: ele-1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
82. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
84. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
86. Composition.attester.mode
Definition

The type of attestation the authenticator offers.

Short personal | professional | legal | official
Control 1..1
Binding The codes SHOULD be taken from test
(preferred to http://terminology.hl7.org/ValueSet/composition-attestation-mode
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Requirements

Indicates the level of authority of the attestation.

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

When the composition was attested by the party.

Short When the composition was attested
Control 0..1
Type dateTime
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary false
Requirements

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

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

Who attested the composition in the specified way.

Short Who attested the composition
Control 0..1
Type Reference ( Patient , RelatedPerson , Practitioner , PractitionerRole , Organization , Group )
Is Modifier false
Must Support false
Summary false
Requirements

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

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
92. Composition.custodian
Definition

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

Short Organization 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.

Control 0..1
Type Reference ( Organization , Patient , Group )
Is Modifier false
Must Support false
Summary true
Requirements

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

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

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

Short Relationships 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": "..."
    }
  } 
}]

        
Control 0..*
Type BackboneElement
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children or both ( hasValue() or (children().count() > id.count()) )
96. 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.

Short Unique id for inter-element referencing
Control 0..1
This element is affected by the following invariants: ele-1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
98. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
100. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
102. Composition.relatesTo.type
Definition

The type of relationship to the related artifact.

Short documentation | 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
Control 1..1
Binding Unless not suitable, these codes SHALL be taken from test
(extensible to http://terminology.hl7.org/ValueSet/artifact-relationship-type
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
104. Composition.relatesTo.target[x]
Definition

The artifact that is related to this Composition Resource.

Short The artifact that is related to this Composition
Control 1..1
Type Choice of: uri , Attachment , canonical ( Resource ), Reference ( Resource ), markdown
[x] Note See Choice of Data Types for further information about how to use [x]
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
106. Composition.event
Definition

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

Short The clinical service(s) being documented
Comments

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

Control 0..*
Type BackboneElement
Is Modifier false
Must Support false
Summary true
Requirements

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

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

Short Unique id for inter-element referencing
Control 0..1
This element is affected by the following invariants: ele-1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
110. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
112. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
114. 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.

Short The period covered by the documentation
Control 0..1
Type Period
Is Modifier false
Must Support false
Summary true
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
116. 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.

Short The 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.

Control 0..*
Binding For example codes, see test
(example to http://terminology.hl7.org/ValueSet/v3-ActCode
Type CodeableReference ( Resource )
Is Modifier false
Must Support false
Summary true
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
118. Composition.section
Definition

The root of the sections that make up the composition.

Short Composition is broken into sections
Control 0..*
This element is affected by the following invariants: cmp-3
Type BackboneElement
Is Modifier false
Must Support false
Summary false
Invariants cmp-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()) )
120. 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.

Short Unique id for inter-element referencing
Control 0..1
This element is affected by the following invariants: ele-1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
122. 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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
124. 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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This 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
126. 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.

Short Label 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.

Control 1..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary false
Requirements

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

Alternate Names header, label, caption
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
128. Composition.section.code
Definition

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

Short Classification 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.

Control 0..1
Binding For example codes, see test
(example to http://hl7.org/fhir/ValueSet/doc-section-codes
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Requirements

Provides computable standardized labels to topics within the document.

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

Short Who and/or what authored the section, when the section is authored by someone other than the composition.author
Control 0..*
Type Reference ( Practitioner , PractitionerRole , CareTeam , Device , Patient , RelatedPerson , Organization )
Is Modifier false
Must Support false
Summary false
Requirements

Identifies who is responsible for the content.

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

Short Who/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.

Control 0..1
Type Reference ( Resource )
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
134. 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.

Short Text summary of the section, for human interpretation
Comments

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

Control 0..1
This element is affected by the following invariants: cmp-1, cmp-3
Type Narrative
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
136. Composition.section.note
Definition

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

Short Information 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.

Control 0..*
Type Annotation
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
138. Composition.section.orderedBy
Definition

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

Short Order 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.

Control 0..1
Binding The codes SHOULD be taken from test
(preferred to http://terminology.hl7.org/ValueSet/list-order
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Requirements

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

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
140. Composition.section.entry
Definition

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

Short A reference to data that supports this section
Comments

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

Control 0..*
This element is affected by the following invariants: cmp-1, cmp-2
Type Reference ( Resource )
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
142. 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.

Short Why 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.

Control 0..1
This element is affected by the following invariants: cmp-2
Binding The codes SHOULD be taken from test
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Requirements

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

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
144. Composition.section.section
Definition

A nested sub-section within this section.

Short Nested Section
Comments

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

Control 0..*
Type BackboneElement (profiled by Composition.section )
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
146. Composition.section.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.

Short Unique id for inter-element referencing
Control 0..1
This element is affected by the following invariants: ele-1
Type string
Is Modifier false
XML Format In the XML format, this property is represented as an attribute.
Summary false
148. Composition.section.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.

Short Additional 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.

Control 0..*
Type Extension
Is Modifier false
Summary false
Alternate Names extensions, user content
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This element introduces a set of slices on Composition.section.section.extension . The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
150. Composition.section.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).

Short Extensions 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.

Control 0..*
Type Extension
Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary true
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 Names extensions, user content, modifiers
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
Slicing This element introduces a set of slices on Composition.section.section.modifierExtension . The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
152. Composition.section.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.

Short Label 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.

Control 0..1
Type string
Is Modifier false
Primitive Value This primitive element may be present, or absent, or replaced by an extension
Must Support false
Summary false
Requirements

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

Alternate Names header, label, caption
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
154. Composition.section.section.code
Definition

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

Short Classification 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.

Control 0..1
Binding For example codes, see test
(example to http://hl7.org/fhir/ValueSet/doc-section-codes
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Requirements

Provides computable standardized labels to topics within the document.

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
156. Composition.section.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.

Short Who and/or what authored the section, when the section is authored by someone other than the composition.author
Control 0..*
Type Reference ( Practitioner , PractitionerRole , CareTeam , Device , Patient , RelatedPerson , Organization )
Is Modifier false
Must Support false
Summary false
Requirements

Identifies who is responsible for the content.

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
158. Composition.section.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).

Short Who/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.

Control 0..1
Type Reference ( Resource )
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
160. Composition.section.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.

Short Text summary of the section, for human interpretation
Comments

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

Control 0..1
This element is affected by the following invariants: cmp-1, cmp-3
Type Narrative
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
162. Composition.section.section.note
Definition

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

Short Information 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.

Control 0..*
Type Annotation
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
164. Composition.section.section.orderedBy
Definition

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

Short Order 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.

Control 0..1
Binding The codes SHOULD be taken from test
(preferred to http://terminology.hl7.org/ValueSet/list-order
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Requirements

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

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
167. Composition.section.section.emptyReason
Definition

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

Short Why 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.

Control 0..1
This element is affected by the following invariants: cmp-2
Binding The codes SHOULD be taken from test
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason
Type CodeableConcept
Is Modifier false
Must Support false
Summary false
Requirements

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

Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )
169. Composition.section.section.section
Definition

A nested sub-section within this section.

Short Nested Section
Comments

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

Control 0..*
Type Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier false
Must Support false
Summary false
Invariants ele-1 : All FHIR elements must have a @value or children ( hasValue() or (children().count() > id.count()) )