Ontario Health
Ontario Clinical Report Exchange Implementation Guide v1.0.0 - Trial Use
fhir-logo
  • Index
  • Home
    • Home
    • Introduction
    • Relationship to Other Specifications
    • Scope
    • Glossary
  • Business Context
    • Business Context
    • Business Model
    • Business Data
    • Use Cases
    • Business Rules
  • Technical Context
    • Technical Context
    • Implementer Responsibility
    • Conformance Rules
    • Connectivity Summary
  • FHIR Artifacts
    • FHIR Artifacts
    • Interactions
    • Profiles
    • Extensions
    • Terminology
    • System URIs
    • Examples
    • Capability Statement
    • Response Handling
    • Downloads
  • Change Log
    • Change Log
    • Known Issues & Future Developments
    • Revision History
    1. Index
    2. FHIR Artifacts
    3. Profiles
    4. Experimental Profile: DischargeSummary

For a full list of available versions, see the Directory of published versions

4.2.27. Experimental Profile: DischargeSummary

Simplifier project page: Experimental OCRE Discharge Summary

Derived from: Experimental OCRE Document Header Profile

Canonical_Url Profile_Status Profile_Version FHIR_Version

4.2.27.1. Usage

The DischargeSummary profile is a Composition resource that represents a structured discharge summary clinical document with detailed sections in addition to the metadata about the document and references to a patient, encounter, practitioners, etc.

4.2.27.2. Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

DischargeSummaryOCRE (Composition)CDocumentHeaderOCRE
There are no (further) constraints on this element
Element id
Composition
Short description

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

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

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.

Data type

DocumentHeaderOCRE

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
  • cda: ClinicalDocument
  • fhirdocumentreference: when described by DocumentReference
idΣ0..1id
There are no (further) constraints on this element
Element id
Composition.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
metaΣ0..1Meta
There are no (further) constraints on this element
Element id
Composition.meta
Short description

Metadata about the resource

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
Composition.implicitRules
Short description

A set of rules under which this content was created

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.

Comments

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

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
languageS1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
MaxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
text0..1Narrative
There are no (further) constraints on this element
Element id
Composition.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
Composition.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
versionNumberC0..1Extension(string)
There are no (further) constraints on this element
Element id
Composition.extension:versionNumber
Short description

Version-specific identifier for composition

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension(string)

Extension URL

CDVersionNumber

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
identifierS Σ1..1Identifier
There are no (further) constraints on this element
Element id
Composition.identifier
Short description

identifier

Definition

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

Comments

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

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: Document.id / Document.setId
  • cda: .setId
  • fhirdocumentreference: DocumentReference.masterIdentifier
statusΣ ?!1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.status
Short description

preliminary | final | amended | entered-in-error

Definition

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

Requirements

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

Comments

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

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

Data type

code

Binding

The workflow/clinical status of the composition.

CompositionStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
  • cda: n/a
  • fhirdocumentreference: DocumentReference.status
typeS Σ1..1CodeableConceptBindingElement id
Composition.type
Short description

Discharge Summary

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

Type of a composition.

DischargeSummaryDocumentTypeCode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.code
  • w5: FiveWs.class
  • rim: ./code
  • cda: .code
  • fhirdocumentreference: DocumentReference.type
categoryΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
Composition.category
Short description

Categorization of Composition

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.

Requirements

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

Comments

This is a metadata field from XDS/MHD.

Data type

CodeableConcept

Binding

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

DocumentClassValueSet (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.subject
  • w5: FiveWs.class
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • cda: n/a
  • fhirdocumentreference: DocumenttReference.category
subjectS Σ C0..1Reference(Group | PatientEHR)
There are no (further) constraints on this element
Element id
Composition.subject
Short description

Who and/or what the composition is about

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

Requirements

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

Comments

For clinical documents, this is usually the patient.

Data type

Reference(Group | PatientEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • cda: .recordTarget
  • fhirdocumentreference: DocumentReference.subject
  • w5: FiveWs.subject
encounterS Σ C0..1Reference(EncounterEHR)
There are no (further) constraints on this element
Element id
Composition.encounter
Short description

Context of the Composition

Definition

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

Requirements

Provides context for the composition and supports searching.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(EncounterEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.context
  • w5: FiveWs.context
  • rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
  • cda: .componentOf.encompassingEncounter
  • fhirdocumentreference: DocumentReference.context.encounter
dateS Σ1..1dateTime
There are no (further) constraints on this element
Element id
Composition.date
Short description

date

Definition

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

Requirements

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

Comments

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.occurrence[x]
  • w5: FiveWs.done[x]
  • rim: .effectiveTime[type="TS"]
  • cda: .effectiveTime
  • fhirdocumentreference: DocumentReference.content.attachment.date, DocumentReference.created
authorS Σ C1..*Reference(Device | RelatedPerson | PatientEHR | PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.author
Short description

Who and/or what authored the composition

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | RelatedPerson | PatientEHR | PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
  • fhirdocumentreference: DocumentReference.agent
titleS Σ1..1string
There are no (further) constraints on this element
Element id
Composition.title
Short description

Document Title

Definition

Official human-readable label for the composition.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
  • fhirdocumentreference: DocumentReference.description, DocumentReference.content.attachment.title
confidentialityΣ0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.confidentiality
Short description

Use the confidentiality codes in Meta.security

Definition

Use the confidentiality codes in Meta.security (https://hl7.org/fhir/security-labels.html)

Comments

The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

Data type

code

Binding

Codes specifying the level of confidentiality of the composition.

v3.ConfidentialityClassification (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .confidentialityCode
  • cda: .confidentialityCode
  • fhirdocumentreference: DocumentReference.securityLabel
attester0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester
Short description

Attests to accuracy of composition

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Slicing

Unordered, Open, by mode(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
(All Slices)
The requirements in this element apply to all slices

id0..1string
There are no (further) constraints on this element
Element id
Composition.attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
mode1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.attester.mode
Short description

personal | professional | legal | official

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyC0..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.attester.party
Short description

Who attested the composition

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
legal_attesterS0..1BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester
Short description

attester

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
legal
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
professional_attesterS0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester
Short description

attester

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
professional
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
personal_attesterS0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester
Short description

attester

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
personal
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(RelatedPerson | PractitionerEHR)
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(RelatedPerson | PractitionerEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
custodianS Σ C1..1Reference(OrganizationEHR)
There are no (further) constraints on this element
Element id
Composition.custodian
Short description

Organization which maintains the composition

Definition

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

Requirements

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

Comments

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

Data type

Reference(OrganizationEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
  • cda: .custodian.assignedCustodian
  • fhirdocumentreference: DocumentReference.custodian
relatesTo0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.relatesTo
Short description

Relationships to other compositions/documents

Definition

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

Comments

A document is a version specific composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship
  • cda: .relatedDocument
  • fhirdocumentreference: DocumentReference.relatesTo
id0..1string
There are no (further) constraints on this element
Element id
Composition.relatesTo.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.relatesTo.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.relatesTo.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
code1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.relatesTo.code
Short description

replaces | transforms | signs | appends

Definition

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

Comments

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

Data type

code

Binding

The type of relationship between documents.

DocumentRelationshipType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship.typeCode
  • cda: .relatedDocument.typeCode
  • fhirdocumentreference: DocumentReference.relatesTo.code
target[x]1..1
There are no (further) constraints on this element
Element id
Composition.relatesTo.target[x]
Short description

Target of the relationship

Definition

The target composition/document of this relationship.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .target[classCode="DOC", moodCode="EVN"].id
  • cda: .relatedDocument.id
  • fhirdocumentreference: DocumentReference.relatesTo.target
targetIdentifierIdentifier
There are no (further) constraints on this element
Data type

Identifier

targetReferenceReference(Composition)
There are no (further) constraints on this element
Data type

Reference(Composition)

eventΣ0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.event
Short description

The clinical service(s) being documented

Definition

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

Requirements

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

Comments

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
  • cda: .documentationOf.serviceEvent
  • fhirdocumentreference: DocumentReference.event
id0..1string
There are no (further) constraints on this element
Element id
Composition.event.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.event.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.event.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
codeΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
Composition.event.code
Short description

Code(s) that apply to the event being documented

Definition

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

Comments

An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.

Data type

CodeableConcept

Binding

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

ActCode (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .code
  • cda: .code
  • fhirdocumentreference: DocumentReference.event.code
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
Composition.event.period
Short description

The period covered by the documentation

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.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • rim: .effectiveTime
  • cda: .effectiveTime
  • fhirdocumentreference: DocumentReference.event.period
detailΣ C0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.event.detail
Short description

The event(s) being documented

Definition

The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode="SUBJ"].target
  • cda: n/a
sectionC3..*BackboneElementElement id
Composition.section
Short description

Composition is broken into sections

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Slicing

Unordered, Open, by code(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
(All Slices)
The requirements in this element apply to all slices

id0..1string
There are no (further) constraints on this element
Element id
Composition.section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
title0..1string
There are no (further) constraints on this element
Element id
Composition.section.title
Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
code0..1CodeableConcept
There are no (further) constraints on this element
Element id
Composition.section.code
Short description

Classification of section (recommended)

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textC0..1Narrative
There are no (further) constraints on this element
Element id
Composition.section.text
Short description

Text summary of the section, for human interpretation

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
allergies_and_intolerances_sectionS C1..1BackboneElementElement id
Composition.section:allergies_and_intolerances_section
Short description

Allergies and Intolerances Section

Definition

The root of the sections that make up the composition.

Comments

Allergies and Intolerances Section

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:allergies_and_intolerances_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:allergies_and_intolerances_section.code
Short description

Allergies and adverse reactions

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48765-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:allergies_and_intolerances_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:allergies_and_intolerances_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
allergy_entryS C0..*Reference(AllergyIntoleranceEHR)Element id
Composition.section:allergies_and_intolerances_section.entry:allergy_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(AllergyIntoleranceEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_course_sectionS C1..1BackboneElementElement id
Composition.section:hospital_course_section
Short description

Hospital Course Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_course_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_course_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8648-8"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_course_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
discharge_diagnosis_sectionS C1..1BackboneElementElement id
Composition.section:discharge_diagnosis_section
Short description

Discharge Diagnosis Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:discharge_diagnosis_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:discharge_diagnosis_section.code
Short description

Hospital discharge diagnosis

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11535-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:discharge_diagnosis_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:discharge_diagnosis_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
discharge_diagnosis_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:discharge_diagnosis_section.entry:discharge_diagnosis_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
plan_of_treatment_sectionS C0..1BackboneElementElement id
Composition.section:plan_of_treatment_section
Short description

Plan of Treatment Section

Definition

The root of the sections that make up the composition.

Comments

Plan of Treatment Section

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:plan_of_treatment_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:plan_of_treatment_section.code
Short description

Plan of treatment

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18776-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:plan_of_treatment_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:plan_of_treatment_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
sliceEntryC0..*Reference(Appointment | Communication | CommunicationRequest | DeviceRequest | Goal | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | EncounterEHR | ServiceRequestEHR)Element id
Composition.section:plan_of_treatment_section.entry:sliceEntry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

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

Comments

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

Data type

Reference(Appointment | Communication | CommunicationRequest | DeviceRequest | Goal | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | EncounterEHR | ServiceRequestEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
discharge_medications_sectionS C0..1BackboneElementElement id
Composition.section:discharge_medications_section
Short description

Discharge Medications Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:discharge_medications_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:discharge_medications_section.code
Short description

Hospital discharge medications

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10183-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:discharge_medications_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:discharge_medications_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
discharge_medications_entryS C0..*Reference(Medication | MedicationRequest | MedicationStatement)Element id
Composition.section:discharge_medications_section.entry:discharge_medications_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Medication | MedicationRequest | MedicationStatement)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
admission_diagnosis_sectionS C0..1BackboneElementElement id
Composition.section:admission_diagnosis_section
Short description

Admission Diagnosis Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:admission_diagnosis_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:admission_diagnosis_section.code
Short description

Hospital admission diagnosis

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46241-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:admission_diagnosis_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:admission_diagnosis_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
admission_diagnosis_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:admission_diagnosis_section.entry:admission_diagnosis_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
admission_medications_sectionS C0..1BackboneElementElement id
Composition.section:admission_medications_section
Short description

Admission Medications Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:admission_medications_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:admission_medications_section.code
Short description

Medications on admission

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "42346-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:admission_medications_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:admission_medications_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
admission_medications_entryS C0..*Reference(Medication | MedicationRequest | MedicationStatement)Element id
Composition.section:admission_medications_section.entry:admission_medications_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Medication | MedicationRequest | MedicationStatement)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
chief_complaint_and_reason_for_visit_sectionS C0..1BackboneElementElement id
Composition.section:chief_complaint_and_reason_for_visit_section
Short description

Chief Complaint and Reason for Visit Section. This section records the patient's chief complaint (the patient’s own description) and/or the reason for the patient's visit (the provider’s description of the reason for visit). Local policy determines whether the information is divided into two sections or recorded in one section serving both purposes.

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:chief_complaint_and_reason_for_visit_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:chief_complaint_and_reason_for_visit_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46239-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:chief_complaint_and_reason_for_visit_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
chief_complaint_sectionS C0..1BackboneElementElement id
Composition.section:chief_complaint_section
Short description

Chief Complaint Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:chief_complaint_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:chief_complaint_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10154-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:chief_complaint_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
family_history_sectionS C0..1BackboneElementElement id
Composition.section:family_history_section
Short description

Family History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:family_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:family_history_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10157-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:family_history_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:family_history_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
family_history_entryS C0..*Reference(FamilyMemberHistory)Element id
Composition.section:family_history_section.entry:family_history_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

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

Comments

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

Data type

Reference(FamilyMemberHistory)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
functional_status_sectionS C0..1BackboneElementElement id
Composition.section:functional_status_section
Short description

Functional Status Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:functional_status_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:functional_status_section.code
Short description

Functional status

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47420-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:functional_status_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:functional_status_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
functional_status_entryS C0..*Reference(ClinicalImpression | Observation | ConditionEHR)Element id
Composition.section:functional_status_section.entry:functional_status_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

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

Comments

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

Data type

Reference(ClinicalImpression | Observation | ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
history_of_present_illness_sectionS C0..1BackboneElementElement id
Composition.section:history_of_present_illness_section
Short description

History of Present Illness Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:history_of_present_illness_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:history_of_present_illness_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10164-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:history_of_present_illness_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_consultations_sectionS C0..1BackboneElementElement id
Composition.section:hospital_consultations_section
Short description

Hospital Consultations Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_consultations_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_consultations_section.code
Short description

Hospital consultations

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18841-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_consultations_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_instructions_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_instructions_section
Short description

Hospital Discharge Instructions Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_instructions_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_instructions_section.code
Short description

Hospital discharge instructions

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8653-8"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_instructions_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_physical_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_physical_section
Short description

Hospital Discharge Physical Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_physical_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_physical_section.code
Short description

Hospital discharge physical

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10184-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_physical_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_studies_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_studies_section
Short description

Hospital Discharge Studies Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_studies_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_studies_section.code
Short description

Hospital discharge studies summary

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11493-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_studies_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
immunizations_sectionS C0..1BackboneElementElement id
Composition.section:immunizations_section
Short description

Immunizations Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:immunizations_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:immunizations_section.code
Short description

Immunizations

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11369-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:immunizations_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:immunizations_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
immunizations_entryS C0..*Reference(Immunization)Element id
Composition.section:immunizations_section.entry:immunizations_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Immunization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
nutrition_sectionS C0..1BackboneElementElement id
Composition.section:nutrition_section
Short description

Nutrition Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:nutrition_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:nutrition_section.code
Short description

Diet and nutrition

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "61144-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:nutrition_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:nutrition_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
nutrition_entryS C0..*Reference(Observation)Element id
Composition.section:nutrition_section.entry:nutrition_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

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

Comments

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

Data type

Reference(Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
past_medical_history_sectionS C0..1BackboneElementElement id
Composition.section:past_medical_history_section
Short description

Past Medical History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:past_medical_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:past_medical_history_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11348-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:past_medical_history_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:past_medical_history_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
past_medical_history_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:past_medical_history_section.entry:past_medical_history_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
problem_sectionS C0..1BackboneElementElement id
Composition.section:problem_section
Short description

Problem Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:problem_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:problem_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:problem_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:problem_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:problem_section.code
Short description

Problem list

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11450-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:problem_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:problem_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
problem_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:problem_section.entry:problem_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
procedures_sectionS C0..1BackboneElementElement id
Composition.section:procedures_section
Short description

Procedures Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:procedures_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:procedures_section.code
Short description

History of procedures

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47519-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:procedures_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:procedures_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
procedure_entryS C0..*Reference(Procedure)Element id
Composition.section:procedures_section.entry:procedure_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Procedure)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
reason_for_visit_sectionS C0..1BackboneElementElement id
Composition.section:reason_for_visit_section
Short description

Reason for Visit Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:reason_for_visit_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:reason_for_visit_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29299-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:reason_for_visit_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
review_of_systems_sectionS C0..1BackboneElementElement id
Composition.section:review_of_systems_section
Short description

Review of Systems Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:review_of_systems_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:review_of_systems_section.code
Short description

Review of systems

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10187-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:review_of_systems_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
social_history_sectionS C0..1BackboneElementElement id
Composition.section:social_history_section
Short description

Social History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:social_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:social_history_section.code
Short description

Social history

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29762-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:social_history_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:social_history_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
smoking_status_entryS C0..*Reference(ObservationSmokingStatusOCRE)Element id
Composition.section:social_history_section.entry:smoking_status_entry
Short description

Smoking status

Definition

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

Comments

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

Data type

Reference(ObservationSmokingStatusOCRE)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
vital_signs_sectionS C0..1BackboneElementElement id
Composition.section:vital_signs_section
Short description

Vital Signs Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:vital_signs_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:vital_signs_section.code
Short description

Vital signs

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8716-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:vital_signs_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:vital_signs_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
vital_signs_entryS C0..*Reference(observation-vitalsigns)Element id
Composition.section:vital_signs_section.entry:vital_signs_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(observation-vitalsigns)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
goals_sectionS C0..1BackboneElementElement id
Composition.section:goals_section
Short description

Goals Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:goals_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:goals_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:goals_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:goals_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:goals_section.code
Short description

Goals

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "61146-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:goals_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:goals_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
goals_entryS C0..*Reference(Goal)Element id
Composition.section:goals_section.entry:goals_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Goal)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
health_concerns_sectionS C0..1BackboneElementElement id
Composition.section:health_concerns_section
Short description

Health Concerns Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:health_concerns_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:health_concerns_section.code
Short description

Health concerns section code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "75310-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:health_concerns_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:health_concerns_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
health_concerns_entryS C0..*Reference(ClinicalImpression | DocumentReference | List | Observation | RiskAssessment | observation-vitalsigns | AllergyIntoleranceEHR | ConditionEHR)Element id
Composition.section:health_concerns_section.entry:health_concerns_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

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

Comments

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

Data type

Reference(ClinicalImpression | DocumentReference | List | Observation | RiskAssessment | observation-vitalsigns | AllergyIntoleranceEHR | ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section

Hybrid View

DischargeSummaryOCRE (Composition)CDocumentHeaderOCRE
There are no (further) constraints on this element
Element id
Composition
Short description

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

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

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.

Data type

DocumentHeaderOCRE

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
  • cda: ClinicalDocument
  • fhirdocumentreference: when described by DocumentReference
idΣ0..1id
There are no (further) constraints on this element
Element id
Composition.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
metaΣ0..1Meta
There are no (further) constraints on this element
Element id
Composition.meta
Short description

Metadata about the resource

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
Composition.implicitRules
Short description

A set of rules under which this content was created

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.

Comments

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

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
languageS1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
MaxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
text0..1Narrative
There are no (further) constraints on this element
Element id
Composition.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
Composition.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
versionNumberC0..1Extension(string)
There are no (further) constraints on this element
Element id
Composition.extension:versionNumber
Short description

Version-specific identifier for composition

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension(string)

Extension URL

CDVersionNumber

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
identifierS Σ1..1Identifier
There are no (further) constraints on this element
Element id
Composition.identifier
Short description

identifier

Definition

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

Comments

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

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: Document.id / Document.setId
  • cda: .setId
  • fhirdocumentreference: DocumentReference.masterIdentifier
statusΣ ?!1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.status
Short description

preliminary | final | amended | entered-in-error

Definition

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

Requirements

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

Comments

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

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

Data type

code

Binding

The workflow/clinical status of the composition.

CompositionStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
  • cda: n/a
  • fhirdocumentreference: DocumentReference.status
typeS Σ1..1CodeableConceptBindingElement id
Composition.type
Short description

Discharge Summary

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

Type of a composition.

DischargeSummaryDocumentTypeCode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.code
  • w5: FiveWs.class
  • rim: ./code
  • cda: .code
  • fhirdocumentreference: DocumentReference.type
categoryΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
Composition.category
Short description

Categorization of Composition

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.

Requirements

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

Comments

This is a metadata field from XDS/MHD.

Data type

CodeableConcept

Binding

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

DocumentClassValueSet (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.subject
  • w5: FiveWs.class
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • cda: n/a
  • fhirdocumentreference: DocumenttReference.category
subjectS Σ C0..1Reference(Group | PatientEHR)
There are no (further) constraints on this element
Element id
Composition.subject
Short description

Who and/or what the composition is about

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

Requirements

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

Comments

For clinical documents, this is usually the patient.

Data type

Reference(Group | PatientEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • cda: .recordTarget
  • fhirdocumentreference: DocumentReference.subject
  • w5: FiveWs.subject
encounterS Σ C0..1Reference(EncounterEHR)
There are no (further) constraints on this element
Element id
Composition.encounter
Short description

Context of the Composition

Definition

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

Requirements

Provides context for the composition and supports searching.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(EncounterEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.context
  • w5: FiveWs.context
  • rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
  • cda: .componentOf.encompassingEncounter
  • fhirdocumentreference: DocumentReference.context.encounter
dateS Σ1..1dateTime
There are no (further) constraints on this element
Element id
Composition.date
Short description

date

Definition

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

Requirements

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

Comments

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.occurrence[x]
  • w5: FiveWs.done[x]
  • rim: .effectiveTime[type="TS"]
  • cda: .effectiveTime
  • fhirdocumentreference: DocumentReference.content.attachment.date, DocumentReference.created
authorS Σ C1..*Reference(Device | RelatedPerson | PatientEHR | PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.author
Short description

Who and/or what authored the composition

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | RelatedPerson | PatientEHR | PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
  • fhirdocumentreference: DocumentReference.agent
titleS Σ1..1string
There are no (further) constraints on this element
Element id
Composition.title
Short description

Document Title

Definition

Official human-readable label for the composition.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
  • fhirdocumentreference: DocumentReference.description, DocumentReference.content.attachment.title
confidentialityΣ0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.confidentiality
Short description

Use the confidentiality codes in Meta.security

Definition

Use the confidentiality codes in Meta.security (https://hl7.org/fhir/security-labels.html)

Comments

The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

Data type

code

Binding

Codes specifying the level of confidentiality of the composition.

v3.ConfidentialityClassification (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .confidentialityCode
  • cda: .confidentialityCode
  • fhirdocumentreference: DocumentReference.securityLabel
attester0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester
Short description

Attests to accuracy of composition

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Slicing

Unordered, Open, by mode(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
(All Slices)
The requirements in this element apply to all slices

id0..1string
There are no (further) constraints on this element
Element id
Composition.attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
mode1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.attester.mode
Short description

personal | professional | legal | official

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyC0..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.attester.party
Short description

Who attested the composition

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
legal_attesterS0..1BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester
Short description

attester

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
legal
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
professional_attesterS0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester
Short description

attester

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
professional
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
personal_attesterS0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester
Short description

attester

Definition

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

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
personal
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

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

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(RelatedPerson | PractitionerEHR)
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

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

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(RelatedPerson | PractitionerEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
custodianS Σ C1..1Reference(OrganizationEHR)
There are no (further) constraints on this element
Element id
Composition.custodian
Short description

Organization which maintains the composition

Definition

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

Requirements

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

Comments

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

Data type

Reference(OrganizationEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
  • cda: .custodian.assignedCustodian
  • fhirdocumentreference: DocumentReference.custodian
relatesTo0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.relatesTo
Short description

Relationships to other compositions/documents

Definition

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

Comments

A document is a version specific composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship
  • cda: .relatedDocument
  • fhirdocumentreference: DocumentReference.relatesTo
id0..1string
There are no (further) constraints on this element
Element id
Composition.relatesTo.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.relatesTo.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.relatesTo.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
code1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.relatesTo.code
Short description

replaces | transforms | signs | appends

Definition

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

Comments

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

Data type

code

Binding

The type of relationship between documents.

DocumentRelationshipType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship.typeCode
  • cda: .relatedDocument.typeCode
  • fhirdocumentreference: DocumentReference.relatesTo.code
target[x]1..1
There are no (further) constraints on this element
Element id
Composition.relatesTo.target[x]
Short description

Target of the relationship

Definition

The target composition/document of this relationship.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .target[classCode="DOC", moodCode="EVN"].id
  • cda: .relatedDocument.id
  • fhirdocumentreference: DocumentReference.relatesTo.target
targetIdentifierIdentifier
There are no (further) constraints on this element
Data type

Identifier

targetReferenceReference(Composition)
There are no (further) constraints on this element
Data type

Reference(Composition)

eventΣ0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.event
Short description

The clinical service(s) being documented

Definition

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

Requirements

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

Comments

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

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
  • cda: .documentationOf.serviceEvent
  • fhirdocumentreference: DocumentReference.event
id0..1string
There are no (further) constraints on this element
Element id
Composition.event.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.event.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.event.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
codeΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
Composition.event.code
Short description

Code(s) that apply to the event being documented

Definition

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

Comments

An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.

Data type

CodeableConcept

Binding

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

ActCode (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .code
  • cda: .code
  • fhirdocumentreference: DocumentReference.event.code
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
Composition.event.period
Short description

The period covered by the documentation

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.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • rim: .effectiveTime
  • cda: .effectiveTime
  • fhirdocumentreference: DocumentReference.event.period
detailΣ C0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.event.detail
Short description

The event(s) being documented

Definition

The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode="SUBJ"].target
  • cda: n/a
sectionC3..*BackboneElementElement id
Composition.section
Short description

Composition is broken into sections

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Slicing

Unordered, Open, by code(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
(All Slices)
The requirements in this element apply to all slices

id0..1string
There are no (further) constraints on this element
Element id
Composition.section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
title0..1string
There are no (further) constraints on this element
Element id
Composition.section.title
Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
code0..1CodeableConcept
There are no (further) constraints on this element
Element id
Composition.section.code
Short description

Classification of section (recommended)

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textC0..1Narrative
There are no (further) constraints on this element
Element id
Composition.section.text
Short description

Text summary of the section, for human interpretation

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
allergies_and_intolerances_sectionS C1..1BackboneElementElement id
Composition.section:allergies_and_intolerances_section
Short description

Allergies and Intolerances Section

Definition

The root of the sections that make up the composition.

Comments

Allergies and Intolerances Section

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:allergies_and_intolerances_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:allergies_and_intolerances_section.code
Short description

Allergies and adverse reactions

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48765-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:allergies_and_intolerances_section.text
Short description

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:allergies_and_intolerances_section.entry
Short description

entry

Definition

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

Comments

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

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
allergy_entryS C0..*Reference(AllergyIntoleranceEHR)Element id
Composition.section:allergies_and_intolerances_section.entry:allergy_entry
Short description

A reference to data that supports this section

Definition

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

Comments

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

Data type

Reference(AllergyIntoleranceEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.emptyReason
Short description

Why the section is empty

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_course_sectionS C1..1BackboneElementElement id
Composition.section:hospital_course_section
Short description

Hospital Course Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.id
Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_course_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

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

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_course_section.code
Short description

code

Definition

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

Requirements

Provides computable standardized labels to topics within the document.

Comments

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

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

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8648-8"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.author
Short description

Who and/or what authored the section

Definition

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

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.focus
Short description

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

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

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_course_section.text
Short description

This section contains only human readable content

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.

Comments

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

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

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

Comments

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

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.orderedBy
Short description

Order of section entries

Definition

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

Requirements

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

Comments

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

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.entry
Short description

A reference to data that supports this section

Definition

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

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
discharge_diagnosis_sectionS C1..1BackboneElementElement id
Composition.section:discharge_diagnosis_section
Short description

Discharge Diagnosis Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:discharge_diagnosis_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:discharge_diagnosis_section.code
Short description

Hospital discharge diagnosis

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11535-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:discharge_diagnosis_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:discharge_diagnosis_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
discharge_diagnosis_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:discharge_diagnosis_section.entry:discharge_diagnosis_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
plan_of_treatment_sectionS C0..1BackboneElementElement id
Composition.section:plan_of_treatment_section
Short description

Plan of Treatment Section

Definition

The root of the sections that make up the composition.

Comments

Plan of Treatment Section

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:plan_of_treatment_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:plan_of_treatment_section.code
Short description

Plan of treatment

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18776-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:plan_of_treatment_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:plan_of_treatment_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
sliceEntryC0..*Reference(Appointment | Communication | CommunicationRequest | DeviceRequest | Goal | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | EncounterEHR | ServiceRequestEHR)Element id
Composition.section:plan_of_treatment_section.entry:sliceEntry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Appointment | Communication | CommunicationRequest | DeviceRequest | Goal | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | EncounterEHR | ServiceRequestEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
discharge_medications_sectionS C0..1BackboneElementElement id
Composition.section:discharge_medications_section
Short description

Discharge Medications Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:discharge_medications_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:discharge_medications_section.code
Short description

Hospital discharge medications

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10183-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:discharge_medications_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:discharge_medications_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
discharge_medications_entryS C0..*Reference(Medication | MedicationRequest | MedicationStatement)Element id
Composition.section:discharge_medications_section.entry:discharge_medications_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Medication | MedicationRequest | MedicationStatement)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
admission_diagnosis_sectionS C0..1BackboneElementElement id
Composition.section:admission_diagnosis_section
Short description

Admission Diagnosis Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:admission_diagnosis_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:admission_diagnosis_section.code
Short description

Hospital admission diagnosis

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46241-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:admission_diagnosis_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:admission_diagnosis_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
admission_diagnosis_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:admission_diagnosis_section.entry:admission_diagnosis_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
admission_medications_sectionS C0..1BackboneElementElement id
Composition.section:admission_medications_section
Short description

Admission Medications Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:admission_medications_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:admission_medications_section.code
Short description

Medications on admission

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "42346-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:admission_medications_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:admission_medications_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
admission_medications_entryS C0..*Reference(Medication | MedicationRequest | MedicationStatement)Element id
Composition.section:admission_medications_section.entry:admission_medications_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Medication | MedicationRequest | MedicationStatement)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
chief_complaint_and_reason_for_visit_sectionS C0..1BackboneElementElement id
Composition.section:chief_complaint_and_reason_for_visit_section
Short description

Chief Complaint and Reason for Visit Section. This section records the patient's chief complaint (the patient’s own description) and/or the reason for the patient's visit (the provider’s description of the reason for visit). Local policy determines whether the information is divided into two sections or recorded in one section serving both purposes.

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:chief_complaint_and_reason_for_visit_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:chief_complaint_and_reason_for_visit_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46239-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:chief_complaint_and_reason_for_visit_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
chief_complaint_sectionS C0..1BackboneElementElement id
Composition.section:chief_complaint_section
Short description

Chief Complaint Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:chief_complaint_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:chief_complaint_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10154-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:chief_complaint_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
family_history_sectionS C0..1BackboneElementElement id
Composition.section:family_history_section
Short description

Family History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:family_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:family_history_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10157-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:family_history_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:family_history_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
family_history_entryS C0..*Reference(FamilyMemberHistory)Element id
Composition.section:family_history_section.entry:family_history_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(FamilyMemberHistory)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
functional_status_sectionS C0..1BackboneElementElement id
Composition.section:functional_status_section
Short description

Functional Status Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:functional_status_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:functional_status_section.code
Short description

Functional status

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47420-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:functional_status_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:functional_status_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
functional_status_entryS C0..*Reference(ClinicalImpression | Observation | ConditionEHR)Element id
Composition.section:functional_status_section.entry:functional_status_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ClinicalImpression | Observation | ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
history_of_present_illness_sectionS C0..1BackboneElementElement id
Composition.section:history_of_present_illness_section
Short description

History of Present Illness Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:history_of_present_illness_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:history_of_present_illness_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10164-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:history_of_present_illness_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_consultations_sectionS C0..1BackboneElementElement id
Composition.section:hospital_consultations_section
Short description

Hospital Consultations Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_consultations_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_consultations_section.code
Short description

Hospital consultations

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18841-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_consultations_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_instructions_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_instructions_section
Short description

Hospital Discharge Instructions Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_instructions_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_instructions_section.code
Short description

Hospital discharge instructions

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8653-8"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_instructions_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_physical_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_physical_section
Short description

Hospital Discharge Physical Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_physical_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_physical_section.code
Short description

Hospital discharge physical

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10184-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_physical_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_studies_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_studies_section
Short description

Hospital Discharge Studies Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_studies_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_studies_section.code
Short description

Hospital discharge studies summary

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11493-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_studies_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
immunizations_sectionS C0..1BackboneElementElement id
Composition.section:immunizations_section
Short description

Immunizations Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:immunizations_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:immunizations_section.code
Short description

Immunizations

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11369-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:immunizations_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:immunizations_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
immunizations_entryS C0..*Reference(Immunization)Element id
Composition.section:immunizations_section.entry:immunizations_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Immunization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
nutrition_sectionS C0..1BackboneElementElement id
Composition.section:nutrition_section
Short description

Nutrition Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:nutrition_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:nutrition_section.code
Short description

Diet and nutrition

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "61144-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:nutrition_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:nutrition_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
nutrition_entryS C0..*Reference(Observation)Element id
Composition.section:nutrition_section.entry:nutrition_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
past_medical_history_sectionS C0..1BackboneElementElement id
Composition.section:past_medical_history_section
Short description

Past Medical History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:past_medical_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:past_medical_history_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11348-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:past_medical_history_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:past_medical_history_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
past_medical_history_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:past_medical_history_section.entry:past_medical_history_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
problem_sectionS C0..1BackboneElementElement id
Composition.section:problem_section
Short description

Problem Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:problem_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:problem_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:problem_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:problem_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:problem_section.code
Short description

Problem list

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11450-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:problem_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:problem_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
problem_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:problem_section.entry:problem_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
procedures_sectionS C0..1BackboneElementElement id
Composition.section:procedures_section
Short description

Procedures Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:procedures_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:procedures_section.code
Short description

History of procedures

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47519-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:procedures_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:procedures_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
procedure_entryS C0..*Reference(Procedure)Element id
Composition.section:procedures_section.entry:procedure_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Procedure)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
reason_for_visit_sectionS C0..1BackboneElementElement id
Composition.section:reason_for_visit_section
Short description

Reason for Visit Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:reason_for_visit_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:reason_for_visit_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29299-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:reason_for_visit_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
review_of_systems_sectionS C0..1BackboneElementElement id
Composition.section:review_of_systems_section
Short description

Review of Systems Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:review_of_systems_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:review_of_systems_section.code
Short description

Review of systems

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10187-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:review_of_systems_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
social_history_sectionS C0..1BackboneElementElement id
Composition.section:social_history_section
Short description

Social History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:social_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:social_history_section.code
Short description

Social history

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29762-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:social_history_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:social_history_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
smoking_status_entryS C0..*Reference(ObservationSmokingStatusOCRE)Element id
Composition.section:social_history_section.entry:smoking_status_entry
Short description

Smoking status

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationSmokingStatusOCRE)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
vital_signs_sectionS C0..1BackboneElementElement id
Composition.section:vital_signs_section
Short description

Vital Signs Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:vital_signs_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:vital_signs_section.code
Short description

Vital signs

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8716-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:vital_signs_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:vital_signs_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
vital_signs_entryS C0..*Reference(observation-vitalsigns)Element id
Composition.section:vital_signs_section.entry:vital_signs_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(observation-vitalsigns)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
goals_sectionS C0..1BackboneElementElement id
Composition.section:goals_section
Short description

Goals Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:goals_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:goals_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:goals_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:goals_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:goals_section.code
Short description

Goals

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "61146-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:goals_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:goals_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
goals_entryS C0..*Reference(Goal)Element id
Composition.section:goals_section.entry:goals_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Goal)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
health_concerns_sectionS C0..1BackboneElementElement id
Composition.section:health_concerns_section
Short description

Health Concerns Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:health_concerns_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:health_concerns_section.code
Short description

Health concerns section code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "75310-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:health_concerns_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:health_concerns_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
health_concerns_entryS C0..*Reference(ClinicalImpression | DocumentReference | List | Observation | RiskAssessment | observation-vitalsigns | AllergyIntoleranceEHR | ConditionEHR)Element id
Composition.section:health_concerns_section.entry:health_concerns_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ClinicalImpression | DocumentReference | List | Observation | RiskAssessment | observation-vitalsigns | AllergyIntoleranceEHR | ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section

Snapshot View

DischargeSummaryOCRE (Composition)CDocumentHeaderOCRE
There are no (further) constraints on this element
Element id
Composition
Short description

A set of resources composed into a single coherent clinical statement with clinical attestation

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.).

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.

Data type

DocumentHeaderOCRE

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
  • cda: ClinicalDocument
  • fhirdocumentreference: when described by DocumentReference
idΣ0..1id
There are no (further) constraints on this element
Element id
Composition.id
Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
metaΣ0..1Meta
There are no (further) constraints on this element
Element id
Composition.meta
Short description

Metadata about the resource

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.

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
Composition.implicitRules
Short description

A set of rules under which this content was created

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.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
languageS1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

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).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
MaxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
text0..1Narrative
There are no (further) constraints on this element
Element id
Composition.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

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.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
Composition.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
versionNumberC0..1Extension(string)
There are no (further) constraints on this element
Element id
Composition.extension:versionNumber
Short description

Version-specific identifier for composition

Alternate names

extensions, user content

Definition

Version specific identifier for the composition, assigned when each version is created/updated.

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.

Data type

Extension(string)

Extension URL

CDVersionNumber

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
identifierS Σ1..1Identifier
There are no (further) constraints on this element
Element id
Composition.identifier
Short description

identifier

Definition

A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

Comments

Similar to ClinicalDocument/setId in CDA. See discussion in resource definition for how these relate.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Event.identifier
  • w5: FiveWs.identifier
  • rim: Document.id / Document.setId
  • cda: .setId
  • fhirdocumentreference: DocumentReference.masterIdentifier
statusΣ ?!1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.status
Short description

preliminary | final | amended | entered-in-error

Definition

The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

Requirements

Need to be able to mark interim, amended, or withdrawn compositions or documents.

Comments

If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.

Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

Data type

code

Binding

The workflow/clinical status of the composition.

CompositionStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • rim: interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
  • cda: n/a
  • fhirdocumentreference: DocumentReference.status
typeS Σ1..1CodeableConceptBindingElement id
Composition.type
Short description

Discharge Summary

Definition

Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

Requirements

Key metadata element describing the composition, used in searching/filtering.

Comments

For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.

Data type

CodeableConcept

Binding

Type of a composition.

DischargeSummaryDocumentTypeCode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.code
  • w5: FiveWs.class
  • rim: ./code
  • cda: .code
  • fhirdocumentreference: DocumentReference.type
categoryΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
Composition.category
Short description

Categorization of Composition

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.

Requirements

Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.

Comments

This is a metadata field from XDS/MHD.

Data type

CodeableConcept

Binding

High-level kind of a clinical document at a macro level.

DocumentClassValueSet (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.subject
  • w5: FiveWs.class
  • rim: .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • cda: n/a
  • fhirdocumentreference: DocumenttReference.category
subjectS Σ C0..1Reference(Group | PatientEHR)
There are no (further) constraints on this element
Element id
Composition.subject
Short description

Who and/or what the composition is about

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).

Requirements

Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.

Comments

For clinical documents, this is usually the patient.

Data type

Reference(Group | PatientEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • rim: .participation[typeCode="SBJ"].role[typeCode="PAT"]
  • cda: .recordTarget
  • fhirdocumentreference: DocumentReference.subject
  • w5: FiveWs.subject
encounterS Σ C0..1Reference(EncounterEHR)
There are no (further) constraints on this element
Element id
Composition.encounter
Short description

Context of the Composition

Definition

Describes the clinical encounter or type of care this documentation is associated with.

Requirements

Provides context for the composition and supports searching.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(EncounterEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.context
  • w5: FiveWs.context
  • rim: unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
  • cda: .componentOf.encompassingEncounter
  • fhirdocumentreference: DocumentReference.context.encounter
dateS Σ1..1dateTime
There are no (further) constraints on this element
Element id
Composition.date
Short description

date

Definition

The composition editing time, when the composition was last logically changed by the author.

Requirements

dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging.

Comments

The Last Modified Date on the composition may be after the date of the document was attested without being changed.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.occurrence[x]
  • w5: FiveWs.done[x]
  • rim: .effectiveTime[type="TS"]
  • cda: .effectiveTime
  • fhirdocumentreference: DocumentReference.content.attachment.date, DocumentReference.created
authorS Σ C1..*Reference(Device | RelatedPerson | PatientEHR | PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.author
Short description

Who and/or what authored the composition

Definition

Identifies who is responsible for the information in the composition, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | RelatedPerson | PatientEHR | PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
  • fhirdocumentreference: DocumentReference.agent
titleS Σ1..1string
There are no (further) constraints on this element
Element id
Composition.title
Short description

Document Title

Definition

Official human-readable label for the composition.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
  • fhirdocumentreference: DocumentReference.description, DocumentReference.content.attachment.title
confidentialityΣ0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.confidentiality
Short description

Use the confidentiality codes in Meta.security

Definition

Use the confidentiality codes in Meta.security (https://hl7.org/fhir/security-labels.html)

Comments

The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

Data type

code

Binding

Codes specifying the level of confidentiality of the composition.

v3.ConfidentialityClassification (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .confidentialityCode
  • cda: .confidentialityCode
  • fhirdocumentreference: DocumentReference.securityLabel
attester0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester
Short description

Attests to accuracy of composition

Definition

A participant who has attested to the accuracy of the composition/document.

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Slicing

Unordered, Open, by mode(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
(All Slices)
The requirements in this element apply to all slices

id0..1string
There are no (further) constraints on this element
Element id
Composition.attester.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
mode1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.attester.mode
Short description

personal | professional | legal | official

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyC0..1Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.attester.party
Short description

Who attested the composition

Definition

Who attested the composition in the specified way.

Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
legal_attesterS0..1BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester
Short description

attester

Definition

A participant who has attested to the accuracy of the composition/document.

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
legal
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.attester:legal_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
professional_attesterS0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester
Short description

attester

Definition

A participant who has attested to the accuracy of the composition/document.

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
professional
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(PractitionerEHR | PractitionerRoleEHR)
There are no (further) constraints on this element
Element id
Composition.attester:professional_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(PractitionerEHR | PractitionerRoleEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
personal_attesterS0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester
Short description

attester

Definition

A participant who has attested to the accuracy of the composition/document.

Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda: .authenticator/.legalAuthenticator
  • fhirdocumentreference: DocumentReference.authenticator
id0..1string
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modeS1..1codeBindingFixed Value
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.mode
Short description

mode

Definition

The type of attestation the authenticator offers.

Requirements

Indicates the level of authority of the attestation.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed value
personal
Mappings
  • rim: n/a
  • rim: unique(./modeCode)
  • cda: implied by .authenticator/.legalAuthenticator
time0..1dateTime
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.time
Short description

When the composition was attested

Definition

When the composition was attested by the party.

Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./time[type="TS" and isNormalDatatype()]
  • cda: .authenticator.time
partyS C1..1Reference(RelatedPerson | PractitionerEHR)
There are no (further) constraints on this element
Element id
Composition.attester:personal_attester.party
Short description

party

Definition

Who attested the composition in the specified way.

Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(RelatedPerson | PractitionerEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda: .authenticator.assignedEnttty
custodianS Σ C1..1Reference(OrganizationEHR)
There are no (further) constraints on this element
Element id
Composition.custodian
Short description

Organization which maintains the composition

Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

Requirements

Identifies where to go to find the current version, where to report issues, etc.

Comments

This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.

Data type

Reference(OrganizationEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
  • cda: .custodian.assignedCustodian
  • fhirdocumentreference: DocumentReference.custodian
relatesTo0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.relatesTo
Short description

Relationships to other compositions/documents

Definition

Relationships that this composition has with other compositions or documents that already exist.

Comments

A document is a version specific composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship
  • cda: .relatedDocument
  • fhirdocumentreference: DocumentReference.relatesTo
id0..1string
There are no (further) constraints on this element
Element id
Composition.relatesTo.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.relatesTo.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.relatesTo.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
code1..1codeBinding
There are no (further) constraints on this element
Element id
Composition.relatesTo.code
Short description

replaces | transforms | signs | appends

Definition

The type of relationship that this composition has with anther composition or document.

Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Data type

code

Binding

The type of relationship between documents.

DocumentRelationshipType (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .outboundRelationship.typeCode
  • cda: .relatedDocument.typeCode
  • fhirdocumentreference: DocumentReference.relatesTo.code
target[x]1..1
There are no (further) constraints on this element
Element id
Composition.relatesTo.target[x]
Short description

Target of the relationship

Definition

The target composition/document of this relationship.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .target[classCode="DOC", moodCode="EVN"].id
  • cda: .relatedDocument.id
  • fhirdocumentreference: DocumentReference.relatesTo.target
targetIdentifierIdentifier
There are no (further) constraints on this element
Data type

Identifier

targetReferenceReference(Composition)
There are no (further) constraints on this element
Data type

Reference(Composition)

eventΣ0..*BackboneElement
There are no (further) constraints on this element
Element id
Composition.event
Short description

The clinical service(s) being documented

Definition

The clinical service, such as a colonoscopy or an appendectomy, being documented.

Requirements

Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.

Comments

The event needs to be consistent with the type element, though can provide further information if desired.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
  • cda: .documentationOf.serviceEvent
  • fhirdocumentreference: DocumentReference.event
id0..1string
There are no (further) constraints on this element
Element id
Composition.event.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.event.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.event.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
codeΣ0..*CodeableConcept
There are no (further) constraints on this element
Element id
Composition.event.code
Short description

Code(s) that apply to the event being documented

Definition

This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

Comments

An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.

Data type

CodeableConcept

Binding

This list of codes represents the main clinical acts being documented.

ActCode (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .code
  • cda: .code
  • fhirdocumentreference: DocumentReference.event.code
periodΣ C0..1Period
There are no (further) constraints on this element
Element id
Composition.event.period
Short description

The period covered by the documentation

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.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • rim: .effectiveTime
  • cda: .effectiveTime
  • fhirdocumentreference: DocumentReference.event.period
detailΣ C0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.event.detail
Short description

The event(s) being documented

Definition

The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode="SUBJ"].target
  • cda: n/a
sectionC3..*BackboneElementElement id
Composition.section
Short description

Composition is broken into sections

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Slicing

Unordered, Open, by code(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
(All Slices)
The requirements in this element apply to all slices

id0..1string
There are no (further) constraints on this element
Element id
Composition.section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
title0..1string
There are no (further) constraints on this element
Element id
Composition.section.title
Short description

Label for section (e.g. for ToC)

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
code0..1CodeableConcept
There are no (further) constraints on this element
Element id
Composition.section.code
Short description

Classification of section (recommended)

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textC0..1Narrative
There are no (further) constraints on this element
Element id
Composition.section.text
Short description

Text summary of the section, for human interpretation

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
allergies_and_intolerances_sectionS C1..1BackboneElementElement id
Composition.section:allergies_and_intolerances_section
Short description

Allergies and Intolerances Section

Definition

The root of the sections that make up the composition.

Comments

Allergies and Intolerances Section

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:allergies_and_intolerances_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:allergies_and_intolerances_section.code
Short description

Allergies and adverse reactions

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "48765-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:allergies_and_intolerances_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:allergies_and_intolerances_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
allergy_entryS C0..*Reference(AllergyIntoleranceEHR)Element id
Composition.section:allergies_and_intolerances_section.entry:allergy_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(AllergyIntoleranceEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:allergies_and_intolerances_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_course_sectionS C1..1BackboneElementElement id
Composition.section:hospital_course_section
Short description

Hospital Course Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_course_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_course_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8648-8"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_course_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_course_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
discharge_diagnosis_sectionS C1..1BackboneElementElement id
Composition.section:discharge_diagnosis_section
Short description

Discharge Diagnosis Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:discharge_diagnosis_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:discharge_diagnosis_section.code
Short description

Hospital discharge diagnosis

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11535-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:discharge_diagnosis_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:discharge_diagnosis_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
discharge_diagnosis_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:discharge_diagnosis_section.entry:discharge_diagnosis_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:discharge_diagnosis_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
plan_of_treatment_sectionS C0..1BackboneElementElement id
Composition.section:plan_of_treatment_section
Short description

Plan of Treatment Section

Definition

The root of the sections that make up the composition.

Comments

Plan of Treatment Section

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:plan_of_treatment_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:plan_of_treatment_section.code
Short description

Plan of treatment

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18776-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:plan_of_treatment_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:plan_of_treatment_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
sliceEntryC0..*Reference(Appointment | Communication | CommunicationRequest | DeviceRequest | Goal | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | EncounterEHR | ServiceRequestEHR)Element id
Composition.section:plan_of_treatment_section.entry:sliceEntry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Appointment | Communication | CommunicationRequest | DeviceRequest | Goal | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | EncounterEHR | ServiceRequestEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:plan_of_treatment_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
discharge_medications_sectionS C0..1BackboneElementElement id
Composition.section:discharge_medications_section
Short description

Discharge Medications Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:discharge_medications_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:discharge_medications_section.code
Short description

Hospital discharge medications

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10183-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:discharge_medications_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:discharge_medications_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
discharge_medications_entryS C0..*Reference(Medication | MedicationRequest | MedicationStatement)Element id
Composition.section:discharge_medications_section.entry:discharge_medications_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Medication | MedicationRequest | MedicationStatement)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:discharge_medications_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
admission_diagnosis_sectionS C0..1BackboneElementElement id
Composition.section:admission_diagnosis_section
Short description

Admission Diagnosis Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:admission_diagnosis_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:admission_diagnosis_section.code
Short description

Hospital admission diagnosis

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46241-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:admission_diagnosis_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:admission_diagnosis_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
admission_diagnosis_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:admission_diagnosis_section.entry:admission_diagnosis_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:admission_diagnosis_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
admission_medications_sectionS C0..1BackboneElementElement id
Composition.section:admission_medications_section
Short description

Admission Medications Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:admission_medications_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:admission_medications_section.code
Short description

Medications on admission

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "42346-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:admission_medications_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:admission_medications_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
admission_medications_entryS C0..*Reference(Medication | MedicationRequest | MedicationStatement)Element id
Composition.section:admission_medications_section.entry:admission_medications_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Medication | MedicationRequest | MedicationStatement)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:admission_medications_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
chief_complaint_and_reason_for_visit_sectionS C0..1BackboneElementElement id
Composition.section:chief_complaint_and_reason_for_visit_section
Short description

Chief Complaint and Reason for Visit Section. This section records the patient's chief complaint (the patient’s own description) and/or the reason for the patient's visit (the provider’s description of the reason for visit). Local policy determines whether the information is divided into two sections or recorded in one section serving both purposes.

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:chief_complaint_and_reason_for_visit_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:chief_complaint_and_reason_for_visit_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "46239-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:chief_complaint_and_reason_for_visit_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_and_reason_for_visit_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
chief_complaint_sectionS C0..1BackboneElementElement id
Composition.section:chief_complaint_section
Short description

Chief Complaint Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:chief_complaint_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:chief_complaint_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10154-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:chief_complaint_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:chief_complaint_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
family_history_sectionS C0..1BackboneElementElement id
Composition.section:family_history_section
Short description

Family History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:family_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:family_history_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10157-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:family_history_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:family_history_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
family_history_entryS C0..*Reference(FamilyMemberHistory)Element id
Composition.section:family_history_section.entry:family_history_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(FamilyMemberHistory)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:family_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
functional_status_sectionS C0..1BackboneElementElement id
Composition.section:functional_status_section
Short description

Functional Status Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:functional_status_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:functional_status_section.code
Short description

Functional status

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47420-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:functional_status_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:functional_status_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
functional_status_entryS C0..*Reference(ClinicalImpression | Observation | ConditionEHR)Element id
Composition.section:functional_status_section.entry:functional_status_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ClinicalImpression | Observation | ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:functional_status_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
history_of_present_illness_sectionS C0..1BackboneElementElement id
Composition.section:history_of_present_illness_section
Short description

History of Present Illness Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:history_of_present_illness_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:history_of_present_illness_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10164-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:history_of_present_illness_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:history_of_present_illness_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_consultations_sectionS C0..1BackboneElementElement id
Composition.section:hospital_consultations_section
Short description

Hospital Consultations Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_consultations_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_consultations_section.code
Short description

Hospital consultations

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "18841-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_consultations_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_consultations_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_instructions_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_instructions_section
Short description

Hospital Discharge Instructions Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_instructions_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_instructions_section.code
Short description

Hospital discharge instructions

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8653-8"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_instructions_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_instructions_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_physical_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_physical_section
Short description

Hospital Discharge Physical Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_physical_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_physical_section.code
Short description

Hospital discharge physical

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10184-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_physical_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_physical_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
hospital_discharge_studies_sectionS C0..1BackboneElementElement id
Composition.section:hospital_discharge_studies_section
Short description

Hospital Discharge Studies Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:hospital_discharge_studies_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:hospital_discharge_studies_section.code
Short description

Hospital discharge studies summary

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11493-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:hospital_discharge_studies_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:hospital_discharge_studies_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
immunizations_sectionS C0..1BackboneElementElement id
Composition.section:immunizations_section
Short description

Immunizations Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:immunizations_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:immunizations_section.code
Short description

Immunizations

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11369-6"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:immunizations_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:immunizations_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
immunizations_entryS C0..*Reference(Immunization)Element id
Composition.section:immunizations_section.entry:immunizations_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Immunization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:immunizations_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
nutrition_sectionS C0..1BackboneElementElement id
Composition.section:nutrition_section
Short description

Nutrition Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:nutrition_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:nutrition_section.code
Short description

Diet and nutrition

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "61144-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:nutrition_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:nutrition_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
nutrition_entryS C0..*Reference(Observation)Element id
Composition.section:nutrition_section.entry:nutrition_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:nutrition_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
past_medical_history_sectionS C0..1BackboneElementElement id
Composition.section:past_medical_history_section
Short description

Past Medical History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:past_medical_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:past_medical_history_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11348-0"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:past_medical_history_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:past_medical_history_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
past_medical_history_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:past_medical_history_section.entry:past_medical_history_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:past_medical_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
problem_sectionS C0..1BackboneElementElement id
Composition.section:problem_section
Short description

Problem Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:problem_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:problem_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:problem_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:problem_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:problem_section.code
Short description

Problem list

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "11450-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:problem_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:problem_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
problem_entryS C0..*Reference(ConditionEHR)Element id
Composition.section:problem_section.entry:problem_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:problem_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:problem_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
procedures_sectionS C0..1BackboneElementElement id
Composition.section:procedures_section
Short description

Procedures Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:procedures_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:procedures_section.code
Short description

History of procedures

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "47519-4"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:procedures_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:procedures_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
procedure_entryS C0..*Reference(Procedure)Element id
Composition.section:procedures_section.entry:procedure_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Procedure)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:procedures_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
reason_for_visit_sectionS C0..1BackboneElementElement id
Composition.section:reason_for_visit_section
Short description

Reason for Visit Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:reason_for_visit_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:reason_for_visit_section.code
Short description

code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29299-5"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:reason_for_visit_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:reason_for_visit_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
review_of_systems_sectionS C0..1BackboneElementElement id
Composition.section:review_of_systems_section
Short description

Review of Systems Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:review_of_systems_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:review_of_systems_section.code
Short description

Review of systems

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "10187-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:review_of_systems_section.text
Short description

This section contains only human readable content

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:review_of_systems_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
social_history_sectionS C0..1BackboneElementElement id
Composition.section:social_history_section
Short description

Social History Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:social_history_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:social_history_section.code
Short description

Social history

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "29762-2"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:social_history_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:social_history_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
smoking_status_entryS C0..*Reference(ObservationSmokingStatusOCRE)Element id
Composition.section:social_history_section.entry:smoking_status_entry
Short description

Smoking status

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ObservationSmokingStatusOCRE)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:social_history_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
vital_signs_sectionS C0..1BackboneElementElement id
Composition.section:vital_signs_section
Short description

Vital Signs Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:vital_signs_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:vital_signs_section.code
Short description

Vital signs

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "8716-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:vital_signs_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:vital_signs_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
vital_signs_entryS C0..*Reference(observation-vitalsigns)Element id
Composition.section:vital_signs_section.entry:vital_signs_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(observation-vitalsigns)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:vital_signs_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
goals_sectionS C0..1BackboneElementElement id
Composition.section:goals_section
Short description

Goals Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:goals_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:goals_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:goals_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:goals_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:goals_section.code
Short description

Goals

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "61146-7"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:goals_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:goals_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
goals_entryS C0..*Reference(Goal)Element id
Composition.section:goals_section.entry:goals_entry
Short description

A reference to data that supports this section

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Goal)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:goals_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:goals_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section
health_concerns_sectionS C0..1BackboneElementElement id
Composition.section:health_concerns_section
Short description

Health Concerns Section

Definition

The root of the sections that make up the composition.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cmp-1: A section must contain at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2: A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim: n/a
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.structuredBody.component.section
id0..1string
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

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.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
titleS1..1stringElement id
Composition.section:health_concerns_section.title
Short description

title

Alternate names

header, label, caption

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.

Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: ./title
  • cda: .title
codeS1..1CodeableConceptPatternElement id
Composition.section:health_concerns_section.code
Short description

Health concerns section code

Definition

A code identifying the kind of content contained within the section. This must be consistent with the section title.

Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document.

If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Data type

CodeableConcept

Binding

Classification of a section of a composition/document.

DocumentSectionCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
{
  "coding": [
    {
      "system": "http://loinc.org",
      "code": "75310-3"
    }
  ]
}
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: ./code
  • cda: .code
authorC0..*Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.author
Short description

Who and/or what authored the section

Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • rim: .participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda: .author.assignedAuthor
focusC0..1Reference(Resource)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.focus
Short description

Who/what the section is about, when it is not about the subject of composition

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).

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.

Data type

Reference(Resource)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • cda: .subject? (CDA did not differentiate between subject and focus)
textS C1..1NarrativeElement id
Composition.section:health_concerns_section.text
Short description

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.

Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: .text
  • cda: .text
mode0..1codeBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.mode
Short description

working | snapshot | changes

Definition

How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

Data type

code

Binding

The processing mode that applies to this section.

ListMode (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.class
  • rim: .outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda: n/a
orderedBy0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.orderedBy
Short description

Order of section entries

Definition

Specifies the order applied to the items in the section entries.

Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Data type

CodeableConcept

Binding

What order applies to the items in the entry.

ListOrderCodes (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda: n/a
entryC0..*Reference(Resource)Element id
Composition.section:health_concerns_section.entry
Short description

entry

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(Resource)

Slicing

Unordered, Open, by resolve()(Profile)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
health_concerns_entryS C0..*Reference(ClinicalImpression | DocumentReference | List | Observation | RiskAssessment | observation-vitalsigns | AllergyIntoleranceEHR | ConditionEHR)Element id
Composition.section:health_concerns_section.entry:health_concerns_entry
Short description

This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.

Definition

A reference to the actual resource from which the narrative in the section is derived.

Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Data type

Reference(ClinicalImpression | DocumentReference | List | Observation | RiskAssessment | observation-vitalsigns | AllergyIntoleranceEHR | ConditionEHR)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda: .entry
emptyReasonC0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.emptyReason
Short description

Why the section is empty

Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Data type

CodeableConcept

Binding

If a section is empty, why it is empty.

ListEmptyReasons (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .inboundRelationship[typeCode=SUBJ,code<ListEmptyReason].value[type=CD]
  • cda: n/a
sectionC0..*see (section)
There are no (further) constraints on this element
Element id
Composition.section:health_concerns_section.section
Short description

Nested Section

Definition

A nested sub-section within this section.

Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Conditions

The cardinality or value of this element may be affected by these constraints: cmp-1

Mappings
  • rim: ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda: .component.section

Table View

Composition..
Composition.type..
Composition.section3..
Composition.section:allergies_and_intolerances_section1..1
Composition.section:allergies_and_intolerances_section.title1..
Composition.section:allergies_and_intolerances_section.code1..
Composition.section:allergies_and_intolerances_section.text1..
Composition.section:allergies_and_intolerances_section.entry..
Composition.section:allergies_and_intolerances_section.entry:allergy_entryReference(AllergyIntoleranceEHR)0..*
Composition.section:hospital_course_section1..1
Composition.section:hospital_course_section.title1..
Composition.section:hospital_course_section.code1..
Composition.section:hospital_course_section.text1..
Composition.section:discharge_diagnosis_section1..1
Composition.section:discharge_diagnosis_section.title1..
Composition.section:discharge_diagnosis_section.code1..
Composition.section:discharge_diagnosis_section.text1..
Composition.section:discharge_diagnosis_section.entry..
Composition.section:discharge_diagnosis_section.entry:discharge_diagnosis_entryReference(ConditionEHR)0..*
Composition.section:plan_of_treatment_section0..1
Composition.section:plan_of_treatment_section.title1..
Composition.section:plan_of_treatment_section.code1..
Composition.section:plan_of_treatment_section.text1..
Composition.section:plan_of_treatment_section.entry..
Composition.section:plan_of_treatment_section.entry:sliceEntryReference(Appointment | Communication | CommunicationRequest | DeviceRequest | Goal | MedicationRequest | NutritionOrder | RequestGroup | Task | VisionPrescription | EncounterEHR | ServiceRequestEHR)0..*
Composition.section:discharge_medications_section0..1
Composition.section:discharge_medications_section.title1..
Composition.section:discharge_medications_section.code1..
Composition.section:discharge_medications_section.text1..
Composition.section:discharge_medications_section.entry..
Composition.section:discharge_medications_section.entry:discharge_medications_entryReference(Medication | MedicationRequest | MedicationStatement)0..*
Composition.section:admission_diagnosis_section0..1
Composition.section:admission_diagnosis_section.title1..
Composition.section:admission_diagnosis_section.code1..
Composition.section:admission_diagnosis_section.text1..
Composition.section:admission_diagnosis_section.entry..
Composition.section:admission_diagnosis_section.entry:admission_diagnosis_entryReference(ConditionEHR)0..*
Composition.section:admission_medications_section0..1
Composition.section:admission_medications_section.title1..
Composition.section:admission_medications_section.code1..
Composition.section:admission_medications_section.text1..
Composition.section:admission_medications_section.entry..
Composition.section:admission_medications_section.entry:admission_medications_entryReference(Medication | MedicationRequest | MedicationStatement)0..*
Composition.section:chief_complaint_and_reason_for_visit_section0..1
Composition.section:chief_complaint_and_reason_for_visit_section.title1..
Composition.section:chief_complaint_and_reason_for_visit_section.code1..
Composition.section:chief_complaint_and_reason_for_visit_section.text1..
Composition.section:chief_complaint_section0..1
Composition.section:chief_complaint_section.title1..
Composition.section:chief_complaint_section.code1..
Composition.section:chief_complaint_section.text1..
Composition.section:family_history_section0..1
Composition.section:family_history_section.title1..
Composition.section:family_history_section.code1..
Composition.section:family_history_section.text1..
Composition.section:family_history_section.entry..
Composition.section:family_history_section.entry:family_history_entryReference(FamilyMemberHistory)0..*
Composition.section:functional_status_section0..1
Composition.section:functional_status_section.title1..
Composition.section:functional_status_section.code1..
Composition.section:functional_status_section.text1..
Composition.section:functional_status_section.entry..
Composition.section:functional_status_section.entry:functional_status_entryReference(ClinicalImpression | Observation | ConditionEHR)0..*
Composition.section:history_of_present_illness_section0..1
Composition.section:history_of_present_illness_section.title1..
Composition.section:history_of_present_illness_section.code1..
Composition.section:history_of_present_illness_section.text1..
Composition.section:hospital_consultations_section0..1
Composition.section:hospital_consultations_section.title1..
Composition.section:hospital_consultations_section.code1..
Composition.section:hospital_consultations_section.text1..
Composition.section:hospital_discharge_instructions_section0..1
Composition.section:hospital_discharge_instructions_section.title1..
Composition.section:hospital_discharge_instructions_section.code1..
Composition.section:hospital_discharge_instructions_section.text1..
Composition.section:hospital_discharge_physical_section0..1
Composition.section:hospital_discharge_physical_section.title1..
Composition.section:hospital_discharge_physical_section.code1..
Composition.section:hospital_discharge_physical_section.text1..
Composition.section:hospital_discharge_studies_section0..1
Composition.section:hospital_discharge_studies_section.title1..
Composition.section:hospital_discharge_studies_section.code1..
Composition.section:hospital_discharge_studies_section.text1..
Composition.section:immunizations_section0..1
Composition.section:immunizations_section.title1..
Composition.section:immunizations_section.code1..
Composition.section:immunizations_section.text1..
Composition.section:immunizations_section.entry..
Composition.section:immunizations_section.entry:immunizations_entryReference(Immunization)0..*
Composition.section:nutrition_section0..1
Composition.section:nutrition_section.title1..
Composition.section:nutrition_section.code1..
Composition.section:nutrition_section.text1..
Composition.section:nutrition_section.entry..
Composition.section:nutrition_section.entry:nutrition_entryReference(Observation)0..*
Composition.section:past_medical_history_section0..1
Composition.section:past_medical_history_section.title1..
Composition.section:past_medical_history_section.code1..
Composition.section:past_medical_history_section.text1..
Composition.section:past_medical_history_section.entry..
Composition.section:past_medical_history_section.entry:past_medical_history_entryReference(ConditionEHR)0..*
Composition.section:problem_section0..1
Composition.section:problem_section.title1..
Composition.section:problem_section.code1..
Composition.section:problem_section.text1..
Composition.section:problem_section.entry..
Composition.section:problem_section.entry:problem_entryReference(ConditionEHR)0..*
Composition.section:procedures_section0..1
Composition.section:procedures_section.title1..
Composition.section:procedures_section.code1..
Composition.section:procedures_section.text1..
Composition.section:procedures_section.entry..
Composition.section:procedures_section.entry:procedure_entryReference(Procedure)0..*
Composition.section:reason_for_visit_section0..1
Composition.section:reason_for_visit_section.title1..
Composition.section:reason_for_visit_section.code1..
Composition.section:reason_for_visit_section.text1..
Composition.section:review_of_systems_section0..1
Composition.section:review_of_systems_section.title1..
Composition.section:review_of_systems_section.code1..
Composition.section:review_of_systems_section.text1..
Composition.section:social_history_section0..1
Composition.section:social_history_section.title1..
Composition.section:social_history_section.code1..
Composition.section:social_history_section.text1..
Composition.section:social_history_section.entry..
Composition.section:social_history_section.entry:smoking_status_entryReference(ObservationSmokingStatusOCRE)0..*
Composition.section:vital_signs_section0..1
Composition.section:vital_signs_section.title1..
Composition.section:vital_signs_section.code1..
Composition.section:vital_signs_section.text1..
Composition.section:vital_signs_section.entry..
Composition.section:vital_signs_section.entry:vital_signs_entryReference(observation-vitalsigns)0..*
Composition.section:goals_section0..1
Composition.section:goals_section.title1..
Composition.section:goals_section.code1..
Composition.section:goals_section.text1..
Composition.section:goals_section.entry..
Composition.section:goals_section.entry:goals_entryReference(Goal)0..*
Composition.section:health_concerns_section0..1
Composition.section:health_concerns_section.title1..
Composition.section:health_concerns_section.code1..
Composition.section:health_concerns_section.text1..
Composition.section:health_concerns_section.entry..
Composition.section:health_concerns_section.entry:health_concerns_entryReference(ClinicalImpression | DocumentReference | List | Observation | RiskAssessment | observation-vitalsigns | AllergyIntoleranceEHR | ConditionEHR)0..*

JSON View

{
"resourceType": "StructureDefinition",
"id": "profile-discharge-summary",
"url": "http://ontariohealth.ca/fhir/ocre/StructureDefinition/profile-discharge-summary",
"version": "1.0.0-Ballot",
"name": "DischargeSummaryOCRE",
"title": "Experimental OCRE Discharge Summary",
"status": "active",
"description": "The Discharge Summary is a document which synopsizes a patient's admission to a hospital, LTPAC provider, or other setting. It provides information for the continuation of care following discharge. The Joint Commission requires the following information to be included in the Discharge Summary (http://www.jointcommission.org/):\n\n The reason for hospitalization (the admission) \n\n The procedures performed, as applicable\n\n The care, treatment, and services provided\n\n The patients condition and disposition at discharge\n\n Information provided to the patient and family\n\n Provisions for follow-up care\n\nThe best practice for a Discharge Summary is to include the discharge disposition in the display of the header.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Composition",
"baseDefinition": "http://ontariohealth.ca/fhir/ocre/StructureDefinition/profile-header",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Composition.type",
"path": "Composition.type",
"label": "Discharge Summary",
"short": "Discharge Summary",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ocre/ValueSet/document-type-discharge"
}
},
{
"id": "Composition.section",
"path": "Composition.section",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "code"
}
],
"rules": "open"
},
"min": 3
},
{
"id": "Composition.section:allergies_and_intolerances_section",
"path": "Composition.section",
"sliceName": "allergies_and_intolerances_section",
"label": "Allergies and Intolerances Section",
"short": "Allergies and Intolerances Section",
"comment": "Allergies and Intolerances Section",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:allergies_and_intolerances_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:allergies_and_intolerances_section.code",
"path": "Composition.section.code",
"label": "Allergies and adverse reactions",
"short": "Allergies and adverse reactions",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "48765-2"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:allergies_and_intolerances_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:allergies_and_intolerances_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:allergies_and_intolerances_section.entry:allergy_entry",
"path": "Composition.section.entry",
"sliceName": "allergy_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-allergyIntolerance"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:hospital_course_section",
"path": "Composition.section",
"sliceName": "hospital_course_section",
"label": "Hospital Course Section",
"short": "Hospital Course Section",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:hospital_course_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_course_section.code",
"path": "Composition.section.code",
"short": "code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "8648-8"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:hospital_course_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:discharge_diagnosis_section",
"path": "Composition.section",
"sliceName": "discharge_diagnosis_section",
"label": "Discharge Diagnosis Section",
"short": "Discharge Diagnosis Section",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:discharge_diagnosis_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:discharge_diagnosis_section.code",
"path": "Composition.section.code",
"label": "Hospital discharge diagnosis",
"short": "Hospital discharge diagnosis",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "11535-2"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:discharge_diagnosis_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:discharge_diagnosis_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:discharge_diagnosis_section.entry:discharge_diagnosis_entry",
"path": "Composition.section.entry",
"sliceName": "discharge_diagnosis_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-condition"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:plan_of_treatment_section",
"path": "Composition.section",
"sliceName": "plan_of_treatment_section",
"label": "Plan of Treatment Section",
"short": "Plan of Treatment Section",
"comment": "Plan of Treatment Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:plan_of_treatment_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:plan_of_treatment_section.code",
"path": "Composition.section.code",
"label": "Plan of treatment",
"short": "Plan of treatment",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "18776-5"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:plan_of_treatment_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:plan_of_treatment_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:plan_of_treatment_section.entry:sliceEntry",
"path": "Composition.section.entry",
"sliceName": "sliceEntry",
"short": "This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Goal",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-encounter",
"http://hl7.org/fhir/StructureDefinition/Communication",
"http://hl7.org/fhir/StructureDefinition/Appointment",
"http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"http://hl7.org/fhir/StructureDefinition/DeviceRequest",
"http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"http://hl7.org/fhir/StructureDefinition/Task",
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-serviceRequest",
"http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"http://hl7.org/fhir/StructureDefinition/RequestGroup"
]
}
]
},
{
"id": "Composition.section:discharge_medications_section",
"path": "Composition.section",
"sliceName": "discharge_medications_section",
"label": "Discharge Medications Section",
"short": "Discharge Medications Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:discharge_medications_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:discharge_medications_section.code",
"path": "Composition.section.code",
"label": "Hospital discharge medications",
"short": "Hospital discharge medications",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "10183-2"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:discharge_medications_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:discharge_medications_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:discharge_medications_section.entry:discharge_medications_entry",
"path": "Composition.section.entry",
"sliceName": "discharge_medications_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:admission_diagnosis_section",
"path": "Composition.section",
"sliceName": "admission_diagnosis_section",
"label": "Admission Diagnosis Section",
"short": "Admission Diagnosis Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:admission_diagnosis_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:admission_diagnosis_section.code",
"path": "Composition.section.code",
"label": "Hospital admission diagnosis",
"short": "Hospital admission diagnosis",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "46241-6"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:admission_diagnosis_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:admission_diagnosis_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:admission_diagnosis_section.entry:admission_diagnosis_entry",
"path": "Composition.section.entry",
"sliceName": "admission_diagnosis_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-condition"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:admission_medications_section",
"path": "Composition.section",
"sliceName": "admission_medications_section",
"label": "Admission Medications Section",
"short": "Admission Medications Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:admission_medications_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:admission_medications_section.code",
"path": "Composition.section.code",
"label": "Medications on admission",
"short": "Medications on admission",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "42346-7"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:admission_medications_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:admission_medications_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:admission_medications_section.entry:admission_medications_entry",
"path": "Composition.section.entry",
"sliceName": "admission_medications_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/MedicationRequest"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_and_reason_for_visit_section",
"path": "Composition.section",
"sliceName": "chief_complaint_and_reason_for_visit_section",
"label": "Chief Complaint and Reason for Visit Section",
"short": "Chief Complaint and Reason for Visit Section. This section records the patient's chief complaint (the patient’s own description) and/or the reason for the patient's visit (the provider’s description of the reason for visit). Local policy determines whether the information is divided into two sections or recorded in one section serving both purposes.",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_and_reason_for_visit_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_and_reason_for_visit_section.code",
"path": "Composition.section.code",
"short": "code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "46239-0"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_and_reason_for_visit_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_section",
"path": "Composition.section",
"sliceName": "chief_complaint_section",
"label": "Chief Complaint Section",
"short": "Chief Complaint Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_section.code",
"path": "Composition.section.code",
"short": "code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "10154-3"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:chief_complaint_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:family_history_section",
"path": "Composition.section",
"sliceName": "family_history_section",
"label": "Family History Section",
"short": "Family History Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:family_history_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:family_history_section.code",
"path": "Composition.section.code",
"short": "code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "10157-6"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:family_history_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:family_history_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:family_history_section.entry:family_history_entry",
"path": "Composition.section.entry",
"sliceName": "family_history_entry",
"short": "This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:functional_status_section",
"path": "Composition.section",
"sliceName": "functional_status_section",
"label": "Functional Status Section",
"short": "Functional Status Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:functional_status_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:functional_status_section.code",
"path": "Composition.section.code",
"label": "Functional status",
"short": "Functional status",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "47420-5"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:functional_status_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:functional_status_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:functional_status_section.entry:functional_status_entry",
"path": "Composition.section.entry",
"sliceName": "functional_status_entry",
"short": "This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-condition",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/ClinicalImpression"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:history_of_present_illness_section",
"path": "Composition.section",
"sliceName": "history_of_present_illness_section",
"label": "History of Present Illness Section",
"short": "History of Present Illness Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:history_of_present_illness_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:history_of_present_illness_section.code",
"path": "Composition.section.code",
"short": "code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "10164-2"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:history_of_present_illness_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_consultations_section",
"path": "Composition.section",
"sliceName": "hospital_consultations_section",
"label": "Hospital Consultations Section",
"short": "Hospital Consultations Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:hospital_consultations_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_consultations_section.code",
"path": "Composition.section.code",
"label": "Hospital consultations",
"short": "Hospital consultations",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "18841-7"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:hospital_consultations_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_instructions_section",
"path": "Composition.section",
"sliceName": "hospital_discharge_instructions_section",
"label": "Hospital Discharge Instructions Section",
"short": "Hospital Discharge Instructions Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_instructions_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_instructions_section.code",
"path": "Composition.section.code",
"label": "Hospital discharge instructions",
"short": "Hospital discharge instructions",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "8653-8"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_instructions_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_physical_section",
"path": "Composition.section",
"sliceName": "hospital_discharge_physical_section",
"label": "Hospital Discharge Physical Section",
"short": "Hospital Discharge Physical Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_physical_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_physical_section.code",
"path": "Composition.section.code",
"label": "Hospital discharge physical",
"short": "Hospital discharge physical",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "10184-0"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_physical_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_studies_section",
"path": "Composition.section",
"sliceName": "hospital_discharge_studies_section",
"label": "Hospital Discharge Studies Section",
"short": "Hospital Discharge Studies Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_studies_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_studies_section.code",
"path": "Composition.section.code",
"label": "Hospital discharge studies summary",
"short": "Hospital discharge studies summary",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "11493-4"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:hospital_discharge_studies_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:immunizations_section",
"path": "Composition.section",
"sliceName": "immunizations_section",
"label": "Immunizations Section",
"short": "Immunizations Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:immunizations_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:immunizations_section.code",
"path": "Composition.section.code",
"label": "Immunizations",
"short": "Immunizations",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "11369-6"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:immunizations_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:immunizations_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:immunizations_section.entry:immunizations_entry",
"path": "Composition.section.entry",
"sliceName": "immunizations_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Immunization"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:nutrition_section",
"path": "Composition.section",
"sliceName": "nutrition_section",
"label": "Nutrition Section",
"short": "Nutrition Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:nutrition_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:nutrition_section.code",
"path": "Composition.section.code",
"label": "Diet and nutrition",
"short": "Diet and nutrition",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "61144-2"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:nutrition_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:nutrition_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:nutrition_section.entry:nutrition_entry",
"path": "Composition.section.entry",
"sliceName": "nutrition_entry",
"short": "This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Observation"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:past_medical_history_section",
"path": "Composition.section",
"sliceName": "past_medical_history_section",
"label": "Past Medical History Section",
"short": "Past Medical History Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:past_medical_history_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:past_medical_history_section.code",
"path": "Composition.section.code",
"short": "code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "11348-0"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:past_medical_history_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:past_medical_history_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:past_medical_history_section.entry:past_medical_history_entry",
"path": "Composition.section.entry",
"sliceName": "past_medical_history_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-condition"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:problem_section",
"path": "Composition.section",
"sliceName": "problem_section",
"label": "Problem Section",
"short": "Problem Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:problem_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:problem_section.code",
"path": "Composition.section.code",
"label": "Problem list",
"short": "Problem list",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "11450-4"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:problem_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:problem_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:problem_section.entry:problem_entry",
"path": "Composition.section.entry",
"sliceName": "problem_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-condition"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:procedures_section",
"path": "Composition.section",
"sliceName": "procedures_section",
"label": "Procedures Section",
"short": "Procedures Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:procedures_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:procedures_section.code",
"path": "Composition.section.code",
"label": "History of procedures",
"short": "History of procedures",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "47519-4"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:procedures_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:procedures_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:procedures_section.entry:procedure_entry",
"path": "Composition.section.entry",
"sliceName": "procedure_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Procedure"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:reason_for_visit_section",
"path": "Composition.section",
"sliceName": "reason_for_visit_section",
"label": "Reason for Visit Section",
"short": "Reason for Visit Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:reason_for_visit_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:reason_for_visit_section.code",
"path": "Composition.section.code",
"short": "code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "29299-5"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:reason_for_visit_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:review_of_systems_section",
"path": "Composition.section",
"sliceName": "review_of_systems_section",
"label": "Review of Systems Section",
"short": "Review of Systems Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:review_of_systems_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:review_of_systems_section.code",
"path": "Composition.section.code",
"label": "Review of systems",
"short": "Review of systems",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "10187-3"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:review_of_systems_section.text",
"path": "Composition.section.text",
"short": "This section contains only human readable content",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:social_history_section",
"path": "Composition.section",
"sliceName": "social_history_section",
"label": "Social History Section",
"short": "Social History Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:social_history_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:social_history_section.code",
"path": "Composition.section.code",
"label": "Social history",
"short": "Social history",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "29762-2"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:social_history_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:social_history_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:social_history_section.entry:smoking_status_entry",
"path": "Composition.section.entry",
"sliceName": "smoking_status_entry",
"short": "Smoking status",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ocre/StructureDefinition/profile-observation-smokingstatus"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:vital_signs_section",
"path": "Composition.section",
"sliceName": "vital_signs_section",
"label": "Vital Signs Section",
"short": "Vital Signs Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:vital_signs_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:vital_signs_section.code",
"path": "Composition.section.code",
"label": "Vital signs",
"short": "Vital signs",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "8716-3"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:vital_signs_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:vital_signs_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:vital_signs_section.entry:vital_signs_entry",
"path": "Composition.section.entry",
"sliceName": "vital_signs_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:goals_section",
"path": "Composition.section",
"sliceName": "goals_section",
"short": "Goals Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:goals_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:goals_section.code",
"path": "Composition.section.code",
"short": "Goals",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "61146-7"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:goals_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:goals_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:goals_section.entry:goals_entry",
"path": "Composition.section.entry",
"sliceName": "goals_entry",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Goal"
]
}
],
"mustSupport": true
},
{
"id": "Composition.section:health_concerns_section",
"path": "Composition.section",
"sliceName": "health_concerns_section",
"short": "Health Concerns Section",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"id": "Composition.section:health_concerns_section.title",
"path": "Composition.section.title",
"short": "title",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:health_concerns_section.code",
"path": "Composition.section.code",
"short": "Health concerns section code",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://loinc.org",
"code": "75310-3"
}
]
},
"mustSupport": true
},
{
"id": "Composition.section:health_concerns_section.text",
"path": "Composition.section.text",
"short": "text",
"min": 1,
"mustSupport": true
},
{
"id": "Composition.section:health_concerns_section.entry",
"path": "Composition.section.entry",
"slicing": {
"discriminator": [
{
"type": "profile",
"path": "resolve()"
}
],
"rules": "open"
},
"short": "entry"
},
{
"id": "Composition.section:health_concerns_section.entry:health_concerns_entry",
"path": "Composition.section.entry",
"sliceName": "health_concerns_entry",
"short": "This section contains unprofiled resources not covered by US Core. Please refer to C-CDA R2.1 for guidance on terminology, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-allergyIntolerance",
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-condition",
"http://hl7.org/fhir/StructureDefinition/vitalsigns",
"http://hl7.org/fhir/StructureDefinition/ClinicalImpression",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/RiskAssessment",
"http://hl7.org/fhir/StructureDefinition/List",
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
],
"mustSupport": true
}
]
}
}

4.2.27.3. Notes


4.2.27.4. Terminology Bindings


Version: 1.0.0 FHIR Version: R4.0.1

Powered by SIMPLIFIER.NET

HL7® and FHIR® are the registered trademarks of Health Level Seven International