International Patient Summary Implementation Guide
2.0.0 - STU 2

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

## Resource Profile: CompositionUvIps - Detailed Descriptions

Page standards status: Trial-use | Maturity Level: 2

Definitions for the Composition-uv-ips resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Composition
Definition | International Patient Summary composition. A composition is a set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained. A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).
Short | International Patient Summary compositionA set of resources composed into a single coherent clinical statement with clinical attestation
Comments | While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Composition.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Composition.meta.profile
Definition | The conformance of this Composition to a specific version of the IPS (e.g. http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips|2.0.0 for 2.0.0) A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | The conformance of this Composition to a specific IPS version.Profiles this resource claims to conform to
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 0..*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
MAY:able-to-populate | Creator (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Composition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Composition.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Composition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Composition.identifier
Definition | A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
Short | Version-independent identifier for the Composition
Comments | Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Composition.status
Definition | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
Short | preliminary | final | amended | entered-in-error
Comments | If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements. Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.
Control | 1..1
Binding | The codes SHALL be taken from CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 (required to `http://hl7.org/fhir/ValueSet/composition-status|4.0.1` ) The workflow/clinical status of the composition.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Need to be able to mark interim, amended, or withdrawn compositions or documents.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Composition.type
Definition | Specifies that this composition refers to a Patient Summary (Loinc "60591-5") Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
Short | Kind of composition ("Patient Summary")Kind of composition (LOINC if possible)
Comments | For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.
Control | 1..1
Binding | The codes SHOULD be taken from FHIRDocumentTypeCodes http://hl7.org/fhir/ValueSet/doc-typecodes (preferred to `http://hl7.org/fhir/ValueSet/doc-typecodes` ) Type of a composition.
Type | CodeableConcept(Codeable Concept (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
Summary | true
Requirements | Key metadata element describing the composition, used in searching/filtering.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "60591-5" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Composition.subject
Definition | Who or what the composition is about. In general a 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). For the IPS the subject is always the patient. Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
Short | Who and/or what the composition is about
Comments | For clinical documents, this is usually the patient.
Control | 10..1
Type | Reference(Patient (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Composition.subject.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.
Short | Literal reference, Relative, internal or absolute URL
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.
Control | 10..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Composition.date
Definition | The composition editing time, when the composition was last logically changed by the author.
Short | Composition editing time
Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging. dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Composition.author
Definition | Identifies who is responsible for the information in the composition, not necessarily who typed it in.
Short | Who and/or what authored the IPSWho and/or what authored the composition
Comments | The distinction between the two types of IPS, "human-curated" or "software-assembled", is based on the authors recorded in this field: the author refers to humans (i.e. Practitioner, PractitionerRole, Patient, and/or RelatedPerson) if the IPS provenance is "human-curated", or devices (i.e. Device) if the IPS provenance is "software-assembled". In the case of a software-assembled IPS that is then verified by a human, the author would be the device that constructed the IPS document, but additional attesters would identity the humans who performed this check.
Control | 1..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Composition.title
Definition | Official human-readable label for the composition. This would typically include a label of "International Patient Summary" or any equivalent translation and other relevant document information Official human-readable label for the composition.
Short | The title of this patient summary. This may include information like the patient name and time generatedHuman Readable name/title
Comments | For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Composition.attester
Definition | A participant who has attested to the accuracy of the composition/document.
Short | Attests to accuracy of composition
Comments | Only list each attester once.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Identifies responsibility for the accuracy of the composition content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Composition.attester.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Composition.attester.mode
Definition | The type of attestation the authenticator offers.
Short | personal | professional | legal | official
Control | 1..1
Binding | The codes SHALL be taken from CompositionAttestationMode http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1 (required to `http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1` ) The way in which a person authenticated a composition.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Indicates the level of authority of the attestation.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Composition.attester.time
Definition | When the composition was attested by the party.
Short | When the composition was attested
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Composition.attester.party
Definition | Who attested the composition in the specified way.
Short | Who attested the composition
Control | 0..1
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Identifies who has taken on the responsibility for accuracy of the composition content.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Composition.custodian
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
Short | Organization which maintains the composition
Comments | This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Identifies where to go to find the current version, where to report issues, etc.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Composition.event
Definition | The main activity being described by a IPS is the provision of healthcare over a period of time. In the CDA representation of the IPS this is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. In the FHIR representation at least one event should be used to record this information. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the start value should represent the date when the treatment relationship between the patient and the GP started; and the end value the date of the latest care event. The clinical service, such as a colonoscopy or an appendectomy, being documented.
Short | The clinical service(s) being documented
Comments | The event needs to be consistent with the type element, though can provide further information if desired.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | true
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.event`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ code
42. Composition.event.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. Composition.event:careProvisioningEvent
Slice Name | careProvisioningEvent
Definition | The provision of healthcare over a period of time this IPS is documenting. The clinical service, such as a colonoscopy or an appendectomy, being documented.
Short | The care provisioning being documentedThe clinical service(s) being documented
Comments | The event needs to be consistent with the type element, though can provide further information if desired.
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Composition.event:careProvisioningEvent.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
48. Composition.event:careProvisioningEvent.code
Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
Short | Code(s) that apply to the event being documented
Comments | An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.
Control | 10..1*
Binding | For example codes, see v3 Code System ActCode http://terminology.hl7.org/ValueSet/v3-ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` ) This list of codes represents the main clinical acts being documented.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActClass", "code" : "PCPR" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Composition.event:careProvisioningEvent.period
Definition | The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
Short | The period covered by the documentation
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Composition.section
Definition | The root of the sections that make up the IPS composition. The root of the sections that make up the composition.
Short | Sections composing the IPSComposition is broken into sections
Control | 30..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
Slicing | This element introduces a set of slices on `Composition.section`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ code
54. Composition.section.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | ExtensionAdditional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
56. Composition.section.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
58. Composition.section.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
60. Composition.section.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Composition.section.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Composition.section.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Composition.section.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Composition.section:sectionProblems
Slice Name | sectionProblems
Definition | The IPS problem section lists and describes clinical problems or conditions currently being monitored for the patient. The root of the sections that make up the composition.
Short | IPS Problems SectionComposition is broken into sections
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
70. Composition.section:sectionProblems.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
72. Composition.section:sectionProblems.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
74. Composition.section:sectionProblems.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Composition.section:sectionProblems.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11450-4" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. Composition.section:sectionProblems.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. Composition.section:sectionProblems.entry
Definition | It lists and describes clinical problems or conditions currently being monitored for the patient. This entry shall be used to document that no information about problems is available, or that no relevant problems are known. A reference to the actual resource from which the narrative in the section is derived.
Short | Clinical problems or conditions currently being monitored for the patient.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
82. Composition.section:sectionProblems.entry:problem
Slice Name | problem
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. Composition.section:sectionProblems.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
86. Composition.section:sectionProblems.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
88. Composition.section:sectionAllergies
Slice Name | sectionAllergies
Definition | This section documents the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. If no information about allergies is available, or if no allergies are known this should be clearly documented in the section. The root of the sections that make up the composition.
Short | IPS Allergies and Intolerances SectionComposition is broken into sections
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
90. Composition.section:sectionAllergies.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
92. Composition.section:sectionAllergies.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
94. Composition.section:sectionAllergies.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
96. Composition.section:sectionAllergies.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "48765-2" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
98. Composition.section:sectionAllergies.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
100. Composition.section:sectionAllergies.entry
Definition | It lists the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. This entry shall be used to document that no information about allergies is available, or that no allergies are known . A reference to the actual resource from which the narrative in the section is derived.
Short | Relevant allergies or intolerances for that patient.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(AllergyIntolerance, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
102. Composition.section:sectionAllergies.entry:allergyOrIntolerance
Slice Name | allergyOrIntolerance
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(AllergyIntolerance (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
104. Composition.section:sectionAllergies.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
106. Composition.section:sectionAllergies.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
108. Composition.section:sectionMedications
Slice Name | sectionMedications
Definition | The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary. The actual content could depend on the jurisdiction, it could report: the currently active medications; the current and past medications considered relevant by the authoring GP; the patient prescriptions or dispensations automatically extracted by a regional or a national EHR. In those cases medications are documented in the Patient Summary as medication statements or medication requests. This section requires either an entry indicating the subject is known not to be on any relevant medication; either an entry indicating that no information is available about medications; or entries summarizing the subject's relevant medications. The root of the sections that make up the composition.
Short | IPS Medication Summary SectionComposition is broken into sections
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
110. Composition.section:sectionMedications.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
112. Composition.section:sectionMedications.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
114. Composition.section:sectionMedications.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
116. Composition.section:sectionMedications.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "10160-0" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
118. Composition.section:sectionMedications.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
120. Composition.section:sectionMedications.entry
Definition | This list the medications relevant for the scope of the patient summary or it is used to indicate that the subject is known not to be on any relevant medication; either that no information is available about medications. A reference to the actual resource from which the narrative in the section is derived.
Short | Medications relevant for the scope of the patient summaryA reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(MedicationStatement, MedicationRequest, MedicationAdministration, MedicationDispense, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
122. Composition.section:sectionMedications.entry:medicationStatementOrRequest
Slice Name | medicationStatementOrRequest
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(MedicationStatement (IPS), MedicationRequest (IPS), Resource)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Composition.section:sectionMedications.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons http://hl7.org/fhir/ValueSet/list-empty-reason (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
126. Composition.section:sectionMedications.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
128. Composition.section:sectionImmunizations
Slice Name | sectionImmunizations
Definition | The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section includes the current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized. The root of the sections that make up the composition.
Short | IPS Immunizations SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
130. Composition.section:sectionImmunizations.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
132. Composition.section:sectionImmunizations.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
134. Composition.section:sectionImmunizations.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
136. Composition.section:sectionImmunizations.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11369-6" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
138. Composition.section:sectionImmunizations.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
140. Composition.section:sectionImmunizations.entry
Definition | It defines the patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. It may contain the entire immunization history that is relevant to the period of time being summarized. This entry shall be used to document that no information about immunizations is available, or that no immunizations are known. A reference to the actual resource from which the narrative in the section is derived.
Short | Patient's immunization status and pertinent history.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Immunization, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
142. Composition.section:sectionImmunizations.entry:immunization
Slice Name | immunization
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Immunization (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
144. Composition.section:sectionImmunizations.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
146. Composition.section:sectionResults
Slice Name | sectionResults
Definition | This section assembles relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results. The root of the sections that make up the composition.
Short | IPS Results SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
148. Composition.section:sectionResults.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
150. Composition.section:sectionResults.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
152. Composition.section:sectionResults.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
154. Composition.section:sectionResults.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "30954-2" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
156. Composition.section:sectionResults.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
158. Composition.section:sectionResults.entry
Definition | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results. A reference to the actual resource from which the narrative in the section is derived.
Short | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DiagnosticReport, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ resolve() profile @ resolve()
160. Composition.section:sectionResults.entry:results-observation-laboratory-pathology
Slice Name | results-observation-laboratory-pathology
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Results - Laboratory/Pathology (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
162. Composition.section:sectionResults.entry:results-observation-radiology
Slice Name | results-observation-radiology
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Results - Radiology (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
164. Composition.section:sectionResults.entry:results-diagnosticReport
Slice Name | results-diagnosticReport
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(DiagnosticReport (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
166. Composition.section:sectionResults.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
168. Composition.section:sectionProceduresHx
Slice Name | sectionProceduresHx
Definition | The History of Procedures Section contains a description of the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) Therapeutic procedure: e.g. dialysis; Surgical procedure: e.g. appendectomy The root of the sections that make up the composition.
Short | IPS History of Procedures SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
170. Composition.section:sectionProceduresHx.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
172. Composition.section:sectionProceduresHx.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
174. Composition.section:sectionProceduresHx.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
176. Composition.section:sectionProceduresHx.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "47519-4" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
178. Composition.section:sectionProceduresHx.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
180. Composition.section:sectionProceduresHx.entry
Definition | It lists the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) Therapeutic procedure: e.g. dialysis; Surgical procedure: e.g. appendectomy. This entry shall be used to document that no information about past procedures is available, or that no relevant past procedures are known. A reference to the actual resource from which the narrative in the section is derived.
Short | Patient past procedures pertinent to the scope of this document.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Procedure, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
182. Composition.section:sectionProceduresHx.entry:procedure
Slice Name | procedure
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Procedure (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
184. Composition.section:sectionProceduresHx.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
186. Composition.section:sectionMedicalDevices
Slice Name | sectionMedicalDevices
Definition | The medical devices section contains narrative text and coded entries describing the patient history of medical device use. The root of the sections that make up the composition.
Short | IPS Medical Devices SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
188. Composition.section:sectionMedicalDevices.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
190. Composition.section:sectionMedicalDevices.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
192. Composition.section:sectionMedicalDevices.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
194. Composition.section:sectionMedicalDevices.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "46264-8" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
196. Composition.section:sectionMedicalDevices.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
198. Composition.section:sectionMedicalDevices.entry
Definition | It describes the patient history of medical device use. This entry shall be used to document that no information about medical device use is available, or that no relevant medical device use is known. A reference to the actual resource from which the narrative in the section is derived.
Short | Patient history of medical device use.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(DeviceUseStatement, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
200. Composition.section:sectionMedicalDevices.entry:deviceStatement
Slice Name | deviceStatement
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(DeviceUseStatement (IPS), Resource)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
202. Composition.section:sectionMedicalDevices.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
204. Composition.section:sectionAdvanceDirectives
Slice Name | sectionAdvanceDirectives
Definition | The advance directives section contains a narrative description of patient's advance directive. The root of the sections that make up the composition.
Short | IPS Advance Directives SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
206. Composition.section:sectionAdvanceDirectives.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
208. Composition.section:sectionAdvanceDirectives.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
210. Composition.section:sectionAdvanceDirectives.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
212. Composition.section:sectionAdvanceDirectives.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "42348-3" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
214. Composition.section:sectionAdvanceDirectives.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
216. Composition.section:sectionAdvanceDirectives.entry
Definition | Contains a narrative description or a Consent entry with information about the patient's advance directive. A reference to the actual resource from which the narrative in the section is derived.
Short | Narrative description of the patient's advance directive.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Consent, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
218. Composition.section:sectionAdvanceDirectives.entry:advanceDirectivesConsent
Slice Name | advanceDirectivesConsent
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Consent, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
220. Composition.section:sectionAdvanceDirectives.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
222. Composition.section:sectionAlerts
Slice Name | sectionAlerts
Definition | The alerts section flags potential concerns and/or dangers to/from the patient and may also include obstacles to care. The root of the sections that make up the composition.
Short | IPS Alerts SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
224. Composition.section:sectionAlerts.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
226. Composition.section:sectionAlerts.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
228. Composition.section:sectionAlerts.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
230. Composition.section:sectionAlerts.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "104605-1" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
232. Composition.section:sectionAlerts.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
234. Composition.section:sectionAlerts.entry
Definition | Contains alert information to be communicated. May optionally reference other resources in IPS. A reference to the actual resource from which the narrative in the section is derived.
Short | Alert information.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Flag, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
236. Composition.section:sectionAlerts.entry:alertsFlag
Slice Name | alertsFlag
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Flag - Alert (IPS), Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
238. Composition.section:sectionAlerts.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
240. Composition.section:sectionFunctionalStatus
Slice Name | sectionFunctionalStatus
Definition | The functional status section shall contain a narrative description of capability of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide. The root of the sections that make up the composition.
Short | IPS Functional StatusComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
242. Composition.section:sectionFunctionalStatus.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
244. Composition.section:sectionFunctionalStatus.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
246. Composition.section:sectionFunctionalStatus.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
248. Composition.section:sectionFunctionalStatus.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "47420-5" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
250. Composition.section:sectionFunctionalStatus.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
252. Composition.section:sectionFunctionalStatus.entry
Definition | It describes capabilities of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide. A reference to the actual resource from which the narrative in the section is derived.
Short | Optional entry used to represent disabilities and functional assessmentsA reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition, ClinicalImpression, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
254. Composition.section:sectionFunctionalStatus.entry:disability
Slice Name | disability
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition (IPS), Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
256. Composition.section:sectionFunctionalStatus.entry:functionalAssessment
Slice Name | functionalAssessment
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(ClinicalImpression, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
258. Composition.section:sectionFunctionalStatus.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
260. Composition.section:sectionPastProblems
Slice Name | sectionPastProblems
Definition | The History of Past Problems section contains a description of the conditions the patient suffered in the past but no longer tracked in the Problem List. The root of the sections that make up the composition.
Short | IPS History of Past Problems SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
262. Composition.section:sectionPastProblems.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
264. Composition.section:sectionPastProblems.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
266. Composition.section:sectionPastProblems.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
268. Composition.section:sectionPastProblems.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11348-0" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
270. Composition.section:sectionPastProblems.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
272. Composition.section:sectionPastProblems.entry
Definition | It contains a description of the conditions the patient suffered in the past. A reference to the actual resource from which the narrative in the section is derived.
Short | Conditions the patient suffered in the past.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
274. Composition.section:sectionPastProblems.entry:pastProblem
Slice Name | pastProblem
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition (IPS), Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
276. Composition.section:sectionPastProblems.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
278. Composition.section:sectionPregnancyHx
Slice Name | sectionPregnancyHx
Definition | The history of pregnancy section shall contain information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies. The root of the sections that make up the composition.
Short | IPS History of Pregnancy SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
280. Composition.section:sectionPregnancyHx.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
282. Composition.section:sectionPregnancyHx.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
284. Composition.section:sectionPregnancyHx.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
286. Composition.section:sectionPregnancyHx.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "10162-6" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
288. Composition.section:sectionPregnancyHx.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
290. Composition.section:sectionPregnancyHx.entry
Definition | It contains information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies. A reference to the actual resource from which the narrative in the section is derived.
Short | Current pregnancy status and, optionally, information about the outcome of earlier pregnancies.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
292. Composition.section:sectionPregnancyHx.entry:pregnancyStatus
Slice Name | pregnancyStatus
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Pregnancy - Status (IPS), Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
294. Composition.section:sectionPregnancyHx.entry:pregnancyOutcome
Slice Name | pregnancyOutcome
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Pregnancy - Outcome (IPS), Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
296. Composition.section:sectionPregnancyHx.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
298. Composition.section:sectionPatientStory
Slice Name | sectionPatientStory
Definition | The section contains narrative text along with optional resources that express what matters to a patient. This may include needs, strengths, values, concerns and preferences to others providing support and care. The patient’s story, provided here, may be told by the patient or by a proxy. The root of the sections that make up the composition.
Short | IPS Patient Story SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
300. Composition.section:sectionPatientStory.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
302. Composition.section:sectionPatientStory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
304. Composition.section:sectionPatientStory.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
306. Composition.section:sectionPatientStory.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "81338-6" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
308. Composition.section:sectionPatientStory.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
310. Composition.section:sectionPatientStory.entry
Definition | Contains resources to support the Patient Story. Instances of DocumentReference or any other suitable resource type may be used. A reference to the actual resource from which the narrative in the section is derived.
Short | Patient Story resources.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
312. Composition.section:sectionPatientStory.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
314. Composition.section:sectionPlanOfCare
Slice Name | sectionPlanOfCare
Definition | The plan of care section contains a narrative description of the expectations for care including proposals, goals, and order requests for monitoring, tracking, or improving the condition of the patient. The root of the sections that make up the composition.
Short | IPS Plan of Care SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
316. Composition.section:sectionPlanOfCare.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
318. Composition.section:sectionPlanOfCare.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
320. Composition.section:sectionPlanOfCare.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
322. Composition.section:sectionPlanOfCare.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "18776-5" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
324. Composition.section:sectionPlanOfCare.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
326. Composition.section:sectionPlanOfCare.entry
Definition | Dynamic, personalized plan including identified needed healthcare activity, health objectives and healthcare goals, relating to one or more specified health issues in a healthcare process [Source EN ISO 13940] A reference to the actual resource from which the narrative in the section is derived.
Short | Optional entry used to represent structured care plansA reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(CarePlan, ImmunizationRecommendation, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
328. Composition.section:sectionPlanOfCare.entry:carePlan
Slice Name | carePlan
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(CarePlan, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
330. Composition.section:sectionPlanOfCare.entry:immunizationRecommendation
Slice Name | immunizationRecommendation
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(ImmunizationRecommendation, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
332. Composition.section:sectionPlanOfCare.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
334. Composition.section:sectionSocialHistory
Slice Name | sectionSocialHistory
Definition | The social history section contains a description of the person’s Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.) The root of the sections that make up the composition.
Short | IPS Social History SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
336. Composition.section:sectionSocialHistory.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
338. Composition.section:sectionSocialHistory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
340. Composition.section:sectionSocialHistory.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
342. Composition.section:sectionSocialHistory.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "29762-2" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
344. Composition.section:sectionSocialHistory.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
346. Composition.section:sectionSocialHistory.entry
Definition | Description of the person’s Health related “lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.) A reference to the actual resource from which the narrative in the section is derived.
Short | Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
348. Composition.section:sectionSocialHistory.entry:smokingTobaccoUse
Slice Name | smokingTobaccoUse
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..1* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Social History - Tobacco Use (IPS), Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
350. Composition.section:sectionSocialHistory.entry:alcoholUse
Slice Name | alcoholUse
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..1* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Social History - Alcohol Use (IPS), Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
352. Composition.section:sectionSocialHistory.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
354. Composition.section:sectionVitalSigns
Slice Name | sectionVitalSigns
Definition | The Vital signs section includes blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included The root of the sections that make up the composition.
Short | IPS Vital Signs SectionComposition is broken into sections
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Label | Vital signs
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) cmp-1: A section must contain at least one of text, entries, or sub-sections (text.exists() or entry.exists() or section.exists()) cmp-2: A section can only have an emptyReason if it is empty (emptyReason.empty() or entry.empty())
356. Composition.section:sectionVitalSigns.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
358. Composition.section:sectionVitalSigns.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
360. Composition.section:sectionVitalSigns.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 10..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
362. Composition.section:sectionVitalSigns.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 10..1
Binding | For example codes, see DocumentSectionCodes http://hl7.org/fhir/ValueSet/doc-section-codes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "8716-3" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
364. Composition.section:sectionVitalSigns.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 10..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
366. Composition.section:sectionVitalSigns.entry
Definition | Notable vital signs or physical findings as: blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included A reference to the actual resource from which the narrative in the section is derived.
Short | Notable vital signs or physical findings.A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DocumentReference, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
368. Composition.section:sectionVitalSigns.entry:vitalSign
Slice Name | vitalSign
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Vital Signs Profile, Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
370. Composition.section:sectionVitalSigns.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0* This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Composition
Definition | International Patient Summary composition. A composition is a set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
Short | International Patient Summary composition
2. Composition.meta
4. Composition.meta.profile
Definition | The conformance of this Composition to a specific version of the IPS (e.g. http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips|2.0.0 for 2.0.0)
Short | The conformance of this Composition to a specific IPS version.
Must Support | true
Obligations |
Obligations | Actor
MAY:able-to-populate | Creator (IPS)
6. Composition.text
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
8. Composition.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
10. Composition.status
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
12. Composition.type
Definition | Specifies that this composition refers to a Patient Summary (Loinc "60591-5")
Short | Kind of composition ("Patient Summary")
Type | CodeableConcept(Codeable Concept (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "60591-5" }] }`
14. Composition.subject
Definition | Who or what the composition is about. In general a 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). For the IPS the subject is always the patient.
Control | 1..?
Type | Reference(Patient (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
16. Composition.subject.reference
Control | 1..?
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
18. Composition.date
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
20. Composition.author
Short | Who and/or what authored the IPS
Comments | The distinction between the two types of IPS, "human-curated" or "software-assembled", is based on the authors recorded in this field: the author refers to humans (i.e. Practitioner, PractitionerRole, Patient, and/or RelatedPerson) if the IPS provenance is "human-curated", or devices (i.e. Device) if the IPS provenance is "software-assembled". In the case of a software-assembled IPS that is then verified by a human, the author would be the device that constructed the IPS document, but additional attesters would identity the humans who performed this check.
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
22. Composition.title
Definition | Official human-readable label for the composition. This would typically include a label of "International Patient Summary" or any equivalent translation and other relevant document information
Short | The title of this patient summary. This may include information like the patient name and time generated
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
24. Composition.attester
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
26. Composition.attester.mode
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
28. Composition.attester.time
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
30. Composition.attester.party
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
32. Composition.custodian
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
34. Composition.relatesTo
36. Composition.relatesTo.target[x]
Type | Choice of: Identifier, Reference(Composition, Composition (IPS))
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
38. Composition.event
Definition | The main activity being described by a IPS is the provision of healthcare over a period of time. In the CDA representation of the IPS this is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. In the FHIR representation at least one event should be used to record this information. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the start value should represent the date when the treatment relationship between the patient and the GP started; and the end value the date of the latest care event.
Slicing | This element introduces a set of slices on `Composition.event`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ code
40. Composition.event:careProvisioningEvent
Slice Name | careProvisioningEvent
Definition | The provision of healthcare over a period of time this IPS is documenting.
Short | The care provisioning being documented
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
42. Composition.event:careProvisioningEvent.code
Control | 1..1
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActClass", "code" : "PCPR" }] }`
44. Composition.event:careProvisioningEvent.period
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
46. Composition.section
Definition | The root of the sections that make up the IPS composition.
Short | Sections composing the IPS
Control | 3..?
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Slicing | This element introduces a set of slices on `Composition.section`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ code
48. Composition.section.extension
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
50. Composition.section.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
52. Composition.section.title
Control | 1..?
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
54. Composition.section.code
Control | 1..?
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
56. Composition.section.text
Control | 1..?
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
58. Composition.section.section
Control | 0..0
60. Composition.section:sectionProblems
Slice Name | sectionProblems
Definition | The IPS problem section lists and describes clinical problems or conditions currently being monitored for the patient.
Short | IPS Problems Section
Control | 1..1
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Invariants | ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`)
62. Composition.section:sectionProblems.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
64. Composition.section:sectionProblems.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11450-4" }] }`
66. Composition.section:sectionProblems.entry
Definition | It lists and describes clinical problems or conditions currently being monitored for the patient. This entry shall be used to document that no information about problems is available, or that no relevant problems are known.
Short | Clinical problems or conditions currently being monitored for the patient.
Type | Reference(Condition, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
68. Composition.section:sectionProblems.entry:problem
Slice Name | problem
Control | 0..*
Type | Reference(Condition (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
70. Composition.section:sectionProblems.emptyReason
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
72. Composition.section:sectionAllergies
Slice Name | sectionAllergies
Definition | This section documents the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. If no information about allergies is available, or if no allergies are known this should be clearly documented in the section.
Short | IPS Allergies and Intolerances Section
Control | 1..1
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Invariants | ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`)
74. Composition.section:sectionAllergies.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
76. Composition.section:sectionAllergies.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "48765-2" }] }`
78. Composition.section:sectionAllergies.entry
Definition | It lists the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. This entry shall be used to document that no information about allergies is available, or that no allergies are known .
Short | Relevant allergies or intolerances for that patient.
Type | Reference(AllergyIntolerance, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
80. Composition.section:sectionAllergies.entry:allergyOrIntolerance
Slice Name | allergyOrIntolerance
Control | 0..*
Type | Reference(AllergyIntolerance (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
82. Composition.section:sectionAllergies.emptyReason
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
84. Composition.section:sectionMedications
Slice Name | sectionMedications
Definition | The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary. The actual content could depend on the jurisdiction, it could report: the currently active medications; the current and past medications considered relevant by the authoring GP; the patient prescriptions or dispensations automatically extracted by a regional or a national EHR. In those cases medications are documented in the Patient Summary as medication statements or medication requests. This section requires either an entry indicating the subject is known not to be on any relevant medication; either an entry indicating that no information is available about medications; or entries summarizing the subject's relevant medications.
Short | IPS Medication Summary Section
Control | 1..1
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Invariants | ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`)
86. Composition.section:sectionMedications.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
88. Composition.section:sectionMedications.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "10160-0" }] }`
90. Composition.section:sectionMedications.entry
Definition | This list the medications relevant for the scope of the patient summary or it is used to indicate that the subject is known not to be on any relevant medication; either that no information is available about medications.
Short | Medications relevant for the scope of the patient summary
Type | Reference(MedicationStatement, MedicationRequest, MedicationAdministration, MedicationDispense, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
92. Composition.section:sectionMedications.entry:medicationStatementOrRequest
Slice Name | medicationStatementOrRequest
Control | 0..*
Type | Reference(MedicationStatement (IPS), MedicationRequest (IPS))
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
94. Composition.section:sectionMedications.emptyReason
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
96. Composition.section:sectionImmunizations
Slice Name | sectionImmunizations
Definition | The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section includes the current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized.
Short | IPS Immunizations Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
98. Composition.section:sectionImmunizations.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
100. Composition.section:sectionImmunizations.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11369-6" }] }`
102. Composition.section:sectionImmunizations.entry
Definition | It defines the patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. It may contain the entire immunization history that is relevant to the period of time being summarized. This entry shall be used to document that no information about immunizations is available, or that no immunizations are known.
Short | Patient's immunization status and pertinent history.
Type | Reference(Immunization, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
104. Composition.section:sectionImmunizations.entry:immunization
Slice Name | immunization
Control | 0..*
Type | Reference(Immunization (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
106. Composition.section:sectionResults
Slice Name | sectionResults
Definition | This section assembles relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.
Short | IPS Results Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
108. Composition.section:sectionResults.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
110. Composition.section:sectionResults.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "30954-2" }] }`
112. Composition.section:sectionResults.entry
Definition | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.
Short | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient.
Type | Reference(Observation, DiagnosticReport, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ resolve() profile @ resolve()
114. Composition.section:sectionResults.entry:results-observation-laboratory-pathology
Slice Name | results-observation-laboratory-pathology
Control | 0..*
Type | Reference(Observation Results - Laboratory/Pathology (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
116. Composition.section:sectionResults.entry:results-observation-radiology
Slice Name | results-observation-radiology
Control | 0..*
Type | Reference(Observation Results - Radiology (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
118. Composition.section:sectionResults.entry:results-diagnosticReport
Slice Name | results-diagnosticReport
Control | 0..*
Type | Reference(DiagnosticReport (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
120. Composition.section:sectionProceduresHx
Slice Name | sectionProceduresHx
Definition | The History of Procedures Section contains a description of the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) Therapeutic procedure: e.g. dialysis; Surgical procedure: e.g. appendectomy
Short | IPS History of Procedures Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
122. Composition.section:sectionProceduresHx.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
124. Composition.section:sectionProceduresHx.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "47519-4" }] }`
126. Composition.section:sectionProceduresHx.entry
Definition | It lists the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) Therapeutic procedure: e.g. dialysis; Surgical procedure: e.g. appendectomy. This entry shall be used to document that no information about past procedures is available, or that no relevant past procedures are known.
Short | Patient past procedures pertinent to the scope of this document.
Type | Reference(Procedure, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
128. Composition.section:sectionProceduresHx.entry:procedure
Slice Name | procedure
Control | 0..*
Type | Reference(Procedure (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
130. Composition.section:sectionMedicalDevices
Slice Name | sectionMedicalDevices
Definition | The medical devices section contains narrative text and coded entries describing the patient history of medical device use.
Short | IPS Medical Devices Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
132. Composition.section:sectionMedicalDevices.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
134. Composition.section:sectionMedicalDevices.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "46264-8" }] }`
136. Composition.section:sectionMedicalDevices.entry
Definition | It describes the patient history of medical device use. This entry shall be used to document that no information about medical device use is available, or that no relevant medical device use is known.
Short | Patient history of medical device use.
Type | Reference(DeviceUseStatement, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
138. Composition.section:sectionMedicalDevices.entry:deviceStatement
Slice Name | deviceStatement
Control | 0..*
Type | Reference(DeviceUseStatement (IPS))
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
140. Composition.section:sectionAdvanceDirectives
Slice Name | sectionAdvanceDirectives
Definition | The advance directives section contains a narrative description of patient's advance directive.
Short | IPS Advance Directives Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
142. Composition.section:sectionAdvanceDirectives.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
144. Composition.section:sectionAdvanceDirectives.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "42348-3" }] }`
146. Composition.section:sectionAdvanceDirectives.entry
Definition | Contains a narrative description or a Consent entry with information about the patient's advance directive.
Short | Narrative description of the patient's advance directive.
Type | Reference(Consent, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
148. Composition.section:sectionAdvanceDirectives.entry:advanceDirectivesConsent
Slice Name | advanceDirectivesConsent
Control | 0..*
Type | Reference(Consent)
150. Composition.section:sectionAlerts
Slice Name | sectionAlerts
Definition | The alerts section flags potential concerns and/or dangers to/from the patient and may also include obstacles to care.
Short | IPS Alerts Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
152. Composition.section:sectionAlerts.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
154. Composition.section:sectionAlerts.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "104605-1" }] }`
156. Composition.section:sectionAlerts.entry
Definition | Contains alert information to be communicated. May optionally reference other resources in IPS.
Short | Alert information.
Type | Reference(Flag, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
158. Composition.section:sectionAlerts.entry:alertsFlag
Slice Name | alertsFlag
Control | 0..*
Type | Reference(Flag - Alert (IPS))
160. Composition.section:sectionFunctionalStatus
Slice Name | sectionFunctionalStatus
Definition | The functional status section shall contain a narrative description of capability of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide.
Short | IPS Functional Status
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
162. Composition.section:sectionFunctionalStatus.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
164. Composition.section:sectionFunctionalStatus.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "47420-5" }] }`
166. Composition.section:sectionFunctionalStatus.entry
Definition | It describes capabilities of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide.
Short | Optional entry used to represent disabilities and functional assessments
Type | Reference(Condition, ClinicalImpression, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
168. Composition.section:sectionFunctionalStatus.entry:disability
Slice Name | disability
Control | 0..*
Type | Reference(Condition (IPS))
170. Composition.section:sectionFunctionalStatus.entry:functionalAssessment
Slice Name | functionalAssessment
Control | 0..*
Type | Reference(ClinicalImpression)
172. Composition.section:sectionPastProblems
Slice Name | sectionPastProblems
Definition | The History of Past Problems section contains a description of the conditions the patient suffered in the past but no longer tracked in the Problem List.
Short | IPS History of Past Problems Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
174. Composition.section:sectionPastProblems.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
176. Composition.section:sectionPastProblems.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11348-0" }] }`
178. Composition.section:sectionPastProblems.entry
Definition | It contains a description of the conditions the patient suffered in the past.
Short | Conditions the patient suffered in the past.
Type | Reference(Condition, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
180. Composition.section:sectionPastProblems.entry:pastProblem
Slice Name | pastProblem
Control | 0..*
Type | Reference(Condition (IPS))
182. Composition.section:sectionPregnancyHx
Slice Name | sectionPregnancyHx
Definition | The history of pregnancy section shall contain information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.
Short | IPS History of Pregnancy Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
184. Composition.section:sectionPregnancyHx.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
186. Composition.section:sectionPregnancyHx.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "10162-6" }] }`
188. Composition.section:sectionPregnancyHx.entry
Definition | It contains information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.
Short | Current pregnancy status and, optionally, information about the outcome of earlier pregnancies.
Type | Reference(Observation, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
190. Composition.section:sectionPregnancyHx.entry:pregnancyStatus
Slice Name | pregnancyStatus
Control | 0..*
Type | Reference(Observation Pregnancy - Status (IPS))
192. Composition.section:sectionPregnancyHx.entry:pregnancyOutcome
Slice Name | pregnancyOutcome
Control | 0..*
Type | Reference(Observation Pregnancy - Outcome (IPS))
194. Composition.section:sectionPatientStory
Slice Name | sectionPatientStory
Definition | The section contains narrative text along with optional resources that express what matters to a patient. This may include needs, strengths, values, concerns and preferences to others providing support and care. The patient’s story, provided here, may be told by the patient or by a proxy.
Short | IPS Patient Story Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
196. Composition.section:sectionPatientStory.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
198. Composition.section:sectionPatientStory.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "81338-6" }] }`
200. Composition.section:sectionPatientStory.entry
Definition | Contains resources to support the Patient Story. Instances of DocumentReference or any other suitable resource type may be used.
Short | Patient Story resources.
202. Composition.section:sectionPlanOfCare
Slice Name | sectionPlanOfCare
Definition | The plan of care section contains a narrative description of the expectations for care including proposals, goals, and order requests for monitoring, tracking, or improving the condition of the patient.
Short | IPS Plan of Care Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
204. Composition.section:sectionPlanOfCare.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
206. Composition.section:sectionPlanOfCare.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "18776-5" }] }`
208. Composition.section:sectionPlanOfCare.entry
Definition | Dynamic, personalized plan including identified needed healthcare activity, health objectives and healthcare goals, relating to one or more specified health issues in a healthcare process [Source EN ISO 13940]
Short | Optional entry used to represent structured care plans
Type | Reference(CarePlan, ImmunizationRecommendation, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
210. Composition.section:sectionPlanOfCare.entry:carePlan
Slice Name | carePlan
Control | 0..*
Type | Reference(CarePlan)
212. Composition.section:sectionPlanOfCare.entry:immunizationRecommendation
Slice Name | immunizationRecommendation
Control | 0..*
Type | Reference(ImmunizationRecommendation)
214. Composition.section:sectionSocialHistory
Slice Name | sectionSocialHistory
Definition | The social history section contains a description of the person’s Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)
Short | IPS Social History Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
216. Composition.section:sectionSocialHistory.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
218. Composition.section:sectionSocialHistory.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "29762-2" }] }`
220. Composition.section:sectionSocialHistory.entry
Definition | Description of the person’s Health related “lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)
Short | Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)
Type | Reference(Observation, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
222. Composition.section:sectionSocialHistory.entry:smokingTobaccoUse
Slice Name | smokingTobaccoUse
Control | 0..1
Type | Reference(Observation Social History - Tobacco Use (IPS))
224. Composition.section:sectionSocialHistory.entry:alcoholUse
Slice Name | alcoholUse
Control | 0..1
Type | Reference(Observation Social History - Alcohol Use (IPS))
226. Composition.section:sectionVitalSigns
Slice Name | sectionVitalSigns
Definition | The Vital signs section includes blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included
Short | IPS Vital Signs Section
Control | 0..1
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Label | Vital signs
228. Composition.section:sectionVitalSigns.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Control | 0..*
Type | Extension(Note) (Extension Type: Annotation)
230. Composition.section:sectionVitalSigns.code
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "8716-3" }] }`
232. Composition.section:sectionVitalSigns.entry
Definition | Notable vital signs or physical findings as: blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included
Short | Notable vital signs or physical findings.
Type | Reference(Observation, DocumentReference)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
234. Composition.section:sectionVitalSigns.entry:vitalSign
Slice Name | vitalSign
Control | 0..*
Type | Reference(Vital Signs Profile)

Guidance on how to interpret the contents of this table can be foundhere

0. Composition
Definition | International Patient Summary composition. A composition is a set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
Short | International Patient Summary composition
Comments | While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.
Control | 0..*
Is Modifier | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. Composition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Is Modifier | false
Summary | true
4. Composition.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Composition.meta.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. Composition.meta.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. Composition.meta.versionId
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Short | Version specific identifier
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Control | 0..1
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Composition.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | When the resource version last changed
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
Control | 0..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
14. Composition.meta.source
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Short | Identifies where the resource comes from
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
16. Composition.meta.profile
Definition | The conformance of this Composition to a specific version of the IPS (e.g. http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips|2.0.0 for 2.0.0)
Short | The conformance of this Composition to a specific IPS version.
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Control | 0..*
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
MAY:able-to-populate | Creator (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Composition.meta.security
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Short | Security Labels applied to this resource
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Composition.meta.tag
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Short | Tags applied to this resource
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Control | 0..*
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Composition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Composition.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Composition.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. 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.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Control | 0..*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
30. Composition.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
32. Composition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
34. Composition.identifier
Definition | A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
Short | Version-independent identifier for the Composition
Comments | Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Composition.status
Definition | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
Short | preliminary | final | amended | entered-in-error
Comments | If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements. Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.
Control | 1..1
Binding | The codes SHALL be taken from CompositionStatus (required to `http://hl7.org/fhir/ValueSet/composition-status|4.0.1` ) The workflow/clinical status of the composition.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Need to be able to mark interim, amended, or withdrawn compositions or documents.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. Composition.type
Definition | Specifies that this composition refers to a Patient Summary (Loinc "60591-5")
Short | Kind of composition ("Patient Summary")
Comments | For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.
Control | 1..1
Binding | The codes SHOULD be taken from FHIRDocumentTypeCodes (preferred to `http://hl7.org/fhir/ValueSet/doc-typecodes` ) Type of a composition.
Type | CodeableConcept(Codeable Concept (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
Summary | true
Requirements | Key metadata element describing the composition, used in searching/filtering.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "60591-5" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Composition.category
Definition | A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
Short | Categorization of Composition
Comments | This is a metadata field from XDS/MHD.
Control | 0..*
Binding | For example codes, see DocumentClassValueSet (example to `http://hl7.org/fhir/ValueSet/document-classcodes` ) High-level kind of a clinical document at a macro level.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Composition.subject
Definition | Who or what the composition is about. In general a 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). For the IPS the subject is always the patient.
Short | Who and/or what the composition is about
Comments | For clinical documents, this is usually the patient.
Control | 1..1
Type | Reference(Patient (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Composition.subject.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
46. Composition.subject.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.subject.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
48. Composition.subject.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.
Short | Literal reference, Relative, internal or absolute URL
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.
Control | 1..1 This element is affected by the following invariants: ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Composition.subject.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient")
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Composition.subject.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Short | Logical reference, when literal reference is not known
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. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Composition.subject.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
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.
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Composition.encounter
Definition | Describes the clinical encounter or type of care this documentation is associated with.
Short | Context of the Composition
Control | 0..1
Type | Reference(Encounter)
Is Modifier | false
Summary | true
Requirements | Provides context for the composition and supports searching.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Composition.date
Definition | The composition editing time, when the composition was last logically changed by the author.
Short | Composition editing time
Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Composition.author
Definition | Identifies who is responsible for the information in the composition, not necessarily who typed it in.
Short | Who and/or what authored the IPS
Comments | The distinction between the two types of IPS, "human-curated" or "software-assembled", is based on the authors recorded in this field: the author refers to humans (i.e. Practitioner, PractitionerRole, Patient, and/or RelatedPerson) if the IPS provenance is "human-curated", or devices (i.e. Device) if the IPS provenance is "software-assembled". In the case of a software-assembled IPS that is then verified by a human, the author would be the device that constructed the IPS document, but additional attesters would identity the humans who performed this check.
Control | 1..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Composition.title
Definition | Official human-readable label for the composition. This would typically include a label of "International Patient Summary" or any equivalent translation and other relevant document information
Short | The title of this patient summary. This may include information like the patient name and time generated
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.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Composition.confidentiality
Definition | The code specifying the level of confidentiality of the Composition.
Short | As defined by affinity domain
Comments | The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.
Control | 0..1
Binding | The codes SHALL be taken from v3.ConfidentialityClassification (2014-03-26) (required to `http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26` ) Codes specifying the level of confidentiality of the composition.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Composition.attester
Definition | A participant who has attested to the accuracy of the composition/document.
Short | Attests to accuracy of composition
Comments | Only list each attester once.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Identifies responsibility for the accuracy of the composition content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Composition.attester.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
70. Composition.attester.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
72. Composition.attester.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
74. Composition.attester.mode
Definition | The type of attestation the authenticator offers.
Short | personal | professional | legal | official
Control | 1..1
Binding | The codes SHALL be taken from CompositionAttestationMode (required to `http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1` ) The way in which a person authenticated a composition.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Indicates the level of authority of the attestation.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Composition.attester.time
Definition | When the composition was attested by the party.
Short | When the composition was attested
Control | 0..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Composition.attester.party
Definition | Who attested the composition in the specified way.
Short | Who attested the composition
Control | 0..1
Type | Reference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization)
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Identifies who has taken on the responsibility for accuracy of the composition content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. Composition.custodian
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
Short | Organization which maintains the composition
Comments | This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Identifies where to go to find the current version, where to report issues, etc.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. Composition.relatesTo
Definition | Relationships that this composition has with other compositions or documents that already exist.
Short | Relationships to other compositions/documents
Comments | A document is a version specific composition.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. Composition.relatesTo.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
86. Composition.relatesTo.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
88. Composition.relatesTo.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
90. Composition.relatesTo.code
Definition | The type of relationship that this composition has with anther composition or document.
Short | replaces | transforms | signs | appends
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.
Control | 1..1
Binding | The codes SHALL be taken from DocumentRelationshipType (required to `http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1` ) The type of relationship between documents.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. Composition.relatesTo.target[x]
Definition | The target composition/document of this relationship.
Short | Target of the relationship
Control | 1..1
Type | Choice of: Identifier, Reference(Composition, Composition (IPS))
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. Composition.event
Definition | The main activity being described by a IPS is the provision of healthcare over a period of time. In the CDA representation of the IPS this is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision) and indicating the duration over which care was provided in serviceEvent/effectiveTime. In the FHIR representation at least one event should be used to record this information. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range). For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the start value should represent the date when the treatment relationship between the patient and the GP started; and the end value the date of the latest care event.
Short | The clinical service(s) being documented
Comments | The event needs to be consistent with the type element, though can provide further information if desired.
Control | 0..*
Type | BackboneElement
Is Modifier | false
Summary | true
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.event`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ code
96. Composition.event.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
98. Composition.event.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
100. Composition.event.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
102. Composition.event.code
Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
Short | Code(s) that apply to the event being documented
Comments | An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.
Control | 0..*
Binding | For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` ) This list of codes represents the main clinical acts being documented.
Type | CodeableConcept
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. Composition.event.period
Definition | The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
Short | The period covered by the documentation
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. Composition.event.detail
Definition | The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
Short | The event(s) being documented
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. Composition.event:careProvisioningEvent
Slice Name | careProvisioningEvent
Definition | The provision of healthcare over a period of time this IPS is documenting.
Short | The care provisioning being documented
Comments | The event needs to be consistent with the type element, though can provide further information if desired.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. Composition.event:careProvisioningEvent.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
112. Composition.event:careProvisioningEvent.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
114. Composition.event:careProvisioningEvent.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
116. Composition.event:careProvisioningEvent.code
Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
Short | Code(s) that apply to the event being documented
Comments | An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.
Control | 1..1
Binding | For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` ) This list of codes represents the main clinical acts being documented.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/v3-ActClass", "code" : "PCPR" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. Composition.event:careProvisioningEvent.period
Definition | The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
Short | The period covered by the documentation
Control | 0..1
Type | Period
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. Composition.event:careProvisioningEvent.detail
Definition | The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
Short | The event(s) being documented
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. Composition.section
Definition | The root of the sections that make up the IPS composition.
Short | Sections composing the IPS
Control | 3..*
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ code
124. Composition.section.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
126. Composition.section.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
128. Composition.section.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
130. Composition.section.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
132. Composition.section.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. Composition.section.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. Composition.section.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. Composition.section.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. Composition.section.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Composition.section.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. Composition.section.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. Composition.section.entry
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. Composition.section.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. Composition.section.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. Composition.section:sectionProblems
Slice Name | sectionProblems
Definition | The IPS problem section lists and describes clinical problems or conditions currently being monitored for the patient.
Short | IPS Problems Section
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`)
154. Composition.section:sectionProblems.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
156. Composition.section:sectionProblems.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
158. Composition.section:sectionProblems.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
160. Composition.section:sectionProblems.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
162. Composition.section:sectionProblems.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. Composition.section:sectionProblems.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11450-4" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. Composition.section:sectionProblems.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. Composition.section:sectionProblems.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
170. Composition.section:sectionProblems.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. Composition.section:sectionProblems.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
174. Composition.section:sectionProblems.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
176. Composition.section:sectionProblems.entry
Definition | It lists and describes clinical problems or conditions currently being monitored for the patient. This entry shall be used to document that no information about problems is available, or that no relevant problems are known.
Short | Clinical problems or conditions currently being monitored for the patient.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
178. Composition.section:sectionProblems.entry:problem
Slice Name | problem
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. Composition.section:sectionProblems.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
182. Composition.section:sectionProblems.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
184. Composition.section:sectionAllergies
Slice Name | sectionAllergies
Definition | This section documents the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. If no information about allergies is available, or if no allergies are known this should be clearly documented in the section.
Short | IPS Allergies and Intolerances Section
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`)
186. Composition.section:sectionAllergies.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
188. Composition.section:sectionAllergies.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
190. Composition.section:sectionAllergies.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
192. Composition.section:sectionAllergies.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
194. Composition.section:sectionAllergies.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
196. Composition.section:sectionAllergies.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "48765-2" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
198. Composition.section:sectionAllergies.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
200. Composition.section:sectionAllergies.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
202. Composition.section:sectionAllergies.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
204. Composition.section:sectionAllergies.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
206. Composition.section:sectionAllergies.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
208. Composition.section:sectionAllergies.entry
Definition | It lists the relevant allergies or intolerances for that patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. This entry shall be used to document that no information about allergies is available, or that no allergies are known .
Short | Relevant allergies or intolerances for that patient.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(AllergyIntolerance, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
210. Composition.section:sectionAllergies.entry:allergyOrIntolerance
Slice Name | allergyOrIntolerance
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(AllergyIntolerance (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
212. Composition.section:sectionAllergies.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
214. Composition.section:sectionAllergies.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
216. Composition.section:sectionMedications
Slice Name | sectionMedications
Definition | The medication summary section contains a description of the patient's medications relevant for the scope of the patient summary. The actual content could depend on the jurisdiction, it could report: the currently active medications; the current and past medications considered relevant by the authoring GP; the patient prescriptions or dispensations automatically extracted by a regional or a national EHR. In those cases medications are documented in the Patient Summary as medication statements or medication requests. This section requires either an entry indicating the subject is known not to be on any relevant medication; either an entry indicating that no information is available about medications; or entries summarizing the subject's relevant medications.
Short | IPS Medication Summary Section
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ips-comp-1: Either section.entry or emptyReason are present (`(entry.reference.exists() or emptyReason.exists())`)
218. Composition.section:sectionMedications.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
220. Composition.section:sectionMedications.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
222. Composition.section:sectionMedications.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
224. Composition.section:sectionMedications.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
226. Composition.section:sectionMedications.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
228. Composition.section:sectionMedications.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "10160-0" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. Composition.section:sectionMedications.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. Composition.section:sectionMedications.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
234. Composition.section:sectionMedications.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
236. Composition.section:sectionMedications.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
238. Composition.section:sectionMedications.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
240. Composition.section:sectionMedications.entry
Definition | This list the medications relevant for the scope of the patient summary or it is used to indicate that the subject is known not to be on any relevant medication; either that no information is available about medications.
Short | Medications relevant for the scope of the patient summary
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(MedicationStatement, MedicationRequest, MedicationAdministration, MedicationDispense, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
242. Composition.section:sectionMedications.entry:medicationStatementOrRequest
Slice Name | medicationStatementOrRequest
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(MedicationStatement (IPS), MedicationRequest (IPS))
Is Modifier | false
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Obligations |
Obligations | Actor
SHALL:able-to-populate | Creator (IPS)
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
244. Composition.section:sectionMedications.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
246. Composition.section:sectionMedications.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. Composition.section:sectionImmunizations
Slice Name | sectionImmunizations
Definition | The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section includes the current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized.
Short | IPS Immunizations Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
250. Composition.section:sectionImmunizations.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
252. Composition.section:sectionImmunizations.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
254. Composition.section:sectionImmunizations.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
256. Composition.section:sectionImmunizations.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
258. Composition.section:sectionImmunizations.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
260. Composition.section:sectionImmunizations.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11369-6" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
262. Composition.section:sectionImmunizations.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
264. Composition.section:sectionImmunizations.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
266. Composition.section:sectionImmunizations.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
268. Composition.section:sectionImmunizations.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
270. Composition.section:sectionImmunizations.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
272. Composition.section:sectionImmunizations.entry
Definition | It defines the patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. It may contain the entire immunization history that is relevant to the period of time being summarized. This entry shall be used to document that no information about immunizations is available, or that no immunizations are known.
Short | Patient's immunization status and pertinent history.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Immunization, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
274. Composition.section:sectionImmunizations.entry:immunization
Slice Name | immunization
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Immunization (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
276. Composition.section:sectionImmunizations.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
278. Composition.section:sectionImmunizations.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
280. Composition.section:sectionResults
Slice Name | sectionResults
Definition | This section assembles relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.
Short | IPS Results Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
282. Composition.section:sectionResults.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
284. Composition.section:sectionResults.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
286. Composition.section:sectionResults.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
288. Composition.section:sectionResults.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
290. Composition.section:sectionResults.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
292. Composition.section:sectionResults.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "30954-2" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
294. Composition.section:sectionResults.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
296. Composition.section:sectionResults.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
298. Composition.section:sectionResults.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
300. Composition.section:sectionResults.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
302. Composition.section:sectionResults.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
304. Composition.section:sectionResults.entry
Definition | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient. Some of these results may be laboratory results, others may be anatomic pathology results, others, radiology results, and others, clinical results.
Short | Relevant observation results collected on the patient or produced on in-vitro biologic specimens collected from the patient.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DiagnosticReport, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: type @ resolve() profile @ resolve()
306. Composition.section:sectionResults.entry:results-observation-laboratory-pathology
Slice Name | results-observation-laboratory-pathology
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Results - Laboratory/Pathology (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
308. Composition.section:sectionResults.entry:results-observation-radiology
Slice Name | results-observation-radiology
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Results - Radiology (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
310. Composition.section:sectionResults.entry:results-diagnosticReport
Slice Name | results-diagnosticReport
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(DiagnosticReport (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
312. Composition.section:sectionResults.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
314. Composition.section:sectionResults.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
316. Composition.section:sectionProceduresHx
Slice Name | sectionProceduresHx
Definition | The History of Procedures Section contains a description of the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) Therapeutic procedure: e.g. dialysis; Surgical procedure: e.g. appendectomy
Short | IPS History of Procedures Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
318. Composition.section:sectionProceduresHx.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
320. Composition.section:sectionProceduresHx.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
322. Composition.section:sectionProceduresHx.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
324. Composition.section:sectionProceduresHx.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
326. Composition.section:sectionProceduresHx.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
328. Composition.section:sectionProceduresHx.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "47519-4" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
330. Composition.section:sectionProceduresHx.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
332. Composition.section:sectionProceduresHx.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
334. Composition.section:sectionProceduresHx.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
336. Composition.section:sectionProceduresHx.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
338. Composition.section:sectionProceduresHx.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
340. Composition.section:sectionProceduresHx.entry
Definition | It lists the patient past procedures that are pertinent to the scope of this document. Procedures may refer for example to: Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section) Therapeutic procedure: e.g. dialysis; Surgical procedure: e.g. appendectomy. This entry shall be used to document that no information about past procedures is available, or that no relevant past procedures are known.
Short | Patient past procedures pertinent to the scope of this document.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Procedure, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
342. Composition.section:sectionProceduresHx.entry:procedure
Slice Name | procedure
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Procedure (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
344. Composition.section:sectionProceduresHx.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
346. Composition.section:sectionProceduresHx.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
348. Composition.section:sectionMedicalDevices
Slice Name | sectionMedicalDevices
Definition | The medical devices section contains narrative text and coded entries describing the patient history of medical device use.
Short | IPS Medical Devices Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
350. Composition.section:sectionMedicalDevices.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
352. Composition.section:sectionMedicalDevices.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
354. Composition.section:sectionMedicalDevices.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
356. Composition.section:sectionMedicalDevices.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
358. Composition.section:sectionMedicalDevices.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
360. Composition.section:sectionMedicalDevices.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "46264-8" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
362. Composition.section:sectionMedicalDevices.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
364. Composition.section:sectionMedicalDevices.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
366. Composition.section:sectionMedicalDevices.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
368. Composition.section:sectionMedicalDevices.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
370. Composition.section:sectionMedicalDevices.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
372. Composition.section:sectionMedicalDevices.entry
Definition | It describes the patient history of medical device use. This entry shall be used to document that no information about medical device use is available, or that no relevant medical device use is known.
Short | Patient history of medical device use.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(DeviceUseStatement, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
374. Composition.section:sectionMedicalDevices.entry:deviceStatement
Slice Name | deviceStatement
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(DeviceUseStatement (IPS))
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
376. Composition.section:sectionMedicalDevices.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
378. Composition.section:sectionMedicalDevices.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
380. Composition.section:sectionAdvanceDirectives
Slice Name | sectionAdvanceDirectives
Definition | The advance directives section contains a narrative description of patient's advance directive.
Short | IPS Advance Directives Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
382. Composition.section:sectionAdvanceDirectives.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
384. Composition.section:sectionAdvanceDirectives.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
386. Composition.section:sectionAdvanceDirectives.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
388. Composition.section:sectionAdvanceDirectives.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
390. Composition.section:sectionAdvanceDirectives.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
392. Composition.section:sectionAdvanceDirectives.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "42348-3" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
394. Composition.section:sectionAdvanceDirectives.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
396. Composition.section:sectionAdvanceDirectives.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
398. Composition.section:sectionAdvanceDirectives.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
400. Composition.section:sectionAdvanceDirectives.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
402. Composition.section:sectionAdvanceDirectives.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
404. Composition.section:sectionAdvanceDirectives.entry
Definition | Contains a narrative description or a Consent entry with information about the patient's advance directive.
Short | Narrative description of the patient's advance directive.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Consent, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
406. Composition.section:sectionAdvanceDirectives.entry:advanceDirectivesConsent
Slice Name | advanceDirectivesConsent
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Consent)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
408. Composition.section:sectionAdvanceDirectives.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
410. Composition.section:sectionAdvanceDirectives.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
412. Composition.section:sectionAlerts
Slice Name | sectionAlerts
Definition | The alerts section flags potential concerns and/or dangers to/from the patient and may also include obstacles to care.
Short | IPS Alerts Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
414. Composition.section:sectionAlerts.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
416. Composition.section:sectionAlerts.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
418. Composition.section:sectionAlerts.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
420. Composition.section:sectionAlerts.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
422. Composition.section:sectionAlerts.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
424. Composition.section:sectionAlerts.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "104605-1" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
426. Composition.section:sectionAlerts.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
428. Composition.section:sectionAlerts.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
430. Composition.section:sectionAlerts.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
432. Composition.section:sectionAlerts.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
434. Composition.section:sectionAlerts.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
436. Composition.section:sectionAlerts.entry
Definition | Contains alert information to be communicated. May optionally reference other resources in IPS.
Short | Alert information.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Flag, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
438. Composition.section:sectionAlerts.entry:alertsFlag
Slice Name | alertsFlag
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Flag - Alert (IPS))
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
440. Composition.section:sectionAlerts.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
442. Composition.section:sectionAlerts.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
444. Composition.section:sectionFunctionalStatus
Slice Name | sectionFunctionalStatus
Definition | The functional status section shall contain a narrative description of capability of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide.
Short | IPS Functional Status
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
446. Composition.section:sectionFunctionalStatus.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
448. Composition.section:sectionFunctionalStatus.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
450. Composition.section:sectionFunctionalStatus.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
452. Composition.section:sectionFunctionalStatus.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
454. Composition.section:sectionFunctionalStatus.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
456. Composition.section:sectionFunctionalStatus.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "47420-5" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
458. Composition.section:sectionFunctionalStatus.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
460. Composition.section:sectionFunctionalStatus.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
462. Composition.section:sectionFunctionalStatus.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
464. Composition.section:sectionFunctionalStatus.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
466. Composition.section:sectionFunctionalStatus.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
468. Composition.section:sectionFunctionalStatus.entry
Definition | It describes capabilities of the patient to perform acts of daily living, including possible needs of the patient to be continuously assessed by third parties. The invalidity status may in fact influence decisions about how to administer treatments. Profiles to express disabilities and functional assessments will be specified by future versions of this guide.
Short | Optional entry used to represent disabilities and functional assessments
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition, ClinicalImpression, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
470. Composition.section:sectionFunctionalStatus.entry:disability
Slice Name | disability
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition (IPS))
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
472. Composition.section:sectionFunctionalStatus.entry:functionalAssessment
Slice Name | functionalAssessment
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(ClinicalImpression)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
474. Composition.section:sectionFunctionalStatus.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
476. Composition.section:sectionFunctionalStatus.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
478. Composition.section:sectionPastProblems
Slice Name | sectionPastProblems
Definition | The History of Past Problems section contains a description of the conditions the patient suffered in the past but no longer tracked in the Problem List.
Short | IPS History of Past Problems Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
480. Composition.section:sectionPastProblems.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
482. Composition.section:sectionPastProblems.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
484. Composition.section:sectionPastProblems.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
486. Composition.section:sectionPastProblems.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
488. Composition.section:sectionPastProblems.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
490. Composition.section:sectionPastProblems.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "11348-0" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
492. Composition.section:sectionPastProblems.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
494. Composition.section:sectionPastProblems.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
496. Composition.section:sectionPastProblems.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
498. Composition.section:sectionPastProblems.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
500. Composition.section:sectionPastProblems.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
502. Composition.section:sectionPastProblems.entry
Definition | It contains a description of the conditions the patient suffered in the past.
Short | Conditions the patient suffered in the past.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
504. Composition.section:sectionPastProblems.entry:pastProblem
Slice Name | pastProblem
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Condition (IPS))
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
506. Composition.section:sectionPastProblems.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
508. Composition.section:sectionPastProblems.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
510. Composition.section:sectionPregnancyHx
Slice Name | sectionPregnancyHx
Definition | The history of pregnancy section shall contain information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.
Short | IPS History of Pregnancy Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
512. Composition.section:sectionPregnancyHx.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
514. Composition.section:sectionPregnancyHx.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
516. Composition.section:sectionPregnancyHx.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
518. Composition.section:sectionPregnancyHx.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
520. Composition.section:sectionPregnancyHx.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
522. Composition.section:sectionPregnancyHx.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "10162-6" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
524. Composition.section:sectionPregnancyHx.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
526. Composition.section:sectionPregnancyHx.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
528. Composition.section:sectionPregnancyHx.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
530. Composition.section:sectionPregnancyHx.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
532. Composition.section:sectionPregnancyHx.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
534. Composition.section:sectionPregnancyHx.entry
Definition | It contains information about whether the patient is currently pregnant or not. It may contain addition summarizing information about the outcome of earlier pregnancies.
Short | Current pregnancy status and, optionally, information about the outcome of earlier pregnancies.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
536. Composition.section:sectionPregnancyHx.entry:pregnancyStatus
Slice Name | pregnancyStatus
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Pregnancy - Status (IPS))
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
538. Composition.section:sectionPregnancyHx.entry:pregnancyOutcome
Slice Name | pregnancyOutcome
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation Pregnancy - Outcome (IPS))
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
540. Composition.section:sectionPregnancyHx.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
542. Composition.section:sectionPregnancyHx.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
544. Composition.section:sectionPatientStory
Slice Name | sectionPatientStory
Definition | The section contains narrative text along with optional resources that express what matters to a patient. This may include needs, strengths, values, concerns and preferences to others providing support and care. The patient’s story, provided here, may be told by the patient or by a proxy.
Short | IPS Patient Story Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
546. Composition.section:sectionPatientStory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
548. Composition.section:sectionPatientStory.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
550. Composition.section:sectionPatientStory.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
552. Composition.section:sectionPatientStory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
554. Composition.section:sectionPatientStory.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
556. Composition.section:sectionPatientStory.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "81338-6" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
558. Composition.section:sectionPatientStory.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
560. Composition.section:sectionPatientStory.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
562. Composition.section:sectionPatientStory.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
564. Composition.section:sectionPatientStory.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
566. Composition.section:sectionPatientStory.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
568. Composition.section:sectionPatientStory.entry
Definition | Contains resources to support the Patient Story. Instances of DocumentReference or any other suitable resource type may be used.
Short | Patient Story resources.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
570. Composition.section:sectionPatientStory.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
572. Composition.section:sectionPatientStory.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
574. Composition.section:sectionPlanOfCare
Slice Name | sectionPlanOfCare
Definition | The plan of care section contains a narrative description of the expectations for care including proposals, goals, and order requests for monitoring, tracking, or improving the condition of the patient.
Short | IPS Plan of Care Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
576. Composition.section:sectionPlanOfCare.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
578. Composition.section:sectionPlanOfCare.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
580. Composition.section:sectionPlanOfCare.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
582. Composition.section:sectionPlanOfCare.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
584. Composition.section:sectionPlanOfCare.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
586. Composition.section:sectionPlanOfCare.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "18776-5" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
588. Composition.section:sectionPlanOfCare.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
590. Composition.section:sectionPlanOfCare.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
592. Composition.section:sectionPlanOfCare.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
594. Composition.section:sectionPlanOfCare.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
596. Composition.section:sectionPlanOfCare.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
598. Composition.section:sectionPlanOfCare.entry
Definition | Dynamic, personalized plan including identified needed healthcare activity, health objectives and healthcare goals, relating to one or more specified health issues in a healthcare process [Source EN ISO 13940]
Short | Optional entry used to represent structured care plans
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(CarePlan, ImmunizationRecommendation, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
600. Composition.section:sectionPlanOfCare.entry:carePlan
Slice Name | carePlan
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(CarePlan)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
602. Composition.section:sectionPlanOfCare.entry:immunizationRecommendation
Slice Name | immunizationRecommendation
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(ImmunizationRecommendation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
604. Composition.section:sectionPlanOfCare.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
606. Composition.section:sectionPlanOfCare.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
608. Composition.section:sectionSocialHistory
Slice Name | sectionSocialHistory
Definition | The social history section contains a description of the person’s Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)
Short | IPS Social History Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
610. Composition.section:sectionSocialHistory.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
612. Composition.section:sectionSocialHistory.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
614. Composition.section:sectionSocialHistory.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
616. Composition.section:sectionSocialHistory.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
618. Composition.section:sectionSocialHistory.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
620. Composition.section:sectionSocialHistory.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "29762-2" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
622. Composition.section:sectionSocialHistory.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
624. Composition.section:sectionSocialHistory.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
626. Composition.section:sectionSocialHistory.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
628. Composition.section:sectionSocialHistory.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
630. Composition.section:sectionSocialHistory.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
632. Composition.section:sectionSocialHistory.entry
Definition | Description of the person’s Health related “lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)
Short | Health related "lifestyle factors" or "lifestyle observations" (e.g. smoke habits; alcohol consumption; diets, risky habits.)
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
634. Composition.section:sectionSocialHistory.entry:smokingTobaccoUse
Slice Name | smokingTobaccoUse
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..1 This element is affected by the following invariants: cmp-2
Type | Reference(Observation Social History - Tobacco Use (IPS))
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
636. Composition.section:sectionSocialHistory.entry:alcoholUse
Slice Name | alcoholUse
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..1 This element is affected by the following invariants: cmp-2
Type | Reference(Observation Social History - Alcohol Use (IPS))
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
638. Composition.section:sectionSocialHistory.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
640. Composition.section:sectionSocialHistory.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
642. Composition.section:sectionVitalSigns
Slice Name | sectionVitalSigns
Definition | The Vital signs section includes blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included
Short | IPS Vital Signs Section
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHOULD:display | Consumer (IPS)
SHALL:handle | Consumer (IPS)
Summary | false
Label | Vital signs
Invariants | cmp-1: A section must contain at least one of text, entries, or sub-sections (`text.exists() or entry.exists() or section.exists()`) cmp-2: A section can only have an emptyReason if it is empty (`emptyReason.empty() or entry.empty()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
644. Composition.section:sectionVitalSigns.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
646. Composition.section:sectionVitalSigns.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Composition.section.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
648. Composition.section:sectionVitalSigns.extension:section-note
Slice Name | section-note
Definition | Additional notes that apply to the section (but not to specific resource).
Short | Additional notes that apply to the section (but not to specific resource).
Comments | This extension SHALL NOT be used if the resource already has standard 'note' element (or equivalent) of type Annotation on the same element
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(Note) (Extension Type: Annotation)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
650. Composition.section:sectionVitalSigns.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
652. Composition.section:sectionVitalSigns.title
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Short | Label for section (e.g. for ToC)
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.
Control | 1..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.
Alternate Names | header, label, caption
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
654. Composition.section:sectionVitalSigns.code
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title.
Short | Classification of section (recommended)
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.
Control | 1..1
Binding | For example codes, see DocumentSectionCodes (example to `http://hl7.org/fhir/ValueSet/doc-section-codes` ) Classification of a section of a composition/document.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Provides computable standardized labels to topics within the document.
Pattern Value | `{ "coding" : [{ "system" : "http://loinc.org", "code" : "8716-3" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
656. Composition.section:sectionVitalSigns.author
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in.
Short | Who and/or what authored the section
Control | 0..*
Type | Reference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifier | false
Summary | false
Requirements | Identifies who is responsible for the content.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
658. Composition.section:sectionVitalSigns.focus
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources).
Short | Who/what the section is about, when it is not about the subject of composition
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples.
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
660. Composition.section:sectionVitalSigns.text
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Short | Text summary of the section, for human interpretation
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety.
Control | 1..1 This element is affected by the following invariants: cmp-1
Type | Narrative
Is Modifier | false
Must Support | true
Obligations |
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
662. Composition.section:sectionVitalSigns.mode
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Short | working | snapshot | changes
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list.
Control | 0..1
Binding | The codes SHALL be taken from ListMode (required to `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` ) The processing mode that applies to this section.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
664. Composition.section:sectionVitalSigns.orderedBy
Definition | Specifies the order applied to the items in the section entries.
Short | Order of section entries
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.
Control | 0..1
Binding | The codes SHOULD be taken from ListOrderCodes (preferred to `http://hl7.org/fhir/ValueSet/list-order` ) What order applies to the items in the entry.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
666. Composition.section:sectionVitalSigns.entry
Definition | Notable vital signs or physical findings as: blood pressure, body temperature, heart rate, and respiratory rate. It may also include other clinical findings, such as height, weight, body mass index, head circumference, and pulse oximetry. In particular, notable vital signs or physical findings such as the most recent, maximum and/or minimum, baseline, or relevant trends may be included
Short | Notable vital signs or physical findings.
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Observation, DocumentReference)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `Composition.section.entry`. The slices areUnordered and Open, and can be differentiated using the following discriminators: profile @ resolve()
668. Composition.section:sectionVitalSigns.entry:vitalSign
Slice Name | vitalSign
Definition | A reference to the actual resource from which the narrative in the section is derived.
Short | A reference to data that supports this section
Comments | If there are no entries in the list, an emptyReason SHOULD be provided.
Control | 0..* This element is affected by the following invariants: cmp-2
Type | Reference(Vital Signs Profile)
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
670. Composition.section:sectionVitalSigns.emptyReason
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Short | Why the section is empty
Comments | The various reasons for an empty section make a significant 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.
Control | 0..1 This element is affected by the following invariants: cmp-2
Binding | The codes SHOULD be taken from ListEmptyReasons (preferred to `http://hl7.org/fhir/ValueSet/list-empty-reason` ) If a section is empty, why it is empty.
Type | CodeableConcept
Is Modifier | false
Summary | false
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
672. Composition.section:sectionVitalSigns.section
Definition | A nested sub-section within this section.
Short | Nested Section
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document.
Control | 0..0 This element is affected by the following invariants: cmp-1
Type | Seettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
Is Modifier | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)