This page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Structured Documents Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
Definitions for the clinicaldocument Profile.
Composition | |||||||||||||||||||||||||
Element Id | 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.). | ||||||||||||||||||||||||
Short Display | A set of resources composed into a single coherent clinical statement with clinical attestation | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.id | |||||||||||||||||||||||||
Element Id | Composition.id | ||||||||||||||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||||||||||||||
Short Display | Logical id of this artifact | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | id | ||||||||||||||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||||||||||||||
Composition.meta | |||||||||||||||||||||||||
Element Id | Composition.meta | ||||||||||||||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||||||||||||||
Short Display | Metadata about the resource | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Meta | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.implicitRules | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Is Modifier | true (Reason: 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) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.language | |||||||||||||||||||||||||
Element Id | Composition.language | ||||||||||||||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||||||||||||||
Short Display | Language of the resource content | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | IETF language tag The codes SHOULD be taken from Common Languages | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
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). | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.text | |||||||||||||||||||||||||
Element Id | Composition.text | ||||||||||||||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Narrative | ||||||||||||||||||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||||||||||||||||||
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.contained | |||||||||||||||||||||||||
Element Id | Composition.contained | ||||||||||||||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. | ||||||||||||||||||||||||
Short Display | Contained, inline Resources | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||
Alternate Names | inline resources, anonymous resources, contained 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. | ||||||||||||||||||||||||
Composition.extension | |||||||||||||||||||||||||
Element Id | Composition.extension | ||||||||||||||||||||||||
Definition | An Extension | ||||||||||||||||||||||||
Short Display | Extension | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||||||||||||||
Composition.extension(versionNumber) | |||||||||||||||||||||||||
Element Id | Composition.extension:versionNumber | ||||||||||||||||||||||||
Definition | Version specific identifier for the composition, assigned when each version is created/updated. | ||||||||||||||||||||||||
Short Display | Version-specific identifier for composition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Extension(CDVersionNumber) | ||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.modifierExtension | |||||||||||||||||||||||||
Element Id | 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). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them) | ||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.url | |||||||||||||||||||||||||
Element Id | Composition.url | ||||||||||||||||||||||||
Definition | An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers. | ||||||||||||||||||||||||
Short Display | Canonical identifier for this Composition, represented as a URI (globally unique) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||
Requirements | Allows the Composition to be referenced by a single globally unique identifier. | ||||||||||||||||||||||||
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.identifier | |||||||||||||||||||||||||
Element Id | Composition.identifier | ||||||||||||||||||||||||
Definition | A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time. | ||||||||||||||||||||||||
Short Display | Version-independent identifier for the Composition | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||
Comments | Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.version | |||||||||||||||||||||||||
Element Id | Composition.version | ||||||||||||||||||||||||
Definition | An explicitly assigned identifer of a variation of the content in the Composition. | ||||||||||||||||||||||||
Short Display | An explicitly assigned identifer of a variation of the content in the Composition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.status | |||||||||||||||||||||||||
Element Id | Composition.status | ||||||||||||||||||||||||
Definition | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. | ||||||||||||||||||||||||
Short Display | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | The workflow/clinical status of the composition. The codes SHALL be taken from CompositionStatus | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Is Modifier | true (Reason: 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) | ||||||||||||||||||||||||
Requirements | Need to be able to mark interim, amended, or withdrawn compositions or documents. | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.type | |||||||||||||||||||||||||
Element Id | Composition.type | ||||||||||||||||||||||||
Definition | Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition. | ||||||||||||||||||||||||
Short Display | Kind of composition (LOINC if possible) | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | Type of a composition. The codes SHOULD be taken from FHIR Document Type Codes | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Key metadata element describing the composition, used in searching/filtering. | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.category | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Categorization of Composition | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | High-level kind of a clinical document at a macro level. For example codes, see Referenced Item Category Value Set | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.subject | |||||||||||||||||||||||||
Element Id | Composition.subject | ||||||||||||||||||||||||
Definition | Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). | ||||||||||||||||||||||||
Short Display | Who and/or what the composition is about | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Reference(Patient) | ||||||||||||||||||||||||
Requirements | Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. | ||||||||||||||||||||||||
Comments | For clinical documents, this is usually the patient. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.encounter | |||||||||||||||||||||||||
Element Id | Composition.encounter | ||||||||||||||||||||||||
Definition | Describes the clinical encounter or type of care this documentation is associated with. | ||||||||||||||||||||||||
Short Display | Context of the Composition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Encounter) | ||||||||||||||||||||||||
Requirements | Provides context for the composition and supports searching. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.date | |||||||||||||||||||||||||
Element Id | Composition.date | ||||||||||||||||||||||||
Definition | The composition editing time, when the composition was last logically changed by the author. | ||||||||||||||||||||||||
Short Display | Composition editing time | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||
Requirements | dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring this version of the Composition. When packaged in a document, Bundle.timestamp is the date of packaging. | ||||||||||||||||||||||||
Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.useContext | |||||||||||||||||||||||||
Element Id | Composition.useContext | ||||||||||||||||||||||||
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances. | ||||||||||||||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | UsageContext | ||||||||||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.author | |||||||||||||||||||||||||
Element Id | Composition.author | ||||||||||||||||||||||||
Definition | Identifies who is responsible for the information in the composition, not necessarily who typed it in. | ||||||||||||||||||||||||
Short Display | Who and/or what authored the composition | ||||||||||||||||||||||||
Cardinality | 1..* | ||||||||||||||||||||||||
Type | Reference(Practitioner) | ||||||||||||||||||||||||
Requirements | Identifies who is responsible for the content. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.name | |||||||||||||||||||||||||
Element Id | Composition.name | ||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||
Short Display | Name for this Composition (computer friendly) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.title | |||||||||||||||||||||||||
Element Id | Composition.title | ||||||||||||||||||||||||
Definition | Official human-readable label for the composition. | ||||||||||||||||||||||||
Short Display | Human Readable name/title | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.note | |||||||||||||||||||||||||
Element Id | Composition.note | ||||||||||||||||||||||||
Definition | For any additional notes. | ||||||||||||||||||||||||
Short Display | For any additional notes | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Annotation | ||||||||||||||||||||||||
Comments | A comment, general note or annotation not coded elsewhere. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.attester | |||||||||||||||||||||||||
Element Id | Composition.attester | ||||||||||||||||||||||||
Definition | A participant who has attested to the accuracy of the composition/document. | ||||||||||||||||||||||||
Short Display | Attests to accuracy of composition | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Requirements | Identifies responsibility for the accuracy of the composition content. | ||||||||||||||||||||||||
Comments | Only list each attester once. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.attester.id | |||||||||||||||||||||||||
Element Id | Composition.attester.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Composition.attester.extension | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.attester.modifierExtension | |||||||||||||||||||||||||
Element Id | 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). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.attester.mode | |||||||||||||||||||||||||
Element Id | Composition.attester.mode | ||||||||||||||||||||||||
Definition | The type of attestation the authenticator offers. | ||||||||||||||||||||||||
Short Display | personal | professional | legal | official | ||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||
Terminology Binding | The way in which a person authenticated a composition. The codes SHOULD be taken from CompositionAttestationMode | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Indicates the level of authority of the attestation. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.attester.time | |||||||||||||||||||||||||
Element Id | Composition.attester.time | ||||||||||||||||||||||||
Definition | When the composition was attested by the party. | ||||||||||||||||||||||||
Short Display | When the composition was attested | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||
Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.attester.party | |||||||||||||||||||||||||
Element Id | Composition.attester.party | ||||||||||||||||||||||||
Definition | Who attested the composition in the specified way. | ||||||||||||||||||||||||
Short Display | Who attested the composition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Patient) | ||||||||||||||||||||||||
Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.custodian | |||||||||||||||||||||||||
Element Id | Composition.custodian | ||||||||||||||||||||||||
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. | ||||||||||||||||||||||||
Short Display | Organization which maintains the composition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Organization) | ||||||||||||||||||||||||
Requirements | Identifies where to go to find the current version, where to report issues, etc. | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.relatesTo | |||||||||||||||||||||||||
Element Id | Composition.relatesTo | ||||||||||||||||||||||||
Definition | Relationships that this composition has with other compositions or documents that already exist. | ||||||||||||||||||||||||
Short Display | Relationships to other compositions/documents | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | RelatedArtifact | ||||||||||||||||||||||||
Comments | To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier. Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:
| ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.event | |||||||||||||||||||||||||
Element Id | Composition.event | ||||||||||||||||||||||||
Definition | The clinical service, such as a colonoscopy or an appendectomy, being documented. | ||||||||||||||||||||||||
Short Display | The clinical service(s) being documented | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. | ||||||||||||||||||||||||
Comments | The event needs to be consistent with the type element, though can provide further information if desired. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.event.id | |||||||||||||||||||||||||
Element Id | Composition.event.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Composition.event.extension | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.event.modifierExtension | |||||||||||||||||||||||||
Element Id | 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). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.event.code | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | Code(s) that apply to the event being documented | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Terminology Binding | This list of codes represents the main clinical acts being documented. For example codes, see v3 Code System ActCode | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.event.period | |||||||||||||||||||||||||
Element Id | Composition.event.period | ||||||||||||||||||||||||
Definition | The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time. | ||||||||||||||||||||||||
Short Display | The period covered by the documentation | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.event.detail | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | The event(s) being documented | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Reference(Resource) | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section | |||||||||||||||||||||||||
Element Id | Composition.section | ||||||||||||||||||||||||
Definition | The root of the sections that make up the composition. | ||||||||||||||||||||||||
Short Display | Composition is broken into sections | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.id | |||||||||||||||||||||||||
Element Id | Composition.section.id | ||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Composition.section.extension | |||||||||||||||||||||||||
Element Id | Composition.section.extension | ||||||||||||||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. | ||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.modifierExtension | |||||||||||||||||||||||||
Element Id | 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). | ||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.title | |||||||||||||||||||||||||
Element Id | Composition.section.title | ||||||||||||||||||||||||
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. | ||||||||||||||||||||||||
Short Display | Label for section (e.g. for ToC) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. | ||||||||||||||||||||||||
Alternate Names | header, label, caption | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.code | |||||||||||||||||||||||||
Element Id | Composition.section.code | ||||||||||||||||||||||||
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||||||||||||||||||||||||
Short Display | Classification of section (recommended) | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Provides computable standardized labels to topics within the document. | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.author | |||||||||||||||||||||||||
Element Id | Composition.section.author | ||||||||||||||||||||||||
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||||||||||||||||||||||||
Short Display | Who and/or what authored the section | ||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||
Type | Reference(Practitioner) | ||||||||||||||||||||||||
Requirements | Identifies who is responsible for the content. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.focus | |||||||||||||||||||||||||
Element Id | 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). | ||||||||||||||||||||||||
Short Display | Who/what the section is about, when it is not about the subject of composition | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Type | Reference(Resource) | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.text | |||||||||||||||||||||||||
Element Id | Composition.section.text | ||||||||||||||||||||||||
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. | ||||||||||||||||||||||||
Short Display | Text summary of the section, for human interpretation | ||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: cmp-1 | ||||||||||||||||||||||||
Type | Narrative | ||||||||||||||||||||||||
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.mode | |||||||||||||||||||||||||
Element Id | 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. | ||||||||||||||||||||||||
Short Display | working | snapshot | changes | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode | ||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. | ||||||||||||||||||||||||
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.orderedBy | |||||||||||||||||||||||||
Element Id | Composition.section.orderedBy | ||||||||||||||||||||||||
Definition | Specifies the order applied to the items in the section entries. | ||||||||||||||||||||||||
Short Display | Order of section entries | ||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||
Terminology Binding | What order applies to the items in the entry. The codes SHOULD be taken from List Order Codes | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related 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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.entry | |||||||||||||||||||||||||
Element Id | Composition.section.entry | ||||||||||||||||||||||||
Definition | A reference to the actual resource from which the narrative in the section is derived. | ||||||||||||||||||||||||
Short Display | A reference to data that supports this section | ||||||||||||||||||||||||
Cardinality | 0..* This element is affected by the following invariants: cmp-2 | ||||||||||||||||||||||||
Type | Reference(Resource) | ||||||||||||||||||||||||
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.emptyReason | |||||||||||||||||||||||||
Element Id | Composition.section.emptyReason | ||||||||||||||||||||||||
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. | ||||||||||||||||||||||||
Short Display | Why the section is empty | ||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: cmp-2 | ||||||||||||||||||||||||
Terminology Binding | If a section is empty, why it is empty. The codes SHOULD be taken from List Empty Reasons | ||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. | ||||||||||||||||||||||||
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. | ||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||
Composition.section.section | |||||||||||||||||||||||||
Element Id | Composition.section.section | ||||||||||||||||||||||||
Definition | A nested sub-section within this section. | ||||||||||||||||||||||||
Short Display | Nested Section | ||||||||||||||||||||||||
Cardinality | 0..* This element is affected by the following invariants: cmp-1 | ||||||||||||||||||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/Composition#Composition.section | ||||||||||||||||||||||||
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. | ||||||||||||||||||||||||
Invariants |
|