This page is part of the electronic Case Reporting (eCR) (v0.2.0: STU 1 Ballot 2) based on FHIR R3. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions
Definitions for the StructureDefinition-eicr-composition Profile.
Composition | |
Definition | The Electronic Case Reporting Composition profile establishes the core elements, extensions, vocabularies and value sets for representing an electronic initial case report (eICR). It describes the content requirements for the initial Case Report including:
|
Control | 0..* |
Must Support | true |
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 | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
Composition.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Composition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Composition.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
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). |
Composition.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
Composition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 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. |
Composition.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Composition.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-eicr-manually-initiated-reason]]) | |
Definition | Reason for manual initiation of the eICR. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Composition.identifier | |
Definition | ID of the eICR Document |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | See discussion in resource definition for how these relate. |
Composition.status | |
Definition | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. |
Control | 1..1 |
Binding | The workflow/clinical status of the composition. The codes SHALL be taken from CompositionStatus |
Type | code |
Is Modifier | true |
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. |
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. |
Control | 1..1 |
Binding | Type of a composition. The codes SHOULD be taken from FHIR Document Type Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="55751-2"/> </coding> </valueCodeableConcept> |
Composition.class | |
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. |
Control | 0..1 |
Binding | High-level kind of a clinical document at a macro level. For example codes, see FHIR Document Class Codes |
Type | CodeableConcept |
Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. |
Comments | This is a metadata field from XDS/MHD. |
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). |
Control | 1..1 |
Type | Reference(ecr-patient) |
Must Support | true |
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. |
Composition.encounter | |
Definition | Describes the clinical encounter or type of care this documentation is associated with. |
Control | 1..1 |
Type | Reference(eicr-encounter) |
Must Support | true |
Requirements | Provides context for the composition and supports searching. |
Comments | (US Core Encounter profile pending). |
Composition.date | |
Definition | The composition editing time, when the composition was last logically changed by the author. |
Control | 1..1 |
Type | dateTime |
Must Support | true |
Requirements | dateTime is used for tracking, organizing versions and searching. |
Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed. |
Composition.author | |
Definition | Identifies who is responsible for the information in the composition, not necessarily who typed it in. |
Control | 1..1 |
Type | Reference(PractitionerRole | US Core Practitioner Profile | ecr-organization) |
Must Support | true |
Requirements | Identifies who is responsible for the content. |
Composition.title | |
Definition | Official human-readable label for the composition. |
Control | 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. |
Composition.confidentiality | |
Definition | The code specifying the level of confidentiality of the Composition. |
Control | 0..1 |
Binding | Codes specifying the level of confidentiality of the composition. The codes SHALL be taken from ConfidentialityClassification |
Type | code |
Is Modifier | true |
Comments | The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not. |
Composition.attester | |
Definition | A participant who has attested to the accuracy of the composition/document. |
Control | 0..* |
Type | BackboneElement |
Requirements | Identifies responsibility for the accuracy of the composition content. |
Comments | Only list each attester once. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.attester.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Composition.attester.mode | |
Definition | The type of attestation the authenticator offers. |
Control | 1..* |
Binding | The way in which a person authenticated a composition. The codes SHALL be taken from CompositionAttestationMode |
Type | code |
Requirements | Indicates the level of authority of the attestation. |
Comments | Use more than one code where a single attester has more than one mode (professional and legal are often paired). |
Composition.attester.time | |
Definition | When the composition was attested by the party. |
Control | 0..1 |
Type | dateTime |
Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). |
Composition.attester.party | |
Definition | Who attested the composition in the specified way. |
Control | 0..1 |
Type | Reference(Patient | Practitioner | Organization) |
Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. |
Composition.custodian | |
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. |
Control | 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. |
Composition.relatesTo | |
Definition | Relationships that this composition has with other compositions or documents that already exist. |
Control | 0..* |
Type | BackboneElement |
Comments | A document is a version specific composition. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Composition.relatesTo.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.relatesTo.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
Composition.relatesTo.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
Composition.relatesTo.code | |
Definition | The type of relationship that this composition has with anther composition or document. |
Control | 1..1 |
Binding | The type of relationship between documents. The codes SHALL be taken from DocumentRelationshipType |
Type | code |
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
Composition.relatesTo.target[x] | |
Definition | The target composition/document of this relationship. |
Control | 1..1 |
Type | Choice of: Identifier, Reference(Composition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Composition.event | |
Definition | The clinical service, such as a colonoscopy or an appendectomy, being documented. |
Control | 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 | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.event.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 0..* |
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. |
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. |
Control | 0..1 |
Type | Period |
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. |
Control | 0..* |
Type | Reference(Resource) |
Composition.section | |
Definition | The root of the sections that make up the composition. |
Control | 0..* |
Type | BackboneElement |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 0..1 |
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. |
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. |
Control | 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. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 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. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceEncountersSection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="46240-8"/> </coding> </valueCodeableConcept> |
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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(sliceEICREncounter) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(eicr-encounter) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceEncountersSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceHistoryOfPresentIllnessSection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="10164-2"/> </coding> </valueCodeableConcept> |
Composition.section.text | |
Definition | History of present illness |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 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. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceHistoryOfPresentIllnessSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceReasonForVisitSection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="29299-5"/> </coding> </valueCodeableConcept> |
Composition.section.text | |
Definition | Reason for visit |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 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. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceReasonForVisitSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceSocialHistorySection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="29762-2"/> </coding> </valueCodeableConcept> |
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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(sliceTravelHistory) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(eicr-travel-history) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(slicePregnancyStatus) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
Type | Reference(pregnancy-status) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(sliceOccupationHistory) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(eicr-occupationhistory) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceSocialHistorySection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceProblemSection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="11450-4"/> </coding> </valueCodeableConcept> |
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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(sliceEICRCondition) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(eicr-condition) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Composition.section.entry.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-eicr-trigger-code-flag]]) | |
Definition | Definition: A flag to indicate that the target reference represents a triggering event and caused the eCR to be generated. It is used in the eICR profile in the following places:
|
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Composition.section.entry.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Composition.section.entry.extension.extension(triggerCodeValueSet) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension |
Composition.section.entry.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
Composition.section.entry.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | triggerCodeValueSet |
Composition.section.entry.extension.extension.valueOid(valueOid) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 1..1 |
Type | oid |
Example | General:urn:oid:2.16.840.1.114222.4.11.7508 |
Composition.section.entry.extension.extension(triggerCodeValueSetVersion) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension |
Composition.section.entry.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
Composition.section.entry.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | triggerCodeValueSetVersion |
Composition.section.entry.extension.extension.valueString(valueString) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | string |
Example | General:19/05/2018 |
Composition.section.entry.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/us/ecr/StructureDefinition/extension-trigger |
Composition.section.entry.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..0 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Composition.section.entry.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Composition.section.entry.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
Composition.section.entry.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceProblemSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceMedicationsAdministeredSection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="29549-3"/> </coding> </valueCodeableConcept> |
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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(USCoreMedicationStatement) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(US Core MedicationStatement Profile) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceMedicationsAdministeredSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceResultsSection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="30954-2"/> </coding> </valueCodeableConcept> |
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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 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. |
Composition.section.entry(sliceUSCoreObservationResults) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(US Core Results Profile) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Composition.section.entry.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-eicr-trigger-code-flag]]) | |
Definition | Definition: A flag to indicate that the target reference represents a triggering event and caused the eCR to be generated. It is used in the eICR profile in the following places:
|
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Composition.section.entry.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Composition.section.entry.extension.extension(triggerCodeValueSet) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension |
Composition.section.entry.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
Composition.section.entry.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | triggerCodeValueSet |
Composition.section.entry.extension.extension.valueOid(valueOid) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 1..1 |
Type | oid |
Example | General:urn:oid:2.16.840.1.114222.4.11.7508 |
Composition.section.entry.extension.extension(triggerCodeValueSetVersion) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension |
Composition.section.entry.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
Composition.section.entry.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | triggerCodeValueSetVersion |
Composition.section.entry.extension.extension.valueString(valueString) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | string |
Example | General:19/05/2018 |
Composition.section.entry.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/us/ecr/StructureDefinition/extension-trigger |
Composition.section.entry.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..0 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Composition.section.entry.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Composition.section.entry.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
Composition.section.entry.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceResultsSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(slicePlanOfTreatmentSection) | |
Definition | The root of the sections that make up the composition. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="18776-5"/> </coding> </valueCodeableConcept> |
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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(sliceEICRProcedureRequest) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(eicr-procedurerequest) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Composition.section.entry.extension ([CanonicalType[http://hl7.org/fhir/us/ecr/StructureDefinition/extension-eicr-trigger-code-flag]]) | |
Definition | Definition: A flag to indicate that the target reference represents a triggering event and caused the eCR to be generated. It is used in the eICR profile in the following places:
|
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Composition.section.entry.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Composition.section.entry.extension.extension(triggerCodeValueSet) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension |
Composition.section.entry.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
Composition.section.entry.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | triggerCodeValueSet |
Composition.section.entry.extension.extension.valueOid(valueOid) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 1..1 |
Type | oid |
Example | General:urn:oid:2.16.840.1.114222.4.11.7508 |
Composition.section.entry.extension.extension(triggerCodeValueSetVersion) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension |
Composition.section.entry.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Composition.section.entry.extension.extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
Composition.section.entry.extension.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | triggerCodeValueSetVersion |
Composition.section.entry.extension.extension.valueString(valueString) | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | string |
Example | General:19/05/2018 |
Composition.section.entry.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://hl7.org/fhir/us/ecr/StructureDefinition/extension-trigger |
Composition.section.entry.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..0 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Composition.section.entry.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Composition.section.entry.identifier | |
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. |
Composition.section.entry.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:slicePlanOfTreatmentSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Composition.section(sliceImmunizationsSection) | |
Definition | The root of the sections that make up the composition. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element cmp-1: A section must at least one of text, entries, or sub-sections (: text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (: emptyReason.empty() or entry.empty()) ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
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. |
Control | 0..1 |
Type | string |
Composition.section.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
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. |
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. |
Control | 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. |
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Control | 1..1 |
Binding | Classification of a section of a composition/document. For example codes, see Document Section Codes |
Type | CodeableConcept |
Must Support | true |
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. |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://loinc.org"/> <code value="11369-6"/> </coding> </valueCodeableConcept> |
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. |
Control | 1..1 This element is affected by the following invariants: cmp-1 |
Type | Narrative |
Must Support | true |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
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. |
Control | 0..1 |
Binding | The processing mode that applies to this section. The codes SHALL be taken from ListMode |
Type | code |
Is Modifier | true |
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 mis-understood as a complete list. |
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Control | 0..1 |
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. |
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 0..* This element is affected by the following invariants: cmp-2 |
Type | Reference(Resource) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Composition.section.entry(sliceUSCoreImmunization) | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Control | 1..* This element is affected by the following invariants: cmp-2 |
Type | Reference(US Core Immunization Profile) |
Must Support | true |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
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. |
Control | 0..1 This element is affected by the following invariants: cmp-2 |
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. |
Composition.section.section | |
Definition | A nested sub-section within this section. |
Control | 0..* This element is affected by the following invariants: cmp-1 |
Type | See Composition.section:sliceImmunizationsSection |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |