This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times). See the Directory of published versions
2.8 Resource Composition - Content
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.).
2.8.1 Scope and Usage
A Composition is the basic structure from which FHIR Documents -
immutable bundles with attested narrative - are built. A single logical composition may be
associated with a series of derived documents, each of which is a frozen copy of the
composition.
Note: EN 13606 uses the term "Composition"
to refer to a single commit to an EHR system, and offers some common examples: a composition
containing a consultation note, a progress note, a report or a letter, an investigation report,
a prescription form or a set of bedside nursing observations. Using Composition for an attested
EHR commit is a valid use of the Composition resource, but for FHIR purposes, it would be usual
to make more granular updates with individual provenance statements.
The Clinical Document profile constrains Composition to specify a clinical document
(matching CDA ).
See also the comparison with CDA .
2.8.2 Boundaries and Relationships
Composition is a structure for grouping information for purposes of persistence and attestability.
The Composition resource defines a set of healthcare-related information that is assembled
together into a single logical document that provides a single coherent statement of meaning, establishes its own context and
that has clinical attestation with regard to who is making the statement. The Composition resource provides the basic structure
of a FHIR document . The full content of the document is expressed using a Bundle
containing the Composition and its entries.
There are several other grouping structures in FHIR with distinct purposes:
The List resource - enumerates a flat collection of resources and provides features for managing the collection.
While a particular List instance may represent a "snapshot", from a business process perspective, the notion of "list"
is dynamic – items are added and removed over time. The List resource references other resources. Lists may be
curated and have specific business meaning.
The Group resource - defines a group of specific people, animals, devices, etc. by enumerating them,
or by describing qualities that group members have. The Group resource refers to other resources, possibly implicitly.
Groups are intended to be acted upon or observed as a whole (e.g., performing therapy on a group, calculating risk for a group,
etc.). This resource will commonly be used for public health (e.g., describing an at-risk population), clinical trials (e.g.,
defining a test subject pool) and similar purposes.
The Bundle resource - is an infrastructure container for a group of resources. It does not have narrative
and is used to group collections of resources for transmission, persistence or processing (e.g., messages, documents, transactions,
query responses, etc.). The content of bundles is typically algorithmically determined for a particular exchange or persistence purpose.
The QuestionnaireResponse resource - is similar to Composition in that both organize collections of items and can have a hierarchical structure.
Questionnaires are also intended to help guide 'human' presentation of data. However, Compositions organize resources, while Questionnaires/QuestionnaireResponses organize specific elements.
Also, a Questionnaire represents data 'to be gathered' and is subject-independent, while Compositions represent collections of data that are complete and are about a particular subject.
It is possible for StructureDefinitions or GraphDefinitions to act as 'templates' for FHIR documents that guide what data is collected for a
particular purpose (e.g. a referral), but this differs from the gathering process that a Questionnaire provides where there are specific
questions that must be asked and answered and rules that guide which questions are enabled in which circumstances.
The Composition resource organizes clinical and administrative content into sections, each of which contains a narrative,
and references other resources for supporting data. The narrative content of the various sections in a Composition are
supported by the resources referenced in the section entries. The complete set of content to make up a document includes
the Composition resource together with various resources pointed to or indirectly
connected to the Composition. See the FHIR Documents documentation for guidance on how a Composition
is used when creating a document bundle.
2.8.3 Background and Context
2.8.3.1 Composition Status Codes
Every composition has a status element, which describes the status of the content of the composition, taken from this list of codes:
2.8.3.2 The workflow/clinical status of the composition.
registered
The existence of the composition is registered, but there is nothing yet available.
partial
This is a partial (e.g. initial, interim or preliminary) composition: data in the composition may be incomplete or unverified.
preliminary
Verified early results are available, but not all results are final.
final
This version of the composition is complete and verified by an appropriate person and no further work is planned. Any subsequent updates would be on a new version of the composition.
amended
The composition content or the referenced resources have been modified (edited or added to) subsequent to being released as "final" and the composition is complete and verified by an authorized person.
corrected
Subsequent to being final, the composition content has been modified to correct an error in the composition or referenced results.
appended
Subsequent to being final, the composition content has been modified by adding new content. The existing content is unchanged.
cancelled
The composition is unavailable because the measurement was not started or not completed (also sometimes called "aborted").
entered-in-error
The composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid.
deprecated
This composition has been withdrawn or superseded and should no longer be used.
unknown
The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which.
Composition status generally only moves down through this list - it moves from registered
or preliminary
to final
and then it may progress to amended
.
Note that in many workflows, only final
compositions are made available and the preliminary
status is not used.
A very few compositions are created entirely in error in the workflow - usually the composition concerns the wrong patient or is written by the wrong author,
and the error is only detected after the composition has been used or documents have been derived from it. To support resolution of this case,
the composition is updated to be marked as entered-in-error
and a new derived document can be created. This means that the entire series of derived
documents is now considered to be created in error and systems receiving derived documents based on retracted compositions
SHOULD remove data taken from earlier documents from routine use and/or take other appropriate actions. Systems are not required to
provide this workflow or support documents derived from retracted compositions, but they SHALL NOT ignore a status of entered-in-error
.
Note that systems that handle compositions or derived documents and don't support the error status need to define
some other way of handling compositions that are created in error; while this is not a common occurrence, some clinical systems
have no provision for removing erroneous information from a patient's record, and there is no way for a user to know that it is not fit for use -
this is not safe.
2.8.3.3 Note for CDA aware readers
Many users of this specification are familiar with the Clinical Document Architecture (CDA) and related specifications.
CDA is a primary design input to the Composition resource (other principal inputs are other HL7 document specifications and EN13606). There are three important structural
differences between CDA and the Composition resource:
A composition is a logical construct - its identifier
matches to the CDA ClinicalDocument.setId
.
Composition resources are wrapped into Document structures, for exchange
of the whole package (the composition and its parts), and this wrapped, sealed entity is equivalent to a CDA document,
where the where the Bundle.identifier
is equivalent to ClinicalDocument.id
and Bundle.meta.security
is equivalent to ClinicalDocument.confidentialityCode
.
The composition section defines a section (or sub-section) of the document, but unlike CDA, the section entries are
actually references to other resources that hold the supporting data content for the section.
This design means that the data can be reused in many other ways.
Unlike CDA, the context defined in the Composition
(the subject, author, event, event period and encounter) apply to the composition and do not specifically apply to the resources referenced from
the section.entry
. There is no context flow model in FHIR, so each resource referenced from
within a Composition
expresses its own individual context. In this way, clinical content can
safely be extracted from the composition.
In addition, note that both the code lists (e.g., Composition.status ) and the Composition resource are mapped to HL7 v3 and/or CDA.
2.8.4 References to this Resource
2.8.5
Resource Content
Structure
Name Flags Card. Type Description & Constraints
Composition
TU
DomainResource
A set of resources composed into a single coherent clinical statement with clinical attestation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
url
Σ
0..1
uri
Canonical identifier for this Composition, represented as a URI (globally unique)
identifier
Σ
0..*
Identifier
Version-independent identifier for the Composition
version
Σ
0..1
string
An explicitly assigned identifier of a variation of the content in the Composition
status
?! Σ
1..1
code
registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: Composition Status (Required )
type
Σ
1..1
CodeableConcept
Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (Preferred )
category
Σ
0..*
CodeableConcept
Categorization of Composition Binding: Referenced Item Category Value Set (Example )
subject
Σ
0..*
Reference (Any )
Who and/or what the composition is about
encounter
Σ
0..1
Reference (Encounter )
Context of the Composition
date
Σ
1..1
dateTime
Composition editing time
useContext
Σ
0..*
UsageContext
The context that the content is intended to support
author
Σ
1..*
Reference (Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization )
Who and/or what authored the composition
name
Σ
0..1
string
Name for this Composition (computer friendly)
title
Σ
1..1
string
Human Readable name/title
note
0..*
Annotation
For any additional notes
attester
0..*
BackboneElement
Attests to accuracy of composition
mode
1..1
CodeableConcept
personal | professional | legal | official Binding: Composition Attestation Mode (Preferred )
time
0..1
dateTime
When the composition was attested
party
0..1
Reference (Patient | RelatedPerson | Practitioner | PractitionerRole | Organization )
Who attested the composition
custodian
Σ
0..1
Reference (Organization )
Organization which maintains the composition
relatesTo
0..*
RelatedArtifact
Relationships to other compositions/documents
event
Σ
0..*
BackboneElement
The clinical service(s) being documented
period
Σ
0..1
Period
The period covered by the documentation
detail
Σ
0..*
CodeableReference (Any )
The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (Example )
section
C
0..*
BackboneElement
Composition is broken into sections+ Rule: A section must contain at least one of text, entries, or sub-sections + Rule: A section can only have an emptyReason if no entries are included
title
0..1
string
Label for section (e.g. for ToC)
code
0..1
CodeableConcept
Classification of section (recommended) Binding: Document Section Codes (Example )
author
0..*
Reference (Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization )
Who and/or what authored the section, when the section is authored by someone other than the composition.author
focus
0..1
Reference (Any )
Who/what the section is about, when it is not about the subject of composition
text
C
0..1
Narrative
Text summary of the section, for human interpretation
orderedBy
0..1
CodeableConcept
Order of section entries Binding: List Order Codes (Preferred )
entry
C
0..*
Reference (Any )
A reference to data that supports this section
emptyReason
C
0..1
CodeableConcept
Why the section is empty Binding: List Empty Reasons (Preferred )
section
0..*
see section
Nested Section
Documentation for this format
See the Extensions for this resource
UML Diagram (Legend )
Composition (DomainResource ) An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers url : uri [0..1]A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time identifier : Identifier [0..*]An explicitly assigned identifier of a variation of the content in the Composition version : string [0..1]The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) CompositionStatus ! »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 type : CodeableConcept [1..1] « null (Strength=Preferred) FHIRDocumentTypeCodes ? »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 category : CodeableConcept [0..*] « null (Strength=Example) ReferencedItemCategoryValueSet ?? »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) subject : Reference [0..*] « Any »Describes the clinical encounter or type of care this documentation is associated with encounter : Reference [0..1] « Encounter »The composition editing time, when the composition was last logically changed by the author date : dateTime [1..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances useContext : UsageContext [0..*]Identifies who is responsible for the information in the composition, not necessarily who typed it in author : Reference [1..*] « Practitioner |PractitionerRole |CareTeam | Device |Patient |RelatedPerson |Organization » A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1]Official human-readable label for the composition title : string [1..1]For any additional notes note : Annotation [0..*]Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information custodian : Reference [0..1] « Organization »Relationships that this composition has with other compositions or documents that already exist relatesTo : RelatedArtifact [0..*]Attester The type of attestation the authenticator offers mode : CodeableConcept [1..1] « null (Strength=Preferred) CompositionAttestationMode ? »When the composition was attested by the party time : dateTime [0..1]Who attested the composition in the specified way party : Reference [0..1] « Patient |RelatedPerson |Practitioner | PractitionerRole |Organization » Event 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 period : Period [0..1]Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource detail : CodeableReference [0..*] « Any ; null (Strength=Example) ActCode ?? »Section 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 title : string [0..1]A code identifying the kind of content contained within the section. This must be consistent with the section title code : CodeableConcept [0..1] « null (Strength=Example) DocumentSectionCodes ?? »Identifies who is responsible for the information in this section, not necessarily who typed it in.
The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition author : Reference [0..*] « Practitioner |PractitionerRole |CareTeam | Device |Patient |RelatedPerson |Organization » 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) focus : Reference [0..1] « Any »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 text : Narrative [0..1] « This element has or is affected by some invariants C »Specifies the order applied to the items in the section entries orderedBy : CodeableConcept [0..1] « null (Strength=Preferred) ListOrderCodes ? »A reference to the actual resource from which the narrative in the section is derived entry : Reference [0..*] « Any » « This element has or is affected by some invariants C »If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason emptyReason : CodeableConcept [0..1] « null (Strength=Preferred) ListEmptyReasons ? » « This element has or is affected by some invariants C »A participant who has attested to the accuracy of the composition/document attester[0..*] The clinical service, such as a colonoscopy or an appendectomy, being documented event[0..*] A nested sub-section within this section section[0..*] The root of the sections that make up the composition section[0..*]
XML Template
<Composition xmlns="http://hl7.org/fhir">
<!-- from Resource : id , meta , implicitRules , and language -->
<!-- from DomainResource : text , contained , extension , and modifierExtension -->
<url value="[uri ]"/><!-- 0..1 Canonical identifier for this Composition, represented as a URI (globally unique) -->
<identifier ><!-- 0..* Identifier Version-independent identifier for the Composition --> </identifier>
<version value="[string ]"/><!-- 0..1 An explicitly assigned identifier of a variation of the content in the Composition -->
<status value="[code ]"/><!-- 1..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown -->
<type ><!-- 1..1 CodeableConcept Kind of composition (LOINC if possible) --> </type>
<category ><!-- 0..* CodeableConcept Categorization of Composition --> </category>
<subject ><!-- 0..* Reference (Any ) Who and/or what the composition is about --> </subject>
<encounter ><!-- 0..1 Reference (Encounter ) Context of the Composition --> </encounter>
<date value="[dateTime ]"/><!-- 1..1 Composition editing time -->
<useContext ><!-- 0..* UsageContext The context that the content is intended to support --> </useContext>
<author ><!-- 1..* Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) Who and/or what authored the composition --> </author>
<name value="[string ]"/><!-- 0..1 Name for this Composition (computer friendly) -->
<title value="[string ]"/><!-- 1..1 Human Readable name/title -->
<note ><!-- 0..* Annotation For any additional notes --> </note>
<attester > <!-- 0..* Attests to accuracy of composition -->
<mode ><!-- 1..1 CodeableConcept personal | professional | legal | official --> </mode>
<time value="[dateTime ]"/><!-- 0..1 When the composition was attested -->
<party ><!-- 0..1 Reference (Organization |Patient |Practitioner |PractitionerRole |
RelatedPerson ) Who attested the composition --> </party>
</attester>
<custodian ><!-- 0..1 Reference (Organization ) Organization which maintains the composition --> </custodian>
<relatesTo ><!-- 0..* RelatedArtifact Relationships to other compositions/documents --> </relatesTo>
<event > <!-- 0..* The clinical service(s) being documented -->
<period ><!-- 0..1 Period The period covered by the documentation --> </period>
<detail ><!-- 0..* CodeableReference (Any ) The event(s) being documented, as code(s), reference(s), or both --> </detail>
</event>
<section > <!-- 0..* Composition is broken into sections -->
<title value="[string ]"/><!-- 0..1 Label for section (e.g. for ToC) -->
<code ><!-- 0..1 CodeableConcept Classification of section (recommended) --> </code>
<author ><!-- 0..* Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) Who and/or what authored the section, when the section is authored by someone other than the composition.author --> </author>
<focus ><!-- 0..1 Reference (Any ) Who/what the section is about, when it is not about the subject of composition --> </focus>
<text ><!-- I 0..1 Narrative Text summary of the section, for human interpretation --> </text>
<orderedBy ><!-- 0..1 CodeableConcept Order of section entries --> </orderedBy>
<entry ><!-- I 0..* Reference (Any ) A reference to data that supports this section --> </entry>
<emptyReason ><!-- I 0..1 CodeableConcept Why the section is empty --> </emptyReason>
<section ><!-- 0..* Content as for Composition.section Nested Section --> </section>
</section>
</Composition>
JSON Template
{
"resourceType" : "Composition ",
// from Resource : id , meta , implicitRules , and language
// from DomainResource : text , contained , extension , and modifierExtension
"url " : "<uri >", // Canonical identifier for this Composition, represented as a URI (globally unique)
"identifier " : [{ Identifier }], // Version-independent identifier for the Composition
"version " : "<string >", // An explicitly assigned identifier of a variation of the content in the Composition
"status " : "<code >", // R! registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
"type " : { CodeableConcept }, // R! Kind of composition (LOINC if possible)
"category " : [{ CodeableConcept }], // Categorization of Composition
"subject " : [{ Reference (Any ) }], // Who and/or what the composition is about
"encounter " : { Reference (Encounter ) }, // Context of the Composition
"date " : "<dateTime >", // R! Composition editing time
"useContext " : [{ UsageContext }], // The context that the content is intended to support
"author " : [{ Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) }], // R! Who and/or what authored the composition
"name " : "<string >", // Name for this Composition (computer friendly)
"title " : "<string >", // R! Human Readable name/title
"note " : [{ Annotation }], // For any additional notes
"attester " : [{ // Attests to accuracy of composition
"mode " : { CodeableConcept }, // R! personal | professional | legal | official
"time " : "<dateTime >", // When the composition was attested
"party " : { Reference (Organization |Patient |Practitioner |PractitionerRole |
RelatedPerson ) } // Who attested the composition
}],
"custodian " : { Reference (Organization ) }, // Organization which maintains the composition
"relatesTo " : [{ RelatedArtifact }], // Relationships to other compositions/documents
"event " : [{ // The clinical service(s) being documented
"period " : { Period }, // The period covered by the documentation
"detail " : [{ CodeableReference (Any ) }] // The event(s) being documented, as code(s), reference(s), or both
}],
"section " : [{ // Composition is broken into sections
"title " : "<string >", // Label for section (e.g. for ToC)
"code " : { CodeableConcept }, // Classification of section (recommended)
"author " : [{ Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) }], // Who and/or what authored the section, when the section is authored by someone other than the composition.author
"focus " : { Reference (Any ) }, // Who/what the section is about, when it is not about the subject of composition
"text " : { Narrative }, // I Text summary of the section, for human interpretation
"orderedBy " : { CodeableConcept }, // Order of section entries
"entry " : [{ Reference (Any ) }], // I A reference to data that supports this section
"emptyReason " : { CodeableConcept }, // I Why the section is empty
"section " : [{ Content as for Composition.section }] // Nested Section
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
[ a fhir:Composition ;
fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from Resource : .id , .meta , .implicitRules , and .language
# from DomainResource : .text , .contained , .extension , and .modifierExtension
fhir:url [ uri ] ; # 0..1 Canonical identifier for this Composition, represented as a URI (globally unique)
fhir:identifier ( [ Identifier ] ... ) ; # 0..* Version-independent identifier for the Composition
fhir:version [ string ] ; # 0..1 An explicitly assigned identifier of a variation of the content in the Composition
fhir:status [ code ] ; # 1..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
fhir:type [ CodeableConcept ] ; # 1..1 Kind of composition (LOINC if possible)
fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Categorization of Composition
fhir:subject ( [ Reference (Any ) ] ... ) ; # 0..* Who and/or what the composition is about
fhir:encounter [ Reference (Encounter ) ] ; # 0..1 Context of the Composition
fhir:date [ dateTime ] ; # 1..1 Composition editing time
fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
fhir:author ( [ Reference (CareTeam |Device |Organization |Patient |Practitioner |PractitionerRole |RelatedPerson ) ] ... ) ; # 1..* Who and/or what authored the composition
fhir:name [ string ] ; # 0..1 Name for this Composition (computer friendly)
fhir:title [ string ] ; # 1..1 Human Readable name/title
fhir:note ( [ Annotation ] ... ) ; # 0..* For any additional notes
fhir:attester ( [ # 0..* Attests to accuracy of composition
fhir:mode [ CodeableConcept ] ; # 1..1 personal | professional | legal | official
fhir:time [ dateTime ] ; # 0..1 When the composition was attested
fhir:party [ Reference (Organization |Patient |Practitioner |PractitionerRole |RelatedPerson ) ] ; # 0..1 Who attested the composition
] ... ) ;
fhir:custodian [ Reference (Organization ) ] ; # 0..1 Organization which maintains the composition
fhir:relatesTo ( [ RelatedArtifact ] ... ) ; # 0..* Relationships to other compositions/documents
fhir:event ( [ # 0..* The clinical service(s) being documented
fhir:period [ Period ] ; # 0..1 The period covered by the documentation
fhir:detail ( [ CodeableReference (Any ) ] ... ) ; # 0..* The event(s) being documented, as code(s), reference(s), or both
] ... ) ;
fhir:section ( [ # 0..* Composition is broken into sections
fhir:title [ string ] ; # 0..1 Label for section (e.g. for ToC)
fhir:code [ CodeableConcept ] ; # 0..1 Classification of section (recommended)
fhir:author ( [ Reference (CareTeam |Device |Organization |Patient |Practitioner |PractitionerRole |RelatedPerson ) ] ... ) ; # 0..* Who and/or what authored the section, when the section is authored by someone other than the composition.author
fhir:focus [ Reference (Any ) ] ; # 0..1 Who/what the section is about, when it is not about the subject of composition
fhir:text [ Narrative ] ; # 0..1 I Text summary of the section, for human interpretation
fhir:orderedBy [ CodeableConcept ] ; # 0..1 Order of section entries
fhir:entry ( [ Reference (Any ) ] ... ) ; # 0..* I A reference to data that supports this section
fhir:emptyReason [ CodeableConcept ] ; # 0..1 I Why the section is empty
fhir:section ( [ See Composition.section ] ... ) ; # 0..* Nested Section
] ... ) ;
]
Changes from both R4 and R4B
Composition
Composition.url
Composition.identifier
Max Cardinality changed from 1 to *
Composition.version
Composition.status
Add codes registered
, partial
, corrected
, appended
, cancelled
, deprecated
, unknown
Composition.subject
Max Cardinality changed from 1 to *
Composition.useContext
Composition.author
Type Reference: Added Target Type CareTeam
Composition.name
Composition.note
Composition.attester.mode
Type changed from code to CodeableConcept Remove Binding `http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.0` (required)
Composition.relatesTo
Type changed from BackboneElement to RelatedArtifact
Composition.event.detail
Type changed from Reference(Resource) to CodeableReference
Composition.section.author
Type Reference: Added Target Type CareTeam
Composition.confidentiality
Composition.relatesTo.code
Composition.relatesTo.target[x]
Composition.event.code
Composition.section.mode
See the Full Difference for further information
This analysis is available for R4 as XML or JSON
and for R4B as XML or JSON .
Structure
Name Flags Card. Type Description & Constraints
Composition
TU
DomainResource
A set of resources composed into a single coherent clinical statement with clinical attestation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
url
Σ
0..1
uri
Canonical identifier for this Composition, represented as a URI (globally unique)
identifier
Σ
0..*
Identifier
Version-independent identifier for the Composition
version
Σ
0..1
string
An explicitly assigned identifier of a variation of the content in the Composition
status
?! Σ
1..1
code
registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: Composition Status (Required )
type
Σ
1..1
CodeableConcept
Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (Preferred )
category
Σ
0..*
CodeableConcept
Categorization of Composition Binding: Referenced Item Category Value Set (Example )
subject
Σ
0..*
Reference (Any )
Who and/or what the composition is about
encounter
Σ
0..1
Reference (Encounter )
Context of the Composition
date
Σ
1..1
dateTime
Composition editing time
useContext
Σ
0..*
UsageContext
The context that the content is intended to support
author
Σ
1..*
Reference (Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization )
Who and/or what authored the composition
name
Σ
0..1
string
Name for this Composition (computer friendly)
title
Σ
1..1
string
Human Readable name/title
note
0..*
Annotation
For any additional notes
attester
0..*
BackboneElement
Attests to accuracy of composition
mode
1..1
CodeableConcept
personal | professional | legal | official Binding: Composition Attestation Mode (Preferred )
time
0..1
dateTime
When the composition was attested
party
0..1
Reference (Patient | RelatedPerson | Practitioner | PractitionerRole | Organization )
Who attested the composition
custodian
Σ
0..1
Reference (Organization )
Organization which maintains the composition
relatesTo
0..*
RelatedArtifact
Relationships to other compositions/documents
event
Σ
0..*
BackboneElement
The clinical service(s) being documented
period
Σ
0..1
Period
The period covered by the documentation
detail
Σ
0..*
CodeableReference (Any )
The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (Example )
section
C
0..*
BackboneElement
Composition is broken into sections+ Rule: A section must contain at least one of text, entries, or sub-sections + Rule: A section can only have an emptyReason if no entries are included
title
0..1
string
Label for section (e.g. for ToC)
code
0..1
CodeableConcept
Classification of section (recommended) Binding: Document Section Codes (Example )
author
0..*
Reference (Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization )
Who and/or what authored the section, when the section is authored by someone other than the composition.author
focus
0..1
Reference (Any )
Who/what the section is about, when it is not about the subject of composition
text
C
0..1
Narrative
Text summary of the section, for human interpretation
orderedBy
0..1
CodeableConcept
Order of section entries Binding: List Order Codes (Preferred )
entry
C
0..*
Reference (Any )
A reference to data that supports this section
emptyReason
C
0..1
CodeableConcept
Why the section is empty Binding: List Empty Reasons (Preferred )
section
0..*
see section
Nested Section
Documentation for this format
See the Extensions for this resource
UML Diagram (Legend )
Composition (DomainResource ) An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers url : uri [0..1]A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time identifier : Identifier [0..*]An explicitly assigned identifier of a variation of the content in the Composition version : string [0..1]The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) CompositionStatus ! »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 type : CodeableConcept [1..1] « null (Strength=Preferred) FHIRDocumentTypeCodes ? »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 category : CodeableConcept [0..*] « null (Strength=Example) ReferencedItemCategoryValueSet ?? »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) subject : Reference [0..*] « Any »Describes the clinical encounter or type of care this documentation is associated with encounter : Reference [0..1] « Encounter »The composition editing time, when the composition was last logically changed by the author date : dateTime [1..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances useContext : UsageContext [0..*]Identifies who is responsible for the information in the composition, not necessarily who typed it in author : Reference [1..*] « Practitioner |PractitionerRole |CareTeam | Device |Patient |RelatedPerson |Organization » A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1]Official human-readable label for the composition title : string [1..1]For any additional notes note : Annotation [0..*]Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information custodian : Reference [0..1] « Organization »Relationships that this composition has with other compositions or documents that already exist relatesTo : RelatedArtifact [0..*]Attester The type of attestation the authenticator offers mode : CodeableConcept [1..1] « null (Strength=Preferred) CompositionAttestationMode ? »When the composition was attested by the party time : dateTime [0..1]Who attested the composition in the specified way party : Reference [0..1] « Patient |RelatedPerson |Practitioner | PractitionerRole |Organization » Event 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 period : Period [0..1]Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource detail : CodeableReference [0..*] « Any ; null (Strength=Example) ActCode ?? »Section 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 title : string [0..1]A code identifying the kind of content contained within the section. This must be consistent with the section title code : CodeableConcept [0..1] « null (Strength=Example) DocumentSectionCodes ?? »Identifies who is responsible for the information in this section, not necessarily who typed it in.
The actual author of the section when it is not the author of the composition. If author is not specified, the author is assumed to be the author of the parent section or the author of the composition author : Reference [0..*] « Practitioner |PractitionerRole |CareTeam | Device |Patient |RelatedPerson |Organization » 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) focus : Reference [0..1] « Any »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 text : Narrative [0..1] « This element has or is affected by some invariants C »Specifies the order applied to the items in the section entries orderedBy : CodeableConcept [0..1] « null (Strength=Preferred) ListOrderCodes ? »A reference to the actual resource from which the narrative in the section is derived entry : Reference [0..*] « Any » « This element has or is affected by some invariants C »If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason emptyReason : CodeableConcept [0..1] « null (Strength=Preferred) ListEmptyReasons ? » « This element has or is affected by some invariants C »A participant who has attested to the accuracy of the composition/document attester[0..*] The clinical service, such as a colonoscopy or an appendectomy, being documented event[0..*] A nested sub-section within this section section[0..*] The root of the sections that make up the composition section[0..*]
XML Template
<Composition xmlns="http://hl7.org/fhir">
<!-- from Resource : id , meta , implicitRules , and language -->
<!-- from DomainResource : text , contained , extension , and modifierExtension -->
<url value="[uri ]"/><!-- 0..1 Canonical identifier for this Composition, represented as a URI (globally unique) -->
<identifier ><!-- 0..* Identifier Version-independent identifier for the Composition --> </identifier>
<version value="[string ]"/><!-- 0..1 An explicitly assigned identifier of a variation of the content in the Composition -->
<status value="[code ]"/><!-- 1..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown -->
<type ><!-- 1..1 CodeableConcept Kind of composition (LOINC if possible) --> </type>
<category ><!-- 0..* CodeableConcept Categorization of Composition --> </category>
<subject ><!-- 0..* Reference (Any ) Who and/or what the composition is about --> </subject>
<encounter ><!-- 0..1 Reference (Encounter ) Context of the Composition --> </encounter>
<date value="[dateTime ]"/><!-- 1..1 Composition editing time -->
<useContext ><!-- 0..* UsageContext The context that the content is intended to support --> </useContext>
<author ><!-- 1..* Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) Who and/or what authored the composition --> </author>
<name value="[string ]"/><!-- 0..1 Name for this Composition (computer friendly) -->
<title value="[string ]"/><!-- 1..1 Human Readable name/title -->
<note ><!-- 0..* Annotation For any additional notes --> </note>
<attester > <!-- 0..* Attests to accuracy of composition -->
<mode ><!-- 1..1 CodeableConcept personal | professional | legal | official --> </mode>
<time value="[dateTime ]"/><!-- 0..1 When the composition was attested -->
<party ><!-- 0..1 Reference (Organization |Patient |Practitioner |PractitionerRole |
RelatedPerson ) Who attested the composition --> </party>
</attester>
<custodian ><!-- 0..1 Reference (Organization ) Organization which maintains the composition --> </custodian>
<relatesTo ><!-- 0..* RelatedArtifact Relationships to other compositions/documents --> </relatesTo>
<event > <!-- 0..* The clinical service(s) being documented -->
<period ><!-- 0..1 Period The period covered by the documentation --> </period>
<detail ><!-- 0..* CodeableReference (Any ) The event(s) being documented, as code(s), reference(s), or both --> </detail>
</event>
<section > <!-- 0..* Composition is broken into sections -->
<title value="[string ]"/><!-- 0..1 Label for section (e.g. for ToC) -->
<code ><!-- 0..1 CodeableConcept Classification of section (recommended) --> </code>
<author ><!-- 0..* Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) Who and/or what authored the section, when the section is authored by someone other than the composition.author --> </author>
<focus ><!-- 0..1 Reference (Any ) Who/what the section is about, when it is not about the subject of composition --> </focus>
<text ><!-- I 0..1 Narrative Text summary of the section, for human interpretation --> </text>
<orderedBy ><!-- 0..1 CodeableConcept Order of section entries --> </orderedBy>
<entry ><!-- I 0..* Reference (Any ) A reference to data that supports this section --> </entry>
<emptyReason ><!-- I 0..1 CodeableConcept Why the section is empty --> </emptyReason>
<section ><!-- 0..* Content as for Composition.section Nested Section --> </section>
</section>
</Composition>
JSON Template
{
"resourceType" : "Composition ",
// from Resource : id , meta , implicitRules , and language
// from DomainResource : text , contained , extension , and modifierExtension
"url " : "<uri >", // Canonical identifier for this Composition, represented as a URI (globally unique)
"identifier " : [{ Identifier }], // Version-independent identifier for the Composition
"version " : "<string >", // An explicitly assigned identifier of a variation of the content in the Composition
"status " : "<code >", // R! registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
"type " : { CodeableConcept }, // R! Kind of composition (LOINC if possible)
"category " : [{ CodeableConcept }], // Categorization of Composition
"subject " : [{ Reference (Any ) }], // Who and/or what the composition is about
"encounter " : { Reference (Encounter ) }, // Context of the Composition
"date " : "<dateTime >", // R! Composition editing time
"useContext " : [{ UsageContext }], // The context that the content is intended to support
"author " : [{ Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) }], // R! Who and/or what authored the composition
"name " : "<string >", // Name for this Composition (computer friendly)
"title " : "<string >", // R! Human Readable name/title
"note " : [{ Annotation }], // For any additional notes
"attester " : [{ // Attests to accuracy of composition
"mode " : { CodeableConcept }, // R! personal | professional | legal | official
"time " : "<dateTime >", // When the composition was attested
"party " : { Reference (Organization |Patient |Practitioner |PractitionerRole |
RelatedPerson ) } // Who attested the composition
}],
"custodian " : { Reference (Organization ) }, // Organization which maintains the composition
"relatesTo " : [{ RelatedArtifact }], // Relationships to other compositions/documents
"event " : [{ // The clinical service(s) being documented
"period " : { Period }, // The period covered by the documentation
"detail " : [{ CodeableReference (Any ) }] // The event(s) being documented, as code(s), reference(s), or both
}],
"section " : [{ // Composition is broken into sections
"title " : "<string >", // Label for section (e.g. for ToC)
"code " : { CodeableConcept }, // Classification of section (recommended)
"author " : [{ Reference (CareTeam |Device |Organization |Patient |Practitioner |
PractitionerRole |RelatedPerson ) }], // Who and/or what authored the section, when the section is authored by someone other than the composition.author
"focus " : { Reference (Any ) }, // Who/what the section is about, when it is not about the subject of composition
"text " : { Narrative }, // I Text summary of the section, for human interpretation
"orderedBy " : { CodeableConcept }, // Order of section entries
"entry " : [{ Reference (Any ) }], // I A reference to data that supports this section
"emptyReason " : { CodeableConcept }, // I Why the section is empty
"section " : [{ Content as for Composition.section }] // Nested Section
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
[ a fhir:Composition ;
fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from Resource : .id , .meta , .implicitRules , and .language
# from DomainResource : .text , .contained , .extension , and .modifierExtension
fhir:url [ uri ] ; # 0..1 Canonical identifier for this Composition, represented as a URI (globally unique)
fhir:identifier ( [ Identifier ] ... ) ; # 0..* Version-independent identifier for the Composition
fhir:version [ string ] ; # 0..1 An explicitly assigned identifier of a variation of the content in the Composition
fhir:status [ code ] ; # 1..1 registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
fhir:type [ CodeableConcept ] ; # 1..1 Kind of composition (LOINC if possible)
fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Categorization of Composition
fhir:subject ( [ Reference (Any ) ] ... ) ; # 0..* Who and/or what the composition is about
fhir:encounter [ Reference (Encounter ) ] ; # 0..1 Context of the Composition
fhir:date [ dateTime ] ; # 1..1 Composition editing time
fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
fhir:author ( [ Reference (CareTeam |Device |Organization |Patient |Practitioner |PractitionerRole |RelatedPerson ) ] ... ) ; # 1..* Who and/or what authored the composition
fhir:name [ string ] ; # 0..1 Name for this Composition (computer friendly)
fhir:title [ string ] ; # 1..1 Human Readable name/title
fhir:note ( [ Annotation ] ... ) ; # 0..* For any additional notes
fhir:attester ( [ # 0..* Attests to accuracy of composition
fhir:mode [ CodeableConcept ] ; # 1..1 personal | professional | legal | official
fhir:time [ dateTime ] ; # 0..1 When the composition was attested
fhir:party [ Reference (Organization |Patient |Practitioner |PractitionerRole |RelatedPerson ) ] ; # 0..1 Who attested the composition
] ... ) ;
fhir:custodian [ Reference (Organization ) ] ; # 0..1 Organization which maintains the composition
fhir:relatesTo ( [ RelatedArtifact ] ... ) ; # 0..* Relationships to other compositions/documents
fhir:event ( [ # 0..* The clinical service(s) being documented
fhir:period [ Period ] ; # 0..1 The period covered by the documentation
fhir:detail ( [ CodeableReference (Any ) ] ... ) ; # 0..* The event(s) being documented, as code(s), reference(s), or both
] ... ) ;
fhir:section ( [ # 0..* Composition is broken into sections
fhir:title [ string ] ; # 0..1 Label for section (e.g. for ToC)
fhir:code [ CodeableConcept ] ; # 0..1 Classification of section (recommended)
fhir:author ( [ Reference (CareTeam |Device |Organization |Patient |Practitioner |PractitionerRole |RelatedPerson ) ] ... ) ; # 0..* Who and/or what authored the section, when the section is authored by someone other than the composition.author
fhir:focus [ Reference (Any ) ] ; # 0..1 Who/what the section is about, when it is not about the subject of composition
fhir:text [ Narrative ] ; # 0..1 I Text summary of the section, for human interpretation
fhir:orderedBy [ CodeableConcept ] ; # 0..1 Order of section entries
fhir:entry ( [ Reference (Any ) ] ... ) ; # 0..* I A reference to data that supports this section
fhir:emptyReason [ CodeableConcept ] ; # 0..1 I Why the section is empty
fhir:section ( [ See Composition.section ] ... ) ; # 0..* Nested Section
] ... ) ;
]
Changes from both R4 and R4B
Composition
Composition.url
Composition.identifier
Max Cardinality changed from 1 to *
Composition.version
Composition.status
Add codes registered
, partial
, corrected
, appended
, cancelled
, deprecated
, unknown
Composition.subject
Max Cardinality changed from 1 to *
Composition.useContext
Composition.author
Type Reference: Added Target Type CareTeam
Composition.name
Composition.note
Composition.attester.mode
Type changed from code to CodeableConcept Remove Binding `http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.0` (required)
Composition.relatesTo
Type changed from BackboneElement to RelatedArtifact
Composition.event.detail
Type changed from Reference(Resource) to CodeableReference
Composition.section.author
Type Reference: Added Target Type CareTeam
Composition.confidentiality
Composition.relatesTo.code
Composition.relatesTo.target[x]
Composition.event.code
Composition.section.mode
See the Full Difference for further information
This analysis is available for R4 as XML or JSON
and for R4B as XML or JSON .
Additional definitions: Master Definition XML + JSON ,
XML Schema /Schematron + JSON
Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis
2.8.5.1
Terminology Bindings
Path
ValueSet
Type
Documentation
Composition.status
CompositionStatus
Required
The workflow/clinical status of the composition.
Composition.type
FHIRDocumentTypeCodes
Preferred
FHIR Document Codes - all LOINC codes where scale type = 'DOC'.
Composition.category
ReferencedItemCategoryValueSet
Example
This is the code specifying the high-level kind of document (e.g. Prescription, Discharge Summary, Report, etc.). Made up of a set of non-healthcare specific codes and all LOINC codes where scale type = 'DOC'.
Composition.attester.mode
CompositionAttestationMode
Preferred
The way in which a person authenticated a composition.
Composition.event.detail
ActCode
Example
A code specifying the particular kind of Act that the Act-instance represents within its class. Constraints:
The kind of Act (e.g. physical examination, serum potassium, inpatient encounter, charge financial transaction, etc.) is specified with a code from one of several, typically external, coding systems. The coding system will depend on the class of Act, such as LOINC for observations, etc. Conceptually, the Act.code must be a specialization of the Act.classCode. This is why the structure of ActClass domain should be reflected in the superstructure of the ActCode domain and then individual codes or externally referenced vocabularies subordinated under these domains that reflect the ActClass structure. Act.classCode and Act.code are not modifiers of each other but the Act.code concept should really imply the Act.classCode concept. For a negative example, it is not appropriate to use an Act.code "potassium" together with and Act.classCode for "laboratory observation" to somehow mean "potassium laboratory observation" and then use the same Act.code for "potassium" together with Act.classCode for "medication" to mean "substitution of potassium". This mutually modifying use of Act.code and Act.classCode is not permitted.
Composition.section.code
DocumentSectionCodes
Example
Document section codes (LOINC codes used in CCDA sections).
Composition.section.orderedBy
ListOrderCodes
Preferred
Base values for the order of the items in a list resource.
Composition.section.emptyReason
ListEmptyReasons
Preferred
General reasons for a list to be empty. Reasons are either related to a summary list (i.e. problem or medication list) or to a workflow related list (i.e. consultation list).
2.8.5.2 Constraints
UniqueKey Level Location Description Expression cmp-1Rule Composition.section A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists() cmp-2Rule Composition.section A section can only have an emptyReason if no entries are included emptyReason.empty() or entry.empty()
2.8.6
Notes:
The author and the attester are often the same person, but this might not be the case in some clinical workflows.
The attester attests contents of the document resource, the subject resource and the resources referred to
in the Composition.section.content references. Because documents are often derived Compositions and the attestation
from the composition is held to apply to the document, the method for presenting a document
should be used when/if attesters review the content of the composition.
The custodian is responsible for the maintenance of the composition and any documents derived from it. With regard to the documents, they are
responsible for the policy regarding persistence of the documents. Although they need not actually retain a copy of the document, they SHOULD do so.
It is acceptable for a Composition to contain only narrative (Composition.section.text
) and no entries (Composition.section.entry
)
2.8.7
Compositions about multiple entities
Typically, a composition is made about the subject - e.g. a patient, or group of patients, location, or device - and the
distinction between the subject and the composition describes the subject. Some kinds of documents contain data about other
parties or entities that are relevant to the subject of the document. Some examples:
A neonatal discharge summary that contains information about the mother
A family history document that contains multiple sections for different family members
A social health evaluation document that contains information about the patient's family members
A procedure report that contains details about a device implanted in the patient
In all these cases, the subject of the document is a single patient, but some of the details are actually
related to other persons or entities. When this happens, these other entities are detailed in the Composition.section.focus
element.
In the absence of a focus
, it is assumed that the subject
of the composition is the focus.
If a focus
is specified, then the resources referred to from the section SHALL
either:
specify that their subject
(however named e.g. patient
) or focus
element (if present) is the focus indicated
not have a subject
element
A few compositions genuinely cover multiple subjects - different sections are about different subjects. In such
case, Composition.subject
is omitted, and the extension section-subject
is used on each section to indicate the subject.
Note to Implementers:
Feedback is welcome on two issues related to Composition:
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 during the trial use period.
A client can ask a server to generate a fully bundled document from a Composition resource using the $document operation. This operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question.
Feedback here .
2.8.8 Search Parameters
Search parameters for this resource. See also the full list of search parameters for this resource ,
and check the Extensions registry for search parameters on extensions related to this resource.
The common parameters also apply. See Searching for more
information about searching in REST, messaging, and services.
Name
Type
Description
Expression
In Common
attester
reference
Who attested the composition
Composition.attester.party (Practitioner , Organization , Patient , PractitionerRole , RelatedPerson )
author
reference
Who and/or what authored the composition
Composition.author (Practitioner , Organization , CareTeam , Device , Patient , PractitionerRole , RelatedPerson )
category
token
Categorization of Composition
Composition.category
date
date
Composition editing time
Composition.date
26 Resources
encounter
reference
Context of the Composition
Composition.encounter (Encounter )
29 Resources
entry
reference
A reference to data that supports this section
Composition.section.entry (Any)
event-code
token
Main clinical acts documented as codes
Composition.event.detail.concept
event-reference
reference
Main clinical acts documented as references
Composition.event.detail.reference
identifier
token
Version-independent identifier for the Composition
Composition.identifier
65 Resources
patient
reference
Who and/or what the composition is about
Composition.subject.where(resolve() is Patient) (Patient )
65 Resources
period
date
The period covered by the documentation
Composition.event.period
related
reference
Target of the relationship
Composition.relatesTo.resourceReference (Any)
section
token
Classification of section (recommended)
Composition.section.code
section-code-text
composite
Search on the section narrative of the resource
On Composition.section: section: section.code section-text: section.text
section-text
special
Search on the section narrative of the resource
Composition.section.text | Composition.section.section.text
status
token
preliminary | final | amended | entered-in-error
Composition.status
subject
reference
Who and/or what the composition is about
Composition.subject (Any)
title
string
Human Readable name/title
Composition.title
type
token
Kind of composition (LOINC if possible)
Composition.type
11 Resources
url
uri
The uri that identifies the activity definition
Composition.url
version
token
The business version of the activity definition
Composition.version