International Patient Summary Implementation Guide (Release 0.3.0 STU1 Ballot)

This page is part of the International Patient Summary Implementation Guide (v0.3.0: STU 1 (FHIR R4) Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Definitions for the StructureDefinition-Composition-uv-ips Profile.

1. 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.

Control0..*
Must Supporttrue
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.

InvariantsDefined on this element
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.

Control0..1
Typeid
Must Supporttrue
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.

3. 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.

Control0..1
TypeMeta
Must Supporttrue
4. 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.

Control0..1
Typeuri
Is Modifiertrue
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.

5. Composition.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
Typecode
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).

6. Composition.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1
TypeNarrative
Must Supporttrue
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

7. 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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

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

8. Composition.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Composition.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Composition.extension:versionNumber
SliceNameversionNumber
Definition

Version specific identifier for the composition, assigned when each version is created/updated.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(versionNumber) (Extension Type: string)
Comments

While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Composition.extension:healthcareProviderParticipant
SliceNamehealthcareProviderParticipant
Definition

Extension defined to allow to capture the preferred practitioner ( with its role ) or the organization to be contacted, represented in the IPS CDA with an indirect participant in the header.

Control0..*
TypeExtension(ParticipantUvIps) (Extension Type: Reference)
11. Composition.extension:healthcareProviderParticipant.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
12. Composition.extension:healthcareProviderParticipant.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Composition.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
13. Composition.extension:healthcareProviderParticipant.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Must Supporttrue
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/uv/ips/StructureDefinition/participant-uv-ips
14. Composition.extension:healthcareProviderParticipant.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeReference
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Composition.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
15. Composition.extension:healthcareProviderParticipant.value[x]:valueReference
SliceNamevalueReference
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeReference(PractitionerRole | Organization)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
16. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
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.

17. Composition.identifier
Definition

A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Must Supporttrue
Comments

Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.

18. Composition.status
Definition

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

Control1..1
BindingThe workflow/clinical status of the composition.
The codes SHALL be taken from CompositionStatus
Typecode
Is Modifiertrue
Must Supporttrue
Requirements

Need to be able to mark interim, amended, or withdrawn compositions or documents.

Comments

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

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

19. Composition.type
Definition

Specifies that this composition refers to a Patient Summary (Loinc "60591-5")

Control1..1 This element is affected by the following invariants: ele-1
BindingType of a composition.
The codes SHOULD be taken from FHIRDocumentTypeCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Key metadata element describing the composition, used in searching/filtering.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="60591-5"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. 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.

Control0..*
BindingHigh-level kind of a clinical document at a macro level.
For example codes, see DocumentClassValueSet
TypeCodeableConcept
Requirements

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

Comments

This is a metadata field from XDS/MHD.

21. 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.

Control0..1
TypeReference(PatientUvIps)
Must Supporttrue
Requirements

Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.

Comments

For clinical documents, this is usually the patient.

22. 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.

Control0..1
Typestring
23. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Composition.subject.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
24. 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.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
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.

25. 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).

Control0..1
BindingAa resource (or, for logical models, the URI of the logical model).
The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable
Typeuri
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.

26. 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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
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).

27. Composition.subject.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
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.

28. Composition.encounter
Definition

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

Control0..1
TypeReference(Encounter)
Requirements

Provides context for the composition and supports searching.

29. Composition.encounter.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
30. Composition.encounter.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Composition.encounter.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
31. Composition.encounter.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.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
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.

32. Composition.encounter.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).

Control0..1
BindingAa resource (or, for logical models, the URI of the logical model).
The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable
Typeuri
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.

33. Composition.encounter.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
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).

34. Composition.encounter.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
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.

35. Composition.date
Definition

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

Control1..1
TypedateTime
Must Supporttrue
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.

Comments

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

36. Composition.author
Definition

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

The type of author(s) contribute to determine the "nature"of the Patient Summary: e.g. a "human-curated" IPS Vs. an "automatically generated" IPS.

Control1..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Must Supporttrue
Requirements

Identifies who is responsible for the content.

37. Composition.author.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
38. Composition.author.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Composition.author.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
39. Composition.author.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.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
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.

40. Composition.author.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).

Control0..1
BindingAa resource (or, for logical models, the URI of the logical model).
The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable
Typeuri
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.

41. Composition.author.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
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).

42. Composition.author.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
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.

43. Composition.title
Definition

Official human-readable label for the composition.

For this document should be "International Patient Summary" or any equivalent translation

Control1..1
Typestring
Must Supporttrue
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.

44. Composition.confidentiality
Definition

The code specifying the level of confidentiality of the Composition.

Control0..1
BindingCodes specifying the level of confidentiality of the composition.
The codes SHALL be taken from v3.ConfidentialityClassification (2014-03-26)
Typecode
Must Supporttrue
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.

45. Composition.attester
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. 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.

Control0..1
Typestring
47. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

48. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

49. Composition.attester.mode
Definition

The type of attestation the authenticator offers.

Control1..1
BindingThe way in which a person authenticated a composition.
The codes SHALL be taken from CompositionAttestationMode
Typecode
Must Supporttrue
Requirements

Indicates the level of authority of the attestation.

50. Composition.attester.time
Definition

When the composition was attested by the party.

Control0..1
TypedateTime
Must Supporttrue
Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

51. Composition.attester.party
Definition

Who attested the composition in the specified way.

Control0..1
TypeReference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
Must Supporttrue
Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

52. Composition.attester.party.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
53. Composition.attester.party.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Composition.attester.party.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
54. Composition.attester.party.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.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
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.

55. Composition.attester.party.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).

Control0..1
BindingAa resource (or, for logical models, the URI of the logical model).
The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable
Typeuri
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.

56. Composition.attester.party.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
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).

57. Composition.attester.party.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
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.

58. Composition.custodian
Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

Control0..1
TypeReference(Organization)
Must Supporttrue
Requirements

Identifies where to go to find the current version, where to report issues, etc.

Comments

This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.

59. Composition.custodian.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
60. Composition.custodian.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices on Composition.custodian.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
61. Composition.custodian.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.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
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.

62. Composition.custodian.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).

Control0..1
BindingAa resource (or, for logical models, the URI of the logical model).
The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable
Typeuri
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.

63. Composition.custodian.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
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).

64. Composition.custodian.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
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.

65. Composition.relatesTo
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

A document is a version specific composition.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. 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.

Control0..1
Typestring
67. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

68. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

69. Composition.relatesTo.code
Definition

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

Control1..1
BindingThe type of relationship between documents.
The codes SHALL be taken from DocumentRelationshipType
Typecode
Must Supporttrue
Comments

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

70. Composition.relatesTo.target[x]
Definition

The target composition/document of this relationship.

Control1..1
TypeChoice of: Identifier, Reference(Composition | CompositionUvIps)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
71. 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 lest 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.

Control0..*
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Composition.event. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code
72. 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.

Control0..1
Typestring
73. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

74. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

75. 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.

Control0..*
BindingThis list of codes represents the main clinical acts being documented.
For example codes, see v3 Code System ActCode
TypeCodeableConcept
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.

76. 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.

Control0..1
TypePeriod
77. 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.

Control0..*
TypeReference(Resource)
78. Composition.event:careProvisioningEvent
SliceNamecareProvisioningEvent
Definition

The provision of healthcare over a period of time this IPS is documenting.

Control0..1
TypeBackboneElement
Must Supporttrue
Requirements

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

Comments

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
79. 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.

Control0..1
Typestring
80. 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

81. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

82. 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.

Control1..*
BindingThis list of codes represents the main clinical acts being documented.
For example codes, see v3 Code System ActCode
TypeCodeableConcept
Must Supporttrue
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.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/v3-ActClass"/>
    <code value="PCPR"/>
  </coding>
</valueCodeableConcept>
83. 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.

Control0..1
TypePeriod
Must Supporttrue
84. 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.

Control0..*
TypeReference(Resource)
85. Composition.section
Definition

The root of the sections that make up the IPS composition.

Control1..*
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
SlicingThis element introduces a set of slices on Composition.section. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ code
86. 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.

Control0..1
Typestring
87. Composition.section.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

88. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

89. 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.

Control0..1
Typestring
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

90. Composition.section.code
Definition

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

Control0..1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept
Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

91. Composition.section.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

92. 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).

Control0..1
TypeReference(Resource)
Comments

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

93. 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.

Control0..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Comments

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

94. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

95. Composition.section.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

96. Composition.section.entry
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Comments

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

97. 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.

Control0..1 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

98. Composition.section.section
Definition

A nested sub-section within this section.

Control0..* This element is affected by the following invariants: cmp-1
TypeSee Composition.section
Comments

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

99. Composition.section:sectionMedications
SliceNamesectionMedications
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 all those cases however medications are documented in the Patient Summary as medication statements. 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.

Control1..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
100. 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.

Control0..1
Typestring
101. Composition.section:sectionMedications.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

102. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

103. 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.

Medication Summary

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

104. Composition.section:sectionMedications.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="10160-0"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
105. Composition.section:sectionMedications.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

106. 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).

Control0..1
TypeReference(Resource)
Comments

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

107. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

108. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

109. Composition.section:sectionMedications.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

110. 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.

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
111. Composition.section:sectionMedications.entry:medicationStatement
SliceNamemedicationStatement
Definition

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

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(MedicationStatementIPS)
Must Supporttrue
Comments

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

112. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

113. Composition.section:sectionMedications.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionMedications
Comments

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

114. Composition.section:sectionAllergies
SliceNamesectionAllergies
Definition

This section documents the relevant allergies or intolerances (conditions) 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.

Control1..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
115. 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.

Control0..1
Typestring
116. Composition.section:sectionAllergies.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

117. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

118. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

119. Composition.section:sectionAllergies.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="48765-2"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
120. Composition.section:sectionAllergies.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

121. 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).

Control0..1
TypeReference(Resource)
Comments

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

122. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

123. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

124. Composition.section:sectionAllergies.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

125. Composition.section:sectionAllergies.entry
Definition

It lists the relevant allergies or intolerances (conditions) 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 .

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
126. Composition.section:sectionAllergies.entry:allergyOrIntolerance
SliceNameallergyOrIntolerance
Definition

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

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(AllergyIntoleranceUvIps)
Must Supporttrue
Comments

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

127. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

128. Composition.section:sectionAllergies.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionAllergies
Comments

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

129. Composition.section:sectionProblems
SliceNamesectionProblems
Definition

The IPS problem section lists and describes clinical problems or conditions currently being monitored for the patient.

Control1..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
130. 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.

Control0..1
Typestring
131. Composition.section:sectionProblems.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

132. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

133. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

134. Composition.section:sectionProblems.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="11450-4"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
135. Composition.section:sectionProblems.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

136. 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).

Control0..1
TypeReference(Resource)
Comments

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

137. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

138. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

139. Composition.section:sectionProblems.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

140. 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.

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
141. Composition.section:sectionProblems.entry:problem
SliceNameproblem
Definition

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

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(ConditionUvIps)
Must Supporttrue
Comments

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

142. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

143. Composition.section:sectionProblems.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionProblems
Comments

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

144. Composition.section:sectionProceduresHx
SliceNamesectionProceduresHx
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:

  1. Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section)
  2. Therapeutic procedure: e.g. dialysis;
  3. Surgical procedure: e.g. appendectomy
Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
145. 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.

Control0..1
Typestring
146. Composition.section:sectionProceduresHx.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

147. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

148. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

149. Composition.section:sectionProceduresHx.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="47519-4"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
150. Composition.section:sectionProceduresHx.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

151. 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).

Control0..1
TypeReference(Resource)
Comments

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

152. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

153. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

154. Composition.section:sectionProceduresHx.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

155. 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:

  1. Invasive Diagnostic procedure:e.g. Cardiac catheterization; (the results of these procedure are documented in the results section)
  2. Therapeutic procedure: e.g. dialysis;
  3. 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.
Control1..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
156. Composition.section:sectionProceduresHx.entry:procedure
SliceNameprocedure
Definition

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

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(ProcedureUvIps)
Must Supporttrue
Comments

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

157. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

158. Composition.section:sectionProceduresHx.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionProceduresHx
Comments

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

159. Composition.section:sectionImmunizations
SliceNamesectionImmunizations
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 current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
160. 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.

Control0..1
Typestring
161. Composition.section:sectionImmunizations.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

162. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

163. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

164. Composition.section:sectionImmunizations.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="11369-6"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
165. Composition.section:sectionImmunizations.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

166. 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).

Control0..1
TypeReference(Resource)
Comments

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

167. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

168. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

169. Composition.section:sectionImmunizations.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

170. 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.

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
171. Composition.section:sectionImmunizations.entry:immunization
SliceNameimmunization
Definition

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

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(ImmunizationUvIps)
Must Supporttrue
Comments

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

172. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

173. Composition.section:sectionImmunizations.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionImmunizations
Comments

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

174. Composition.section:sectionMedicalDevices
SliceNamesectionMedicalDevices
Definition

The medical devices section contains narrative text and coded entries describing the patient history of medical device use.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
175. 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.

Control0..1
Typestring
176. Composition.section:sectionMedicalDevices.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

177. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

178. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

179. Composition.section:sectionMedicalDevices.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="46264-8"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
180. Composition.section:sectionMedicalDevices.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

181. 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).

Control0..1
TypeReference(Resource)
Comments

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

182. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

183. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

184. Composition.section:sectionMedicalDevices.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

185. 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.

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
186. Composition.section:sectionMedicalDevices.entry:deviceStatement
SliceNamedeviceStatement
Definition

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

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(DeviceUseStatementUvIps)
Must Supporttrue
Comments

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

187. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

188. Composition.section:sectionMedicalDevices.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionMedicalDevices
Comments

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

189. Composition.section:sectionResults
SliceNamesectionResults
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.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
190. 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.

Control0..1
Typestring
191. Composition.section:sectionResults.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

192. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

193. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

194. Composition.section:sectionResults.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="30954-2"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
195. Composition.section:sectionResults.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

196. 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).

Control0..1
TypeReference(Resource)
Comments

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

197. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

198. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

199. Composition.section:sectionResults.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

200. 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.

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
201. Composition.section:sectionResults.entry:genericResult
SliceNamegenericResult
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ObservationUvIps)
Must Supporttrue
Comments

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

202. Composition.section:sectionResults.entry:laboratoryResult
SliceNamelaboratoryResult
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ObservationLaboratoryUvIps)
Must Supporttrue
Comments

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

203. Composition.section:sectionResults.entry:pathologyResult
SliceNamepathologyResult
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ObservationPathologyUvIps)
Must Supporttrue
Comments

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

204. Composition.section:sectionResults.entry:imagingResult
SliceNameimagingResult
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ObservationImagingUvIps)
Must Supporttrue
Comments

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

205. Composition.section:sectionResults.entry:diagnosticReport
SliceNamediagnosticReport
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(DiagnosticReportUvIps)
Must Supporttrue
Comments

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

206. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

207. Composition.section:sectionResults.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionResults
Comments

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

208. Composition.section:sectionVitalSigns
SliceNamesectionVitalSigns
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

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
209. 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.

Control0..1
Typestring
210. Composition.section:sectionVitalSigns.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

211. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

212. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

213. Composition.section:sectionVitalSigns.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="8716-3"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
214. Composition.section:sectionVitalSigns.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

215. 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).

Control0..1
TypeReference(Resource)
Comments

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

216. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

217. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

218. Composition.section:sectionVitalSigns.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

219. 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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
220. Composition.section:sectionVitalSigns.entry:vitalSign
SliceNamevitalSign
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(observation-vitalsigns)
Must Supporttrue
Comments

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

221. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

222. Composition.section:sectionVitalSigns.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionVitalSigns
Comments

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

223. Composition.section:sectionPastIllnessHx
SliceNamesectionPastIllnessHx
Definition

The History of Past Illness section contains a description of the conditions the patient suffered in the past.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
224. Composition.section:sectionPastIllnessHx.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
225. Composition.section:sectionPastIllnessHx.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

226. Composition.section:sectionPastIllnessHx.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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

227. Composition.section:sectionPastIllnessHx.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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

228. Composition.section:sectionPastIllnessHx.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="11348-0"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
229. Composition.section:sectionPastIllnessHx.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

230. Composition.section:sectionPastIllnessHx.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).

Control0..1
TypeReference(Resource)
Comments

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

231. Composition.section:sectionPastIllnessHx.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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

232. Composition.section:sectionPastIllnessHx.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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

233. Composition.section:sectionPastIllnessHx.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

234. Composition.section:sectionPastIllnessHx.entry
Definition

It contains a description of the conditions the patient suffered in the past.

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
235. Composition.section:sectionPastIllnessHx.entry:pastProblem
SliceNamepastProblem
Definition

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

Control1..* This element is affected by the following invariants: cmp-2
TypeReference(ConditionUvIps)
Must Supporttrue
Comments

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

236. Composition.section:sectionPastIllnessHx.emptyReason
Definition

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

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

237. Composition.section:sectionPastIllnessHx.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionPastIllnessHx
Comments

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

238. Composition.section:sectionFunctionalStatus
SliceNamesectionFunctionalStatus
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.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
239. 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.

Control0..1
Typestring
240. Composition.section:sectionFunctionalStatus.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

241. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

242. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

243. Composition.section:sectionFunctionalStatus.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="47420-5"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
244. Composition.section:sectionFunctionalStatus.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

245. 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).

Control0..1
TypeReference(Resource)
Comments

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

246. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

247. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

248. Composition.section:sectionFunctionalStatus.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

249. 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.

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
250. Composition.section:sectionFunctionalStatus.entry:disability
SliceNamedisability
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ConditionUvIps)
Must Supporttrue
Comments

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

251. Composition.section:sectionFunctionalStatus.entry:functionalAssessment
SliceNamefunctionalAssessment
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ClinicalImpression)
Must Supporttrue
Comments

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

252. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

253. Composition.section:sectionFunctionalStatus.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionFunctionalStatus
Comments

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

254. Composition.section:sectionPlanOfCare
SliceNamesectionPlanOfCare
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.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
255. 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.

Control0..1
Typestring
256. Composition.section:sectionPlanOfCare.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

257. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

258. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

259. Composition.section:sectionPlanOfCare.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="18776-5"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
260. Composition.section:sectionPlanOfCare.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

261. 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).

Control0..1
TypeReference(Resource)
Comments

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

262. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

263. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

264. Composition.section:sectionPlanOfCare.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

265. Composition.section:sectionPlanOfCare.entry
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Comments

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

266. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

267. Composition.section:sectionPlanOfCare.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionPlanOfCare
Comments

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

268. Composition.section:sectionSocialHistory
SliceNamesectionSocialHistory
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.)

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
269. 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.

Control0..1
Typestring
270. Composition.section:sectionSocialHistory.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

271. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

272. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

273. Composition.section:sectionSocialHistory.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="29762-2"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
274. Composition.section:sectionSocialHistory.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

275. 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).

Control0..1
TypeReference(Resource)
Comments

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

276. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

277. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

278. Composition.section:sectionSocialHistory.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

279. 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.)

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
280. Composition.section:sectionSocialHistory.entry:smokingTobaccoUse
SliceNamesmokingTobaccoUse
Definition

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

Control0..1 This element is affected by the following invariants: cmp-2
TypeReference(ObservationTobaccoUseUvIps)
Must Supporttrue
Comments

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

281. Composition.section:sectionSocialHistory.entry:alcoholUse
SliceNamealcoholUse
Definition

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

Control0..1 This element is affected by the following invariants: cmp-2
TypeReference(ObservationAlcoholUseUvIps)
Must Supporttrue
Comments

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

282. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

283. Composition.section:sectionSocialHistory.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionSocialHistory
Comments

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

284. Composition.section:sectionPregnancyHx
SliceNamesectionPregnancyHx
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.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
285. 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.

Control0..1
Typestring
286. Composition.section:sectionPregnancyHx.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

287. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

288. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

289. Composition.section:sectionPregnancyHx.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="10162-6"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
290. Composition.section:sectionPregnancyHx.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

291. 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).

Control0..1
TypeReference(Resource)
Comments

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

292. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

293. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

294. Composition.section:sectionPregnancyHx.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

295. 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.

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
296. Composition.section:sectionPregnancyHx.entry:pregnancyStatus
SliceNamepregnancyStatus
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ObservationPregnancyStatusUvIps)
Must Supporttrue
Comments

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

297. Composition.section:sectionPregnancyHx.entry:pregnancyOutcomeSummary
SliceNamepregnancyOutcomeSummary
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(ObservationPregnancyOutcomeUvIps)
Must Supporttrue
Comments

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

298. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

299. Composition.section:sectionPregnancyHx.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionPregnancyHx
Comments

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

300. Composition.section:sectionAdvanceDirectives
SliceNamesectionAdvanceDirectives
Definition

The advance directives section contains a narrative description of patient's advance directive.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
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()))
301. 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.

Control0..1
Typestring
302. Composition.section:sectionAdvanceDirectives.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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

303. 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).

Control0..*
TypeExtension
Is Modifiertrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

304. 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.

Control1..1
Typestring
Must Supporttrue
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader, label, caption
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.

305. Composition.section:sectionAdvanceDirectives.code
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1 This element is affected by the following invariants: ele-1
BindingClassification of a section of a composition/document.
For example codes, see DocumentSectionCodes
TypeCodeableConcept(CodeableConceptIPS)
Must Supporttrue
Requirements

Provides computable standardized labels to topics within the document.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://loinc.org"/>
    <code value="42348-3"/>
  </coding>
</valueCodeableConcept>
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
306. Composition.section:sectionAdvanceDirectives.author
Definition

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

Control0..*
TypeReference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
Requirements

Identifies who is responsible for the content.

307. 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).

Control0..1
TypeReference(Resource)
Comments

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

308. 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.

Control1..1 This element is affected by the following invariants: cmp-1
TypeNarrative
Must Supporttrue
Comments

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

309. 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.

Control0..1
BindingThe processing mode that applies to this section.
The codes SHALL be taken from ListMode
Typecode
Requirements

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

Comments

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

310. Composition.section:sectionAdvanceDirectives.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Control0..1
BindingWhat order applies to the items in the entry.
The codes SHOULD be taken from ListOrderCodes
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

311. Composition.section:sectionAdvanceDirectives.entry
Definition

Contains a narrative description or a Consent entry with information about the patient's advance directive.

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Resource)
Must Supporttrue
Comments

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

SlicingThis element introduces a set of slices on Composition.section.entry. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • profile @ resolve()
312. Composition.section:sectionAdvanceDirectives.entry:advanceDirectivesConsent
SliceNameadvanceDirectivesConsent
Definition

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

Control0..* This element is affected by the following invariants: cmp-2
TypeReference(Consent)
Must Supporttrue
Comments

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

313. 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.

Control0..0 This element is affected by the following invariants: cmp-2
BindingIf a section is empty, why it is empty.
The codes SHOULD be taken from ListEmptyReasons
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

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

314. Composition.section:sectionAdvanceDirectives.section
Definition

A nested sub-section within this section.

Control0..0 This element is affected by the following invariants: cmp-1
TypeSee Composition.section:sectionAdvanceDirectives
Comments

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