Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0 - trial-use International flag

Electronic Medicinal Product Information (ePI) FHIR Implementation Guide, published by HL7 International - Biomedical Research & Regulation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/emedicinal-product-info/ and changes regularly. See the Directory of published versions

Resource Profile: CompositionUvEpi - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the Composition-uv-epi resource profile.

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

0. Composition
2. Composition.language
ShortThe language of the ePI's narrative text
Control1..?
4. Composition.identifier
Definition

Unlike the Bundle identifier which persists, the Composition identifier does not persist across versions. Each new version of the Composition receives a new identifier.

ShortUnique identifier only for this version of the Composition
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
6. Composition.identifier.system
Control1..?
8. Composition.identifier.value
Control1..?
10. Composition.version
ShortAn explicitly assigned identifer of a variation of the content in the ePI
NoteThis is a business version Id, not a resource version Id (see discussion)
12. Composition.status
Shortpreliminary|final|amended|entered-in-error|deprecated
14. Composition.type
Definition

Specifies the type of ePI template. For example, Package Insert, Patient Information, Summary of Product Characteristics, Human Prescription, Drug Label.

ShortType of ePI document template
16. Composition.category
ShortCategorization of ePI
18. Composition.subject
ShortThe authorized medicinal product(s) that this ePI's composition is about
TypeReference(MedicinalProductDefinition (ePI))
20. Composition.date
ShortDate of last revision for this version of the authorized ePI.
22. Composition.author
Definition

Link to the Organization resource that describes the organization responsible for the ePI (For example, Markting Authorization Holder).

ShortThe Organization responsible for the ePI
TypeReference(Organization (ePI))
24. Composition.title
Definition

A brief summary name describing the ePI. The title should include: Proprietary Name(s) (Non-proprietary Name(s)) Dose Form, Route of Administration.

ShortTitle of the ePI Document
26. Composition.relatesTo
Definition

A crossreference from this ePI's composition to another related Composition or ePI document.

ShortCross-reference to anotherother ePI compositions or ePI document()s)
28. Composition.section
Definition

This is the root or level 1 section heading in the ePI. All other section headings are sub-sections, or children, of this section heading

ShortLevel 1 section heading for the whole ePI
Control1..?
30. Composition.section.title
Definition

This section heading is the counterpart to the coded section heading from the health authority's ePI template. For example, the health authority ePI template may have '1. What X is and what it is used for' as the coded section heading. The market authorization holder modifies this such that 'X' is replaced with the brand name of the drug.

ShortSection heading defined by the market authorization holder
32. Composition.section.code
ShortSection heading defined by the health authority. Cannot be changed by the market authorization holder
BindingFor example codes, see Section Codes
(example to http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/sectionCode)
34. Composition.section.text
ShortNarrative text for this section (e.g., paragraphs, bulleted lists, tables).
36. Composition.section.emptyReason
ShortReason the section is empty.
38. Composition.section.section
Definition

Nested Sections sub-section headings for level 2, 3, 4 or 5.

ShortNested sub-section headings for level 2, 3, 4 or 5.
TypeBackboneElement
40. Composition.section.section.title
ShortSection heading defined by the market authorization holder
42. Composition.section.section.code
ShortCoded section heading defined by the health authority.
BindingFor example codes, see Section Codes
(example to http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/sectionCode)
44. Composition.section.section.text
ShortNarrative text for this section.
46. Composition.section.section.emptyReason
ShortReason the section is empty.

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

0. Composition
Definition

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

ShortA set of resources composed into a single coherent clinical statement with clinical attestation
Comments

While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.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.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Composition.language
Definition

The base language in which the resource is written.

ShortThe language of the ePI's narrative textLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control10..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Composition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

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

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
8. 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 managable, 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).

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
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
Invariantsele-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.identifier
Definition

Unlike the Bundle identifier which persists, the Composition identifier does not persist across versions. Each new version of the Composition receives a new identifier.


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

ShortUnique identifier only for this version of the CompositionVersion-independent identifier for the Composition
Comments

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Composition.identifier.use
Definition

The purpose of this identifier.

Shortusual | official | temp | secondary | old (If known)
Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control0..1
BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
(required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Composition.identifier.system
Definition

Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

ShortThe namespace for the identifier value
Comments

Identifier.system is always case sensitive.

Control10..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Composition.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

ShortThe value that is unique
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control10..1
This element is affected by the following invariants: ident-1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Example<br/><b>General</b>:123456
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Composition.version
Definition

An explicitly assigned identifer of a variation of the content in the Composition.

ShortAn explicitly assigned identifer of a variation of the content in the ePIAn explicitly assigned identifer of a variation of the content in the Composition
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.

NoteThis is a business version Id, not a resource version Id (see discussion)
Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Composition.status
Definition

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

Shortpreliminary|final|amended|entered-in-error|deprecatedregistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
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.

Control1..1
BindingThe codes SHALL be taken from CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0
(required to http://hl7.org/fhir/ValueSet/composition-status|5.0.0)

The workflow/clinical status of the composition.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Composition.type
Definition

Specifies the type of ePI template. For example, Package Insert, Patient Information, Summary of Product Characteristics, Human Prescription, Drug Label.


Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

ShortType of ePI document templateKind of composition (LOINC if possible)
Comments

For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.

Control1..1
BindingThe codes SHOULD be taken from FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes
(preferred to http://hl7.org/fhir/ValueSet/doc-typecodes)

Type of a composition.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. 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.

ShortCategorization of ePICategorization of Composition
Control0..*
BindingFor example codes, see ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-category
(example to http://hl7.org/fhir/ValueSet/referenced-item-category)

High-level kind of a clinical document at a macro level.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Composition.subject
Definition

Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

ShortThe authorized medicinal product(s) that this ePI's composition is aboutWho and/or what the composition is about
Comments

For clinical documents, this is usually the patient.

Control0..*
TypeReference(MedicinalProductDefinition (ePI), Resource)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Composition.date
Definition

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

ShortDate of last revision for this version of the authorized ePI.Composition editing time
Comments

The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.

Control1..1
TypedateTime
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring this version of the Composition. When packaged in a document, Bundle.timestamp is the date of packaging.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Composition.author
Definition

Link to the Organization resource that describes the organization responsible for the ePI (For example, Markting Authorization Holder).


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

ShortThe Organization responsible for the ePIWho and/or what authored the composition
Control1..*
TypeReference(Organization (ePI), Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
Is Modifierfalse
Must Supportfalse
Summarytrue
Requirements

Identifies who is responsible for the content.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Composition.title
Definition

A brief summary name describing the ePI. The title should include: Proprietary Name(s) (Non-proprietary Name(s)) Dose Form, Route of Administration.


Official human-readable label for the composition.

ShortTitle of the ePI DocumentHuman Readable name/title
Comments

For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.

Control1..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Composition.relatesTo
Definition

A crossreference from this ePI's composition to another related Composition or ePI document.


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

ShortCross-reference to anotherother ePI compositions or ePI document()s)Relationships to other compositions/documents
Comments

To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.
When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

"relatesTo": [{
  "type": "replaces",
  "resourceReference": {
    "identifier": { 
      "system": "...", 
      "value": "..."
    }
  } 
}]
Control0..*
TypeRelatedArtifact
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Composition.section
Definition

This is the root or level 1 section heading in the ePI. All other section headings are sub-sections, or children, of this section heading


The root of the sections that make up the composition.

ShortLevel 1 section heading for the whole ePIComposition is broken into sections
Control10..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantscmp-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()))
38. 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 managable, 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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
Invariantsele-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())
40. Composition.section.title
Definition

This section heading is the counterpart to the coded section heading from the health authority's ePI template. For example, the health authority ePI template may have '1. What X is and what it is used for' as the coded section heading. The market authorization holder modifies this such that 'X' is replaced with the brand name of the drug.


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.

ShortSection heading defined by the market authorization holderLabel for section (e.g. for ToC)
Comments

The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Composition.section.code
Definition

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

ShortSection heading defined by the health authority. Cannot be changed by the market authorization holderClassification of section (recommended)
Comments

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

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

Control0..1
BindingFor example codes, see Section Codeshttp://hl7.org/fhir/ValueSet/doc-section-codes
(example to http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/sectionCode)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. 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.

ShortNarrative text for this section (e.g., paragraphs, bulleted lists, tables).Text summary of the section, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: cmp-1
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Composition.section.entry
Definition

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

ShortA reference to data that supports this section
Comments

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

Control0..*
This element is affected by the following invariants: cmp-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. 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.

ShortReason the section is empty.Why the section is empty
Comments

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

Control0..1
This element is affected by the following invariants: cmp-2
BindingThe codes SHOULD be taken from ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Composition.section.section
Definition

Nested Sections sub-section headings for level 2, 3, 4 or 5.


A nested sub-section within this section.

ShortNested sub-section headings for level 2, 3, 4 or 5.Nested Section
Comments

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

Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Composition.section.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 managable, 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).

ShortExtensions that cannot be ignored even if unrecognized
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
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
Invariantsele-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())
54. Composition.section.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.

ShortSection heading defined by the market authorization holderLabel for section (e.g. for ToC)
Comments

The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.

Control0..1
Typestring
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
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
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Composition.section.section.code
Definition

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

ShortCoded section heading defined by the health authority.Classification of section (recommended)
Comments

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

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

Control0..1
BindingFor example codes, see Section Codeshttp://hl7.org/fhir/ValueSet/doc-section-codes
(example to http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/sectionCode)
TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

Provides computable standardized labels to topics within the document.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Composition.section.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.

ShortNarrative text for this section.Text summary of the section, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: cmp-1
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Composition.section.section.entry
Definition

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

ShortA reference to data that supports this section
Comments

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

Control0..*
This element is affected by the following invariants: cmp-1, cmp-2
TypeReference(Resource)
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Composition.section.section.emptyReason
Definition

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

ShortReason the section is empty.Why the section is empty
Comments

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

Control0..1
This element is affected by the following invariants: cmp-2
BindingThe codes SHOULD be taken from ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason
(preferred to http://hl7.org/fhir/ValueSet/list-empty-reason)

If a section is empty, why it is empty.

TypeCodeableConcept
Is Modifierfalse
Must Supportfalse
Summaryfalse
Requirements

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

0. Composition
Definition

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

ShortA set of resources composed into a single coherent clinical statement with clinical attestation
Comments

While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. Composition.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Composition.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Composition.language
Definition

The base language in which the resource is written.

ShortThe language of the ePI's narrative text
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).

Control1..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. 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.

ShortText summary of the resource, for human interpretation
Comments

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

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Composition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

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

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. Composition.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.

ShortAdditional content defined by implementations
Comments

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
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 managable, 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).

ShortExtensions that cannot be ignored
Comments

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

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
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
Invariantsele-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())
18. Composition.url
Definition

An absolute URI that is used to identify this Composition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this Composition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Composition is stored on different servers.

ShortCanonical identifier for this Composition, represented as a URI (globally unique)
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Requirements

Allows the Composition to be referenced by a single globally unique identifier.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Composition.identifier
Definition

Unlike the Bundle identifier which persists, the Composition identifier does not persist across versions. Each new version of the Composition receives a new identifier.

ShortUnique identifier only for this version of the Composition
Comments

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Composition.identifier.id
Definition

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

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
24. Composition.identifier.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 managable, 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.

ShortAdditional content defined by implementations
Comments

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

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Composition.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 26. Composition.identifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUse
    (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Composition.identifier.type
    Definition

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortDescription of identifier
    Comments

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Composition.identifier.system
    Definition

    Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control1..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Composition.identifier.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control1..1
    This element is affected by the following invariants: ident-1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Example<br/><b>General</b>:123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Composition.identifier.period
    Definition

    Time period during which identifier is/was valid for use.

    ShortTime period when id is/was valid for use
    Control0..1
    TypePeriod
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Composition.identifier.assigner
    Definition

    Organization that issued/manages the identifier.

    ShortOrganization that issued id (may be just text)
    Comments

    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

    Control0..1
    TypeReference(Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Composition.version
    Definition

    An explicitly assigned identifer of a variation of the content in the Composition.

    ShortAn explicitly assigned identifer of a variation of the content in the ePI
    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.

    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Composition.status
    Definition

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

    Shortpreliminary|final|amended|entered-in-error|deprecated
    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.

    Control1..1
    BindingThe codes SHALL be taken from CompositionStatus
    (required to http://hl7.org/fhir/ValueSet/composition-status|5.0.0)

    The workflow/clinical status of the composition.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Composition.type
    Definition

    Specifies the type of ePI template. For example, Package Insert, Patient Information, Summary of Product Characteristics, Human Prescription, Drug Label.

    ShortType of ePI document template
    Comments

    For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.

    Control1..1
    BindingThe codes SHOULD be taken from FHIRDocumentTypeCodes
    (preferred to http://hl7.org/fhir/ValueSet/doc-typecodes)

    Type of a composition.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. 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.

    ShortCategorization of ePI
    Control0..*
    BindingFor example codes, see ReferencedItemCategoryValueSet
    (example to http://hl7.org/fhir/ValueSet/referenced-item-category)

    High-level kind of a clinical document at a macro level.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Composition.subject
    Definition

    Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

    ShortThe authorized medicinal product(s) that this ePI's composition is about
    Comments

    For clinical documents, this is usually the patient.

    Control0..*
    TypeReference(MedicinalProductDefinition (ePI))
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. Composition.encounter
    Definition

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

    ShortContext of the Composition
    Control0..1
    TypeReference(Encounter)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Provides context for the composition and supports searching.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. Composition.date
    Definition

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

    ShortDate of last revision for this version of the authorized ePI.
    Comments

    The Last Modified Date on the composition may be after the date of the document was attested without being changed. This means that the date on an amended document is the date of the amendment, not the date of original authorship.

    Control1..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

    dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring this version of the Composition. When packaged in a document, Bundle.timestamp is the date of packaging.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. Composition.useContext
    Definition

    The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate Composition instances.

    ShortThe context that the content is intended to support
    Comments

    When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

    Control0..*
    TypeUsageContext
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Assist in searching for appropriate content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. Composition.author
    Definition

    Link to the Organization resource that describes the organization responsible for the ePI (For example, Markting Authorization Holder).

    ShortThe Organization responsible for the ePI
    Control1..*
    TypeReference(Organization (ePI))
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

    Identifies who is responsible for the content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. Composition.name
    Definition

    A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation.

    ShortName for this Composition (computer friendly)
    Comments

    The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

    Support human navigation and code generation.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. Composition.title
    Definition

    A brief summary name describing the ePI. The title should include: Proprietary Name(s) (Non-proprietary Name(s)) Dose Form, Route of Administration.

    ShortTitle of the ePI Document
    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.

    Control1..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. Composition.note
    Definition

    For any additional notes.

    ShortFor any additional notes
    Comments

    A comment, general note or annotation not coded elsewhere.

    Control0..*
    TypeAnnotation
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. Composition.attester
    Definition

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

    ShortAttests to accuracy of composition
    Comments

    Only list each attester once.

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

    Identifies responsibility for the accuracy of the composition content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. 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.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    66. 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 managable, 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.

    ShortAdditional content defined by implementations
    Comments

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

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    68. 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 managable, 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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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
    Invariantsele-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())
    70. Composition.attester.mode
    Definition

    The type of attestation the authenticator offers.

    Shortpersonal | professional | legal | official
    Control1..1
    BindingThe codes SHOULD be taken from CompositionAttestationMode
    (preferred to http://hl7.org/fhir/ValueSet/composition-attestation-mode)

    The way in which a person authenticated a composition.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

    Indicates the level of authority of the attestation.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    72. Composition.attester.time
    Definition

    When the composition was attested by the party.

    ShortWhen the composition was attested
    Control0..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    74. Composition.attester.party
    Definition

    Who attested the composition in the specified way.

    ShortWho attested the composition
    Control0..1
    TypeReference(Patient, RelatedPerson, Practitioner, PractitionerRole, Organization)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    76. Composition.custodian
    Definition

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

    ShortOrganization which maintains the composition
    Comments

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

    Control0..1
    TypeReference(Organization)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    78. Composition.relatesTo
    Definition

    A crossreference from this ePI's composition to another related Composition or ePI document.

    ShortCross-reference to anotherother ePI compositions or ePI document()s)
    Comments

    To reference (using relatesTo) a Bundle of type "document" or another Composition where you only have the identifier, use a resourceReference with an identifier.
    When a Composition is an alternate representation of another type of document e.g. CDA, the other document could be referenced in a DocumentReference resource.
    Here is an example of using relatesTo to reference another Bundle of type "document" or Composition where you only have the identifier:

    "relatesTo": [{
      "type": "replaces",
      "resourceReference": {
        "identifier": { 
          "system": "...", 
          "value": "..."
        }
      } 
    }]
    
    Control0..*
    TypeRelatedArtifact
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    80. Composition.event
    Definition

    The clinical service, such as a colonoscopy or an appendectomy, being documented.

    ShortThe clinical service(s) being documented
    Comments

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

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    82. 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.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    84. 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 managable, 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.

    ShortAdditional content defined by implementations
    Comments

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

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    86. 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 managable, 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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    88. Composition.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.

    ShortThe period covered by the documentation
    Control0..1
    TypePeriod
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    90. Composition.event.detail
    Definition

    Represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which case the procedure being documented is necessarily a "History and Physical" act. The events may be included as a code or as a reference to an other resource.

    ShortThe event(s) being documented, as code(s), reference(s), or both
    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 events 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.

    Control0..*
    BindingFor example codes, see v3 Code System ActCode
    (example to http://terminology.hl7.org/ValueSet/v3-ActCode)

    This list of codes represents the main clinical acts being documented.

    TypeCodeableReference(Resource)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    92. Composition.section
    Definition

    This is the root or level 1 section heading in the ePI. All other section headings are sub-sections, or children, of this section heading

    ShortLevel 1 section heading for the whole ePI
    Control1..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantscmp-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()))
    94. 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.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    96. 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 managable, 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.

    ShortAdditional content defined by implementations
    Comments

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

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    98. 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 managable, 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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    100. Composition.section.title
    Definition

    This section heading is the counterpart to the coded section heading from the health authority's ePI template. For example, the health authority ePI template may have '1. What X is and what it is used for' as the coded section heading. The market authorization holder modifies this such that 'X' is replaced with the brand name of the drug.

    ShortSection heading defined by the market authorization holder
    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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    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
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    102. Composition.section.code
    Definition

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

    ShortSection heading defined by the health authority. Cannot be changed by the market authorization holder
    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.

    Control0..1
    BindingFor example codes, see Section Codes
    (example to http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/sectionCode)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

    Provides computable standardized labels to topics within the document.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    104. Composition.section.author
    Definition

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

    ShortWho and/or what authored the section
    Control0..*
    TypeReference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

    Identifies who is responsible for the content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    106. 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).

    ShortWho/what the section is about, when it is not about the subject of composition
    Comments

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

    Control0..1
    TypeReference(Resource)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    108. 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.

    ShortNarrative text for this section (e.g., paragraphs, bulleted lists, tables).
    Comments

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

    Control0..1
    This element is affected by the following invariants: cmp-1
    TypeNarrative
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    110. Composition.section.orderedBy
    Definition

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

    ShortOrder of section entries
    Comments

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

    Control0..1
    BindingThe codes SHOULD be taken from ListOrderCodes
    (preferred to http://hl7.org/fhir/ValueSet/list-order)

    What order applies to the items in the entry.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    112. Composition.section.entry
    Definition

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

    ShortA reference to data that supports this section
    Comments

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

    Control0..*
    This element is affected by the following invariants: cmp-1, cmp-2
    TypeReference(Resource)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    114. 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.

    ShortReason the section is empty.
    Comments

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

    Control0..1
    This element is affected by the following invariants: cmp-2
    BindingThe codes SHOULD be taken from ListEmptyReasons
    (preferred to http://hl7.org/fhir/ValueSet/list-empty-reason)

    If a section is empty, why it is empty.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    116. Composition.section.section
    Definition

    Nested Sections sub-section headings for level 2, 3, 4 or 5.

    ShortNested sub-section headings for level 2, 3, 4 or 5.
    Comments

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

    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    118. Composition.section.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.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    120. Composition.section.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 managable, 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.

    ShortAdditional content defined by implementations
    Comments

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

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    122. Composition.section.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 managable, 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).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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
    Invariantsele-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())
    124. Composition.section.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.

    ShortSection heading defined by the market authorization holder
    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.

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summaryfalse
    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
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    126. Composition.section.section.code
    Definition

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

    ShortCoded section heading defined by the health authority.
    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.

    Control0..1
    BindingFor example codes, see Section Codes
    (example to http://hl7.org/fhir/uv/emedicinal-product-info/ValueSet/sectionCode)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

    Provides computable standardized labels to topics within the document.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    128. Composition.section.section.author
    Definition

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

    ShortWho and/or what authored the section
    Control0..*
    TypeReference(Practitioner, PractitionerRole, Device, Patient, RelatedPerson, Organization)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

    Identifies who is responsible for the content.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    130. Composition.section.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).

    ShortWho/what the section is about, when it is not about the subject of composition
    Comments

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

    Control0..1
    TypeReference(Resource)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    132. Composition.section.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.

    ShortNarrative text for this section.
    Comments

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

    Control0..1
    This element is affected by the following invariants: cmp-1
    TypeNarrative
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    134. Composition.section.section.orderedBy
    Definition

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

    ShortOrder of section entries
    Comments

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

    Control0..1
    BindingThe codes SHOULD be taken from ListOrderCodes
    (preferred to http://hl7.org/fhir/ValueSet/list-order)

    What order applies to the items in the entry.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    136. Composition.section.section.entry
    Definition

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

    ShortA reference to data that supports this section
    Comments

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

    Control0..*
    This element is affected by the following invariants: cmp-1, cmp-2
    TypeReference(Resource)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    138. Composition.section.section.emptyReason
    Definition

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

    ShortReason the section is empty.
    Comments

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

    Control0..1
    This element is affected by the following invariants: cmp-2
    BindingThe codes SHOULD be taken from ListEmptyReasons
    (preferred to http://hl7.org/fhir/ValueSet/list-empty-reason)

    If a section is empty, why it is empty.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    140. Composition.section.section.section
    Definition

    A nested sub-section within this section.

    ShortNested Section
    Comments

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

    Control0..*
    TypeSeettp://hl7.org/fhir/StructureDefinition/Composition#Composition.section
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))