PACIO Advance Healthcare Directive Interoperability Implementation Guide
2.0.0 - STU 2 – Ballot United States of America flag

PACIO Advance Healthcare Directive Interoperability Implementation Guide, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-adi/ and changes regularly. See the Directory of published versions

Resource Profile: ADICompositionHeader - Detailed Descriptions

Page standards status: Trial-use

Definitions for the ADI-Composition-Header resource profile.

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

0. Composition
Definition

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

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
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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())
clindoc-limit-participantType: The R4 FHIR Clinical Document Composition Profile contains specific extensions for data entry person, informant, information recipient, primary information recipient and tracker. So, they are not allowed in the participant extension in the R4 profile. In R6, the intention is to have dedicated-named slices of a backbone element. (extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='ENT').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='INF').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='IRCP').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='PRCP').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='TRC').not())
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.

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 it's 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 it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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).

Control10..1
BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. 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 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
TypeNarrative
Is Modifierfalse
Must Supporttrue
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Composition.extension:R5-Composition-version
Slice NameR5-Composition-version
Definition

R5: Composition.version (new:string)

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

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

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

The Data Enterer Extension represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.

ShortA Data Enterer represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Data Enterer Extension) (Complex Extension)
Is Modifierfalse
Labeldate enterer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Composition.extension:informant
Slice Nameinformant
Definition

Informant Extension describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

ShortAn Informant is an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Informant Extension) (Complex Extension)
Is Modifierfalse
Labelinformant
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Composition.extension:information-recipient
Slice Nameinformation-recipient
Definition

The Information Recipient Extension records the intended recipient of the information at the time the document was created.

ShortAn Information Recipient is the intended recipient of the information at the time the document was created.
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Information Recipient Extension) (Complex Extension)
Is Modifierfalse
Labelinformation recipient of type primary, secondary information recipient or a generic information recipient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Composition.extension:participant
Slice Nameparticipant
Definition

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

ShortA Participant that is not a data-enter, information-recipient nor an informant
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Participant Extension) (Complex Extension)
Is Modifierfalse
Must Supporttrue
LabelA Participant that is not a data-enter, information-recipient nor an informant
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Composition.extension:consent
Slice Nameconsent
Definition

Consent Extension refers to a FHIR Consent instance that indicates a patient's consent

Shortconsent
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Consent Extension) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Labelconsent
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Composition.extension:basedOn
Slice NamebasedOn
Definition

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

ShortThe clinical action, such as a plan, proposal or order that is fulfilled by or precipitated this FHIR Clinical Document, such as a radiologists report of an x-ray.
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Based on) (Extension Type: Reference(Resource))
Is Modifierfalse
Summaryfalse
LabelbasedOn, e.g. order fullfilled
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Composition.extension:change-made
Slice Namechange-made
Definition

Change Made provides an annotation of a change that has been made to the Composition or Composition section. The extension is experimental and may overlap with other extensions, such as use of note in R6. The extension contains two parts: change - the description of the change, version-changed - the FHIR Clinical Document version that was changed. Note: Calculating a differential between versions is suggested for safely finding all changes as this annotation may not contain all changes between versions.

ShortNote of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Change Made) (Complex Extension)
Is Modifierfalse
LabelNote of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Composition.extension:ExpirationDateExtension
Slice NameExpirationDateExtension
Definition

The Advance Directive document expiration date. The start date is represented by the Composition.date element.

ShortADI Expiration Date
Control0..1
TypeExtension(ADI Expiration Date) (Extension Type: dateTime)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Composition.extension:DataEntererExtension
Slice NameDataEntererExtension
Definition

Data Enterer Extension represents the person who transferred the content, written or dictated, into the Advance Directive document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author’s information to the electronic system.

ShortData Enterer
Control0..1
TypeExtension(Data Enterer) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. Composition.extension:InformantExtension
Slice NameInformantExtension
Definition

The Advance Directive Information Informant Extension describes an information source for any content within the Advance Directive document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

ShortInformant
Control0..*
TypeExtension(Informant) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. Composition.extension:ParticipantExtension
Slice NameParticipantExtension
Definition

The Advance Directive Information Participant Extension 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).

ShortParticipant
Control0..*
TypeExtension(Participant) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Composition.extension:PerformerExtension
Slice NamePerformerExtension
Definition

The Advance Directive Information Performer Extension represents clinicians who actually and principally carry out the clinical services being documented. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patients key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.

ShortPerformer
Control0..*
TypeExtension(Performer) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Composition.extension:ClauseExtension
Slice NameClauseExtension
Definition

A clause or set of clauses relevant to the resource or element being extended

ShortClause
Control0..*
TypeExtension(Clause) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Composition.extension:DocumentRevokeStatus
Slice NameDocumentRevokeStatus
Definition

The Advance Directive document revoke status.

ShortRevoke Status
Control0..1
TypeExtension(Revoke Status) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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
Summaryfalse
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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. 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)
Control10..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Composition.status
Definition

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

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

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

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

Control1..1
BindingThe codes SHALL be taken from ADI Composition Statushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1
(required to http://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS)
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 Supporttrue
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()))
44. Composition.status.extension:R5-Composition-status
Slice NameR5-Composition-status
Definition

R5: Composition.status

ShortThis allows for additional status values found in R5. However, exercise caution as the R4 Composition.status is required.
Comments

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

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

Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown) (Extension Type: code)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. 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
BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Advance Healthcare Directive Document Types Grouper http://hl7.org/fhir/ValueSet/doc-typecodes|4.0.1
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.41)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
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()))
48. Composition.category
Definition

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

ShortCategorization of Composition
Comments

This is a metadata field from XDS/MHD.

Control10..*
BindingFor example codes, see DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes|4.0.1
(example to http://hl7.org/fhir/ValueSet/document-classcodes|4.0.1)

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

TypeCodeableConcept
Is Modifierfalse
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()))
SlicingThis element introduces a set of slices on Composition.category. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
50. Composition.category:clinicalnotecategory
Slice Nameclinicalnotecategory
Definition

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

ShortCategory for Clinical NoteCategorization of Composition
Comments

This is a metadata field from XDS/MHD.

Control0..1*
BindingFor example codes, see DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes|4.0.1
(example to http://hl7.org/fhir/ValueSet/document-classcodes|4.0.1)

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

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

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

Pattern Value
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "107903-7",
      "display" : "Clinical note"
    }
  ]
}
<category>
  <coding>
    <system value="http://loinc.org"/>
    <code value="107903-7"/>
    <display value="Clinical note"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Composition.category:advanceDirectiveCategory
Slice NameadvanceDirectiveCategory
Definition

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

ShortCategorization of Composition
Comments

This is a metadata field from XDS/MHD.

Control10..1*
BindingUnless not suitable, these codes SHALL be taken from For example codes, see Advance Healthcare Directive Categories LOINC http://hl7.org/fhir/ValueSet/document-classcodes|4.0.1
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

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

Pattern Value
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "42348-3",
      "display" : "Advance healthcare directives"
    }
  ]
}
<category>
  <coding>
    <system value="http://loinc.org"/>
    <code value="42348-3"/>
    <display value="Advance healthcare directives"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Composition.subject
Definition

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

ShortWho and/or what the composition is about
Comments

For clinical documents, this is usually the patient.

Control10..1
TypeReference(US Core Patient Profile, Resource)
Is Modifierfalse
Must Supporttrue
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()))
56. Composition.encounter
Definition

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

ShortContext of the Composition
Control0..1
TypeReference(US Core Encounter Profile, Encounter)
Is Modifierfalse
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()))
58. Composition.date
Definition

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

ShortComposition editing time
Comments

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

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

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


dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. 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()))
60. Composition.author
Definition

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

ShortWho and/or what authored the composition
Control1..*
TypeReference(US Core Practitioner Profile, US Core PractitionerRole Profile, PractitionerRole, US Core Patient Profile, Device, RelatedPerson, Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
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()))
62. Composition.title
Definition

Official human-readable label for the composition.

ShortHuman Readable name/title
Comments

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

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

The code specifying the level of confidentiality of the Composition.

ShortAs defined by affinity domain
Comments

The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

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

Codes specifying the level of confidentiality of the composition.

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

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

ShortAttests to accuracy of composition
Comments

Only list each attester once.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Identifies responsibility for the accuracy of the composition 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. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ mode
68. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
70. Composition.attester.mode
Definition

The type of attestation the authenticator offers.

Shortpersonal | professional | legal | official
Control1..1
BindingThe codes SHALL be taken from CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
(required to http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1)

The way in which a person authenticated a composition.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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()))
72. Composition.attester:legal_attester
Slice Namelegal_attester
Definition

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

Shortaka legal authenticatorAttests to accuracy of composition
Comments

Only list each attester once.

Control0..1*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Identifies responsibility for the accuracy of the composition content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Composition.attester:legal_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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
76. Composition.attester:legal_attester.mode
Definition

The type of attestation the authenticator offers.

Shortpersonal | professional | legal | official
Control1..1
BindingThe codes SHALL be taken from CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
(required to http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1)

The way in which a person authenticated a composition.

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

Indicates the level of authority of the attestation.

Pattern Value
{
  "mode" : "legal"
}
<mode value="legal"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Composition.attester:professional_attester
Slice Nameprofessional_attester
Definition

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

Shortaka authenticatorAttests to accuracy of composition
Comments

Only list each attester once.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Identifies responsibility for the accuracy of the composition content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Composition.attester:professional_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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
82. Composition.attester:professional_attester.mode
Definition

The type of attestation the authenticator offers.

Shortpersonal | professional | legal | official
Control1..1
BindingThe codes SHALL be taken from CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1
(required to http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1)

The way in which a person authenticated a composition.

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

Indicates the level of authority of the attestation.

Pattern Value
{
  "mode" : "professional"
}
<mode value="professional"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. 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.

Control10..1
TypeReference(US Core Organization Profile, Organization)
Is Modifierfalse
Must Supporttrue
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()))
86. Composition.relatesTo
Definition

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

ShortRelationships to other compositions/documents
Comments

A document is a version specific composition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
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. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • type @ target

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

88. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
90. Composition.relatesTo.code
Definition

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

Shortreplaces | transforms | signs | appends
Comments

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

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

The type of relationship between documents.

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

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeChoice of: Identifier, Reference(Composition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
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.target[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
94. Composition.relatesTo.target[x]:targetIdentifier
Slice NametargetIdentifier
Definition

The target composition/document of this relationship.

ShortReference to the Bundle.identifier of the FHIR Clinical Document being appended, or to some other identifier of a non FHIR documentTarget of the relationship
Control01..1
TypeIdentifier, Reference(Composition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Composition.relatesTo:replaced_document
Slice Namereplaced_document
Definition

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

ShortThe document(s) being supercededRelationships to other compositions/documents
Comments

A document is a version specific composition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Composition.relatesTo:replaced_document.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
100. Composition.relatesTo:replaced_document.code
Definition

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

Shortreplaces | transforms | signs | appends
Comments

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

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

The type of relationship between documents.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Pattern Value
{
  "code" : "replaces"
}
<code value="replaces"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
102. Composition.relatesTo:replaced_document.target[x]
Definition

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeIdentifier, Reference(Composition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
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.target[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
104. Composition.relatesTo:replaced_document.target[x]:targetIdentifier
Slice NametargetIdentifier
Definition

The target composition/document of this relationship.

ShortReference to the Bundle.identifier of the FHIR Clinical Document being replaced, or to some other identifier of a non FHIR documentTarget of the relationship
Control1..1
TypeIdentifier, Reference(Composition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

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

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
112. Composition.relatesTo:appended_document
Slice Nameappended_document
Definition

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

ShortThe document(s) being appended tooRelationships to other compositions/documents
Comments

A document is a version specific composition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
114. Composition.relatesTo:appended_document.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
116. Composition.relatesTo:appended_document.code
Definition

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

Shortreplaces | transforms | signs | appends
Comments

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

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

The type of relationship between documents.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Pattern Value
{
  "code" : "appends"
}
<code value="appends"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Composition.relatesTo:appended_document.target[x]
Definition

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeIdentifier, Reference(Composition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
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.target[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
120. Composition.relatesTo:appended_document.target[x]:targetIdentifier
Slice NametargetIdentifier
Definition

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeIdentifier, Reference(Composition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
122. Composition.relatesTo:appended_document.target[x]:targetIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control10..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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
Control10..*
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 it is empty (emptyReason.empty() or entry.empty())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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 it is empty (emptyReason.empty() or entry.empty())
SlicingThis element introduces a set of slices on Composition.section. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code

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

126. Composition.section.extension:change-made
Slice Namechange-made
Definition

Change Made provides an annotation of a change that has been made to the Composition or Composition section. The extension is experimental and may overlap with other extensions, such as use of note in R6. The extension contains two parts: change - the description of the change, version-changed - the FHIR Clinical Document version that was changed. Note: Calculating a differential between versions is suggested for safely finding all changes as this annotation may not contain all changes between versions.

ShortChange Made
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Change Made) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
128. Composition.section.extension:ClauseExtension
Slice NameClauseExtension
Definition

A clause or set of clauses relevant to the resource or element being extended

ShortClause
Control0..*
TypeExtension(Clause) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
130. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
132. Composition.section.title
Definition

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

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

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

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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()))
134. Composition.section.code
Definition

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

ShortClassification of section (recommended)
Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Control0..1
BindingFor example codes, see DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes|4.0.1
(example to http://hl7.org/fhir/ValueSet/doc-section-codes|4.0.1)

Classification of a section of a composition/document.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
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()))
136. 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.

Control10..1
This element is affected by the following invariants: cmp-1
TypeNarrative
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Composition.section:advance_directive_source_form
Slice Nameadvance_directive_source_form
Definition

The root of the sections that make up the composition.

ShortAdvance directive source formComposition is broken into sections
Control10..1*
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 it is empty (emptyReason.empty() or entry.empty())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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 it is empty (emptyReason.empty() or entry.empty())
140. Composition.section:advance_directive_source_form.extension:change-made
Slice Namechange-made
Definition

Change Made provides an annotation of a change that has been made to the Composition or Composition section. The extension is experimental and may overlap with other extensions, such as use of note in R6. The extension contains two parts: change - the description of the change, version-changed - the FHIR Clinical Document version that was changed. Note: Calculating a differential between versions is suggested for safely finding all changes as this annotation may not contain all changes between versions.

ShortChange Made
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Change Made) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
142. Composition.section:advance_directive_source_form.extension:ADISourceFormJurisdiction
Slice NameADISourceFormJurisdiction
Definition

Jurisdiction for which content is applicable. Represent state jurisdictions as a codeableConcept using the 2-letter state value set, and organization jurisdictions as a string value. This extension is only to be used for DocumentReference. ADI Compositions will instead reference the ADI Jurisdiction profile.

ShortJurisdiction
Control0..1
TypeExtension(Jurisdiction) (Extension Type: Choice of: string, CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
144. Composition.section:advance_directive_source_form.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
146. Composition.section:advance_directive_source_form.title
Definition

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

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

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

Control10..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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()))
148. Composition.section:advance_directive_source_form.code
Definition

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

ShortClassification of section (recommended)
Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Control10..1
BindingFor example codes, see DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codes|4.0.1
(example to http://hl7.org/fhir/ValueSet/doc-section-codes|4.0.1)

Classification of a section of a composition/document.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs",
      "code" : "advance_directive_source_form"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs"/>
    <code value="advance_directive_source_form"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
150. Composition.section:advance_directive_source_form.text
Definition

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

ShortText summary of the section, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: cmp-1
TypeNarrative
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. Composition.section:advance_directive_source_form.entry
Definition

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

ShortA reference to data that supports this section
Comments

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

Control0..*
This element is affected by the following invariants: cmp-2
TypeReference(ADI Source Form, Resource)
Is Modifierfalse
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.language
Control1..?
Must Supporttrue
4. Composition.extension:ExpirationDateExtension
Slice NameExpirationDateExtension
Control0..1
TypeExtension(ADI Expiration Date) (Extension Type: dateTime)
6. Composition.extension:DataEntererExtension
Slice NameDataEntererExtension
Control0..1
TypeExtension(Data Enterer) (Extension Type: Reference)
8. Composition.extension:InformantExtension
Slice NameInformantExtension
Control0..*
TypeExtension(Informant) (Extension Type: Reference)
10. Composition.extension:ParticipantExtension
Slice NameParticipantExtension
Control0..*
TypeExtension(Participant) (Extension Type: Reference)
12. Composition.extension:PerformerExtension
Slice NamePerformerExtension
Control0..*
TypeExtension(Performer) (Extension Type: Reference)
14. Composition.extension:ClauseExtension
Slice NameClauseExtension
Control0..*
TypeExtension(Clause) (Complex Extension)
16. Composition.extension:DocumentRevokeStatus
Slice NameDocumentRevokeStatus
Control0..1
TypeExtension(Revoke Status) (Extension Type: code)
Must Supporttrue
18. Composition.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
Must Supporttrue
20. Composition.status
BindingThe codes SHALL be taken from ADI Composition Status
(required to http://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS)
22. Composition.type
BindingUnless not suitable, these codes SHALL be taken from Advance Healthcare Directive Document Types Grouper
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.41)
24. Composition.category
Control1..?
26. Composition.category:advanceDirectiveCategory
Slice NameadvanceDirectiveCategory
Control1..1
BindingUnless not suitable, these codes SHALL be taken from Advance Healthcare Directive Categories LOINC
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4)
Must Supporttrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "42348-3",
      "display" : "Advance healthcare directives"
    }
  ]
}
<category>
  <coding>
    <system value="http://loinc.org"/>
    <code value="42348-3"/>
    <display value="Advance healthcare directives"/>
  </coding>
</category>
28. Composition.subject
TypeReference(US Core Patient Profile)
30. Composition.encounter
TypeReference(US Core Encounter Profile)
32. Composition.author
TypeReference(US Core Practitioner Profile, US Core PractitionerRole Profile, PractitionerRole, US Core Patient Profile, Device, RelatedPerson)
34. Composition.confidentiality
Control0..0
36. Composition.custodian
Control1..?
TypeReference(US Core Organization Profile)
38. Composition.event
40. Composition.event.code
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs",
      "code" : "acp-services",
      "display" : "Advance care planning services"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs"/>
    <code value="acp-services"/>
    <display value="Advance care planning services"/>
  </coding>
</code>
42. Composition.event.detail
SlicingThis element introduces a set of slices on Composition.event.detail. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
44. Composition.event.detail:adiFacilitator
Slice NameadiFacilitator
ShortADI Facilitator
Control0..1
TypeReference(ADI Facilitator)
46. Composition.section
SlicingThis element introduces a set of slices on Composition.section. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code

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

48. Composition.section.extension:ClauseExtension
Slice NameClauseExtension
Control0..*
TypeExtension(Clause) (Complex Extension)
50. Composition.section.text
Control1..?
52. Composition.section:advance_directive_source_form
Slice Nameadvance_directive_source_form
ShortAdvance directive source form
Control1..1
Must Supporttrue
54. Composition.section:advance_directive_source_form.extension:ADISourceFormJurisdiction
Slice NameADISourceFormJurisdiction
Control0..1
TypeExtension(Jurisdiction) (Extension Type: Choice of: string, CodeableConcept)
Must Supporttrue
56. Composition.section:advance_directive_source_form.code
Control1..?
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs",
      "code" : "advance_directive_source_form"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs"/>
    <code value="advance_directive_source_form"/>
  </coding>
</code>
58. Composition.section:advance_directive_source_form.entry
TypeReference(ADI Source Form)

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

0. Composition
Definition

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

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
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 in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').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())
clindoc-limit-participantType: The R4 FHIR Clinical Document Composition Profile contains specific extensions for data entry person, informant, information recipient, primary information recipient and tracker. So, they are not allowed in the participant extension in the R4 profile. In R6, the intention is to have dedicated-named slices of a backbone element. (extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='ENT').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='INF').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='IRCP').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='PRCP').not() and extension.where(url='http://hl7.org/fhir/uv/fhir-clinical-document/StructureDefinition/ParticipantExtension').extension.where(url='type').value.coding.exists(system='http://terminology.hl7.org/CodeSystem/v3-ParticipationType' and code='TRC').not())
2. Composition.id
Definition

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

ShortLogical id of this artifact
Comments

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

Control0..1
Typeid
Is Modifierfalse
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
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.

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 it's 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 it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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).

Control1..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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 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
TypeNarrative
Is Modifierfalse
Must Supporttrue
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, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

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

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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:R5-Composition-version
Slice NameR5-Composition-version
Definition

R5: Composition.version (new:string)

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

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

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

The Data Enterer Extension represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.

ShortA Data Enterer represents the person who transferred the content, written or dictated, into the clinical document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author's information to the electronic system.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Data Enterer Extension) (Complex Extension)
Is Modifierfalse
Labeldate enterer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Composition.extension:informant
Slice Nameinformant
Definition

Informant Extension describes an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

ShortAn Informant is an information source for any content within the clinical document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Informant Extension) (Complex Extension)
Is Modifierfalse
Labelinformant
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Composition.extension:information-recipient
Slice Nameinformation-recipient
Definition

The Information Recipient Extension records the intended recipient of the information at the time the document was created.

ShortAn Information Recipient is the intended recipient of the information at the time the document was created.
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Information Recipient Extension) (Complex Extension)
Is Modifierfalse
Labelinformation recipient of type primary, secondary information recipient or a generic information recipient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Composition.extension:participant
Slice Nameparticipant
Definition

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

ShortA Participant that is not a data-enter, information-recipient nor an informant
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Participant Extension) (Complex Extension)
Is Modifierfalse
Must Supporttrue
LabelA Participant that is not a data-enter, information-recipient nor an informant
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Composition.extension:consent
Slice Nameconsent
Definition

Consent Extension refers to a FHIR Consent instance that indicates a patient's consent

Shortconsent
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Consent Extension) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Labelconsent
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. Composition.extension:basedOn
Slice NamebasedOn
Definition

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

ShortThe clinical action, such as a plan, proposal or order that is fulfilled by or precipitated this FHIR Clinical Document, such as a radiologists report of an x-ray.
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(Based on) (Extension Type: Reference(Resource))
Is Modifierfalse
Summaryfalse
LabelbasedOn, e.g. order fullfilled
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. Composition.extension:change-made
Slice Namechange-made
Definition

Change Made provides an annotation of a change that has been made to the Composition or Composition section. The extension is experimental and may overlap with other extensions, such as use of note in R6. The extension contains two parts: change - the description of the change, version-changed - the FHIR Clinical Document version that was changed. Note: Calculating a differential between versions is suggested for safely finding all changes as this annotation may not contain all changes between versions.

ShortNote of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Change Made) (Complex Extension)
Is Modifierfalse
LabelNote of changes made, calculating changes maybe required for safety as this extension may not contain all changes. Experimental, may overlap with other elements such as FHIR R6 note.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Composition.extension:ExpirationDateExtension
Slice NameExpirationDateExtension
Definition

The Advance Directive document expiration date. The start date is represented by the Composition.date element.

ShortADI Expiration Date
Control0..1
TypeExtension(ADI Expiration Date) (Extension Type: dateTime)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Composition.extension:DataEntererExtension
Slice NameDataEntererExtension
Definition

Data Enterer Extension represents the person who transferred the content, written or dictated, into the Advance Directive document. To clarify, an author provides the content, subject to their own interpretation; a dataEnterer adds an author’s information to the electronic system.

ShortData Enterer
Control0..1
TypeExtension(Data Enterer) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Composition.extension:InformantExtension
Slice NameInformantExtension
Definition

The Advance Directive Information Informant Extension describes an information source for any content within the Advance Directive document. This informant is constrained for use when the source of information is an assigned health care provider for the patient.

ShortInformant
Control0..*
TypeExtension(Informant) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. Composition.extension:ParticipantExtension
Slice NameParticipantExtension
Definition

The Advance Directive Information Participant Extension 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).

ShortParticipant
Control0..*
TypeExtension(Participant) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. Composition.extension:PerformerExtension
Slice NamePerformerExtension
Definition

The Advance Directive Information Performer Extension represents clinicians who actually and principally carry out the clinical services being documented. In a transfer of care this represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patients key healthcare care team members would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors.

ShortPerformer
Control0..*
TypeExtension(Performer) (Extension Type: Reference)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
42. Composition.extension:ClauseExtension
Slice NameClauseExtension
Definition

A clause or set of clauses relevant to the resource or element being extended

ShortClause
Control0..*
TypeExtension(Clause) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. Composition.extension:DocumentRevokeStatus
Slice NameDocumentRevokeStatus
Definition

The Advance Directive document revoke status.

ShortRevoke Status
Control0..1
TypeExtension(Revoke Status) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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
Summaryfalse
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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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)
Control1..1
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Composition.status
Definition

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

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

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

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

Control1..1
BindingThe codes SHALL be taken from ADI Composition Status
(required to http://hl7.org/fhir/us/pacio-adi/ValueSet/ADICompositionStatusVS)
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 Supporttrue
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()))
52. Composition.status.id
Definition

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

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
54. Composition.status.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Composition.status.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
56. Composition.status.extension:R5-Composition-status
Slice NameR5-Composition-status
Definition

R5: Composition.status

ShortThis allows for additional status values found in R5. However, exercise caution as the R4 Composition.status is required.
Comments

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

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

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

Primitive value for code

ShortPrimitive value for code
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
60. 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
BindingUnless not suitable, these codes SHALL be taken from Advance Healthcare Directive Document Types Grouper
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1115.41)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
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()))
62. Composition.category
Definition

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

ShortCategorization of Composition
Comments

This is a metadata field from XDS/MHD.

Control1..*
BindingFor example codes, see DocumentClassValueSet
(example to http://hl7.org/fhir/ValueSet/document-classcodes|4.0.1)

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

TypeCodeableConcept
Is Modifierfalse
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()))
SlicingThis element introduces a set of slices on Composition.category. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
64. Composition.category:clinicalnotecategory
Slice Nameclinicalnotecategory
Definition

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

ShortCategory for Clinical Note
Comments

This is a metadata field from XDS/MHD.

Control0..1
BindingFor example codes, see DocumentClassValueSet
(example to http://hl7.org/fhir/ValueSet/document-classcodes|4.0.1)

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

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

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

Pattern Value
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "107903-7",
      "display" : "Clinical note"
    }
  ]
}
<category>
  <coding>
    <system value="http://loinc.org"/>
    <code value="107903-7"/>
    <display value="Clinical note"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Composition.category:advanceDirectiveCategory
Slice NameadvanceDirectiveCategory
Definition

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

ShortCategorization of Composition
Comments

This is a metadata field from XDS/MHD.

Control1..1
BindingUnless not suitable, these codes SHALL be taken from Advance Healthcare Directive Categories LOINC
(extensible to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.69.4)
TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

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

Pattern Value
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "42348-3",
      "display" : "Advance healthcare directives"
    }
  ]
}
<category>
  <coding>
    <system value="http://loinc.org"/>
    <code value="42348-3"/>
    <display value="Advance healthcare directives"/>
  </coding>
</category>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Composition.subject
Definition

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

ShortWho and/or what the composition is about
Comments

For clinical documents, this is usually the patient.

Control1..1
TypeReference(US Core Patient Profile)
Is Modifierfalse
Must Supporttrue
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()))
70. Composition.encounter
Definition

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

ShortContext of the Composition
Control0..1
TypeReference(US Core Encounter Profile)
Is Modifierfalse
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()))
72. Composition.date
Definition

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

ShortComposition editing time
Comments

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

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

dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. 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()))
74. Composition.author
Definition

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

ShortWho and/or what authored the composition
Control1..*
TypeReference(US Core Practitioner Profile, US Core PractitionerRole Profile, PractitionerRole, US Core Patient Profile, Device, RelatedPerson)
Is Modifierfalse
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
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()))
76. Composition.title
Definition

Official human-readable label for the composition.

ShortHuman Readable name/title
Comments

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

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

The code specifying the level of confidentiality of the Composition.

ShortAs defined by affinity domain
Comments

The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

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

Codes specifying the level of confidentiality of the composition.

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

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

ShortAttests to accuracy of composition
Comments

Only list each attester once.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Identifies responsibility for the accuracy of the composition 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. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ mode
82. 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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
84. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
86. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
88. Composition.attester.mode
Definition

The type of attestation the authenticator offers.

Shortpersonal | professional | legal | official
Control1..1
BindingThe codes SHALL be taken from CompositionAttestationMode
(required to http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1)

The way in which a person authenticated a composition.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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()))
90. 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
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()))
92. Composition.attester.party
Definition

Who attested the composition in the specified way.

ShortWho attested the composition
Control0..1
TypeReference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization)
Is Modifierfalse
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()))
94. Composition.attester:legal_attester
Slice Namelegal_attester
Definition

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

Shortaka legal authenticator
Comments

Only list each attester once.

Control0..1
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Identifies responsibility for the accuracy of the composition content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Composition.attester:legal_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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
98. Composition.attester:legal_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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
100. Composition.attester:legal_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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
102. Composition.attester:legal_attester.mode
Definition

The type of attestation the authenticator offers.

Shortpersonal | professional | legal | official
Control1..1
BindingThe codes SHALL be taken from CompositionAttestationMode
(required to http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1)

The way in which a person authenticated a composition.

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

Indicates the level of authority of the attestation.

Pattern Value
{
  "mode" : "legal"
}
<mode value="legal"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Composition.attester:legal_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
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()))
106. Composition.attester:legal_attester.party
Definition

Who attested the composition in the specified way.

ShortWho attested the composition
Control0..1
TypeReference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization)
Is Modifierfalse
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()))
108. Composition.attester:professional_attester
Slice Nameprofessional_attester
Definition

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

Shortaka authenticator
Comments

Only list each attester once.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Requirements

Identifies responsibility for the accuracy of the composition content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
110. Composition.attester:professional_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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
112. Composition.attester:professional_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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
114. Composition.attester:professional_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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
116. Composition.attester:professional_attester.mode
Definition

The type of attestation the authenticator offers.

Shortpersonal | professional | legal | official
Control1..1
BindingThe codes SHALL be taken from CompositionAttestationMode
(required to http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1)

The way in which a person authenticated a composition.

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

Indicates the level of authority of the attestation.

Pattern Value
{
  "mode" : "professional"
}
<mode value="professional"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Composition.attester:professional_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
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()))
120. Composition.attester:professional_attester.party
Definition

Who attested the composition in the specified way.

ShortWho attested the composition
Control0..1
TypeReference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization)
Is Modifierfalse
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()))
122. 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.

Control1..1
TypeReference(US Core Organization Profile)
Is Modifierfalse
Must Supporttrue
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()))
124. Composition.relatesTo
Definition

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

ShortRelationships to other compositions/documents
Comments

A document is a version specific composition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
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. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • type @ target

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

126. 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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
128. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
130. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
132. Composition.relatesTo.code
Definition

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

Shortreplaces | transforms | signs | appends
Comments

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

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

The type of relationship between documents.

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

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeChoice of: Identifier, Reference(Composition)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
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.target[x]. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
136. Composition.relatesTo.target[x]:targetIdentifier
Slice NametargetIdentifier
Definition

The target composition/document of this relationship.

ShortReference to the Bundle.identifier of the FHIR Clinical Document being appended, or to some other identifier of a non FHIR document
Control0..1
TypeIdentifier
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Composition.relatesTo:replaced_document
Slice Namereplaced_document
Definition

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

ShortThe document(s) being superceded
Comments

A document is a version specific composition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Composition.relatesTo:replaced_document.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
142. Composition.relatesTo:replaced_document.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
144. Composition.relatesTo:replaced_document.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
146. Composition.relatesTo:replaced_document.code
Definition

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

Shortreplaces | transforms | signs | appends
Comments

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

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

The type of relationship between documents.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Pattern Value
{
  "code" : "replaces"
}
<code value="replaces"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
148. Composition.relatesTo:replaced_document.target[x]
Definition

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeIdentifier
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
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.target[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
150. Composition.relatesTo:replaced_document.target[x]:targetIdentifier
Slice NametargetIdentifier
Definition

The target composition/document of this relationship.

ShortReference to the Bundle.identifier of the FHIR Clinical Document being replaced, or to some other identifier of a non FHIR document
Control1..1
TypeIdentifier
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
152. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
154. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Composition.relatesTo.target[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
156. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
160. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

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

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. Composition.relatesTo:replaced_document.target[x]:targetIdentifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. Composition.relatesTo:appended_document
Slice Nameappended_document
Definition

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

ShortThe document(s) being appended too
Comments

A document is a version specific composition.

Control0..*
TypeBackboneElement
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
170. Composition.relatesTo:appended_document.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
172. Composition.relatesTo:appended_document.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
174. Composition.relatesTo:appended_document.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
176. Composition.relatesTo:appended_document.code
Definition

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

Shortreplaces | transforms | signs | appends
Comments

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

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

The type of relationship between documents.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Pattern Value
{
  "code" : "appends"
}
<code value="appends"/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. Composition.relatesTo:appended_document.target[x]
Definition

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeIdentifier
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
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.target[x]. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
180. Composition.relatesTo:appended_document.target[x]:targetIdentifier
Slice NametargetIdentifier
Definition

The target composition/document of this relationship.

ShortTarget of the relationship
Control1..1
TypeIdentifier
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
182. Composition.relatesTo:appended_document.target[x]:targetIdentifier.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
184. Composition.relatesTo:appended_document.target[x]:targetIdentifier.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Composition.relatesTo.target[x].extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
186. Composition.relatesTo:appended_document.target[x]:targetIdentifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control1..1
BindingThe codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
188. Composition.relatesTo:appended_document.target[x]:targetIdentifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

ShortDescription of identifier
Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
190. Composition.relatesTo:appended_document.target[x]:targetIdentifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

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

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

ExampleGeneral: http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
192. Composition.relatesTo:appended_document.target[x]:targetIdentifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
ExampleGeneral: 123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. Composition.relatesTo:appended_document.target[x]:targetIdentifier.period
Definition

Time period during which identifier is/was valid for use.

ShortTime period when id is/was valid for use
Control0..1
TypePeriod
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. Composition.relatesTo:appended_document.target[x]:targetIdentifier.assigner
Definition

Organization that issued/manages the identifier.

ShortOrganization that issued id (may be just text)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control0..1
TypeReference(Organization)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. Composition.event
Definition

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

ShortThe clinical service(s) being documented
Comments

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

Control0..*
TypeBackboneElement
Is Modifierfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
200. 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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
202. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
204. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
206. Composition.event.code
Definition

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

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

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

Control0..*
BindingFor example codes, see v3 Code System ActCode
(example to http://terminology.hl7.org/ValueSet/v3-ActCode)

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

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs",
      "code" : "acp-services",
      "display" : "Advance care planning services"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs"/>
    <code value="acp-services"/>
    <display value="Advance care planning services"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
208. 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
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
210. Composition.event.detail
Definition

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

ShortThe event(s) being documented
Control0..*
TypeReference(Resource)
Is Modifierfalse
Summarytrue
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.detail. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
212. Composition.event.detail:adiFacilitator
Slice NameadiFacilitator
Definition

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

ShortADI Facilitator
Control0..1
TypeReference(ADI Facilitator)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
214. Composition.section
Definition

The root of the sections that make up the composition.

ShortComposition is broken into sections
Control1..*
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 it is empty (emptyReason.empty() or entry.empty())
ele-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. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code

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

216. 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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
218. Composition.section.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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
220. Composition.section.extension:change-made
Slice Namechange-made
Definition

Change Made provides an annotation of a change that has been made to the Composition or Composition section. The extension is experimental and may overlap with other extensions, such as use of note in R6. The extension contains two parts: change - the description of the change, version-changed - the FHIR Clinical Document version that was changed. Note: Calculating a differential between versions is suggested for safely finding all changes as this annotation may not contain all changes between versions.

ShortChange Made
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Change Made) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
222. Composition.section.extension:ClauseExtension
Slice NameClauseExtension
Definition

A clause or set of clauses relevant to the resource or element being extended

ShortClause
Control0..*
TypeExtension(Clause) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
224. 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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
226. Composition.section.title
Definition

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

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

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

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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()))
228. Composition.section.code
Definition

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

ShortClassification of section (recommended)
Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Control0..1
BindingFor example codes, see DocumentSectionCodes
(example to http://hl7.org/fhir/ValueSet/doc-section-codes|4.0.1)

Classification of a section of a composition/document.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
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()))
230. Composition.section.author
Definition

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

ShortWho and/or what authored the section
Control0..*
TypeReference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
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()))
232. 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 not 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 composition
Comments

Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.

Control0..1
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. 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.

Control1..1
This element is affected by the following invariants: cmp-1
TypeNarrative
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
236. Composition.section.mode
Definition

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

Shortworking | snapshot | changes
Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

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

The processing mode that applies to this section.

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

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. 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 ListOrderCodes
(preferred to http://hl7.org/fhir/ValueSet/list-order|4.0.1)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
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()))
240. Composition.section.entry
Definition

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

ShortA reference to data that supports this section
Comments

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

Control0..*
This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
242. Composition.section.emptyReason
Definition

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

ShortWhy the section is empty
Comments

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

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

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
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()))
244. Composition.section.section
Definition

A nested sub-section within this section.

ShortNested Section
Comments

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

Control0..*
This element is affected by the following invariants: cmp-1
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
246. Composition.section:advance_directive_source_form
Slice Nameadvance_directive_source_form
Definition

The root of the sections that make up the composition.

ShortAdvance directive source form
Control1..1
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 it is empty (emptyReason.empty() or entry.empty())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
248. Composition.section:advance_directive_source_form.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
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
250. Composition.section:advance_directive_source_form.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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
252. Composition.section:advance_directive_source_form.extension:change-made
Slice Namechange-made
Definition

Change Made provides an annotation of a change that has been made to the Composition or Composition section. The extension is experimental and may overlap with other extensions, such as use of note in R6. The extension contains two parts: change - the description of the change, version-changed - the FHIR Clinical Document version that was changed. Note: Calculating a differential between versions is suggested for safely finding all changes as this annotation may not contain all changes between versions.

ShortChange Made
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Change Made) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
254. Composition.section:advance_directive_source_form.extension:ADISourceFormJurisdiction
Slice NameADISourceFormJurisdiction
Definition

Jurisdiction for which content is applicable. Represent state jurisdictions as a codeableConcept using the 2-letter state value set, and organization jurisdictions as a string value. This extension is only to be used for DocumentReference. ADI Compositions will instead reference the ADI Jurisdiction profile.

ShortJurisdiction
Control0..1
TypeExtension(Jurisdiction) (Extension Type: Choice of: string, CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
256. Composition.section:advance_directive_source_form.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 manageable, 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()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
258. Composition.section:advance_directive_source_form.title
Definition

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

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

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

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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()))
260. Composition.section:advance_directive_source_form.code
Definition

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

ShortClassification of section (recommended)
Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Control1..1
BindingFor example codes, see DocumentSectionCodes
(example to http://hl7.org/fhir/ValueSet/doc-section-codes|4.0.1)

Classification of a section of a composition/document.

TypeCodeableConcept
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Pattern Value
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs",
      "code" : "advance_directive_source_form"
    }
  ]
}
<code>
  <coding>
    <system value="http://hl7.org/fhir/us/pacio-adi/CodeSystem/adi-temp-cs"/>
    <code value="advance_directive_source_form"/>
  </coding>
</code>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
262. Composition.section:advance_directive_source_form.author
Definition

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

ShortWho and/or what authored the section
Control0..*
TypeReference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
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()))
264. Composition.section:advance_directive_source_form.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 not 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 composition
Comments

Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.

Control0..1
TypeReference(Resource)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
266. Composition.section:advance_directive_source_form.text
Definition

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

ShortText summary of the section, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: cmp-1
TypeNarrative
Is Modifierfalse
Must Supporttrue
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. Composition.section:advance_directive_source_form.mode
Definition

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

Shortworking | snapshot | changes
Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

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

The processing mode that applies to this section.

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

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. Composition.section:advance_directive_source_form.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 ListOrderCodes
(preferred to http://hl7.org/fhir/ValueSet/list-order|4.0.1)

What order applies to the items in the entry.

TypeCodeableConcept
Is Modifierfalse
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()))
272. Composition.section:advance_directive_source_form.entry
Definition

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

ShortA reference to data that supports this section
Comments

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

Control0..*
This element is affected by the following invariants: cmp-2
TypeReference(ADI Source Form)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
274. Composition.section:advance_directive_source_form.emptyReason
Definition

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

ShortWhy the section is empty
Comments

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

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

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
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()))
276. Composition.section:advance_directive_source_form.section
Definition

A nested sub-section within this section.

ShortNested Section
Comments

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

Control0..*
This element is affected by the following invariants: cmp-1
TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))