HL7 Europe Base and Core FHIR IG
0.2.0-ci-build - ci-build 150

HL7 Europe Base and Core FHIR IG, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base/ and changes regularly. See the Directory of published versions

Resource Profile: Composition (EU core) [WIP]

Official URL: http://hl7.eu/fhir/base/StructureDefinition/composition-eu-core Version: 0.2.0-ci-build
Draft as of 2025-11-21 Computable Name: CompositionEuCore

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile sets minimum expectations for the Composition resource for commonly used EHDS documents.

This profile constrains the Composition resource for the purpose of this guide.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 (Complex) An explicitly assigned identifer of a variation of the content in the Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version"
.... extension:basedOnOrder 0..* (Complex) Composition: Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueIdentifier Identifier
...... valueReference Reference(ServiceRequest)
...... value[x]:valueReference 0..1 Reference(ServiceRequest) Value of extension
.... extension:informationRecipient 0..* (Complex) Composition: Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
..... value[x] 0..1 Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Value of extension
.... extension:diagnosticReport 0..1 Reference(DiagnosticReport) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference
.... extension:basedOn 0..* Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Type of document/report (e.g. imaging report LOINC)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Document Category
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Patient (EU core) | Group | Location (EU core) | Device) Who and/or what the composition is about
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... Slices for attester 0..* BackboneElement Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
..... party 0..1 Reference(Patient (EU core) | RelatedPerson | Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core)) Who attested the composition
.... attester:legalAuthenticator 0..* BackboneElement Attests to accuracy of composition
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: legal
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
.... attester:resultValidator 0..* BackboneElement Attests to accuracy of composition
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: professional
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
... custodian Σ 0..1 Reference(Organization (EU core)) Organization which maintains the composition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:legalAuthenticator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:resultValidator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 (Complex) An explicitly assigned identifer of a variation of the content in the Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
..... extension 0..0 Extension
.... extension:basedOnOrder 0..* (Complex) Composition: Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... Slices for value[x] 0..1 Identifier, Reference(ServiceRequest) Value of extension
Slice: Unordered, Open by type:$this
...... value[x]:valueReference 0..1 Reference(ServiceRequest) Value of extension
.... extension:informationRecipient 0..* (Complex) Composition: Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... value[x] 0..1 Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Value of extension
.... extension:diagnosticReport 0..1 Reference(DiagnosticReport) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference
.... extension:basedOn 0..* Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
... identifier 1..1 Identifier Report identifier
... type 1..1 CodeableConcept Type of document/report (e.g. imaging report LOINC)
... subject 1..1 Reference(Patient (EU core) | Group | Location (EU core) | Device) Who and/or what the composition is about
... author 1..* Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Who and/or what authored the composition
... Slices for attester 0..* BackboneElement Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... party 0..1 Reference(Patient (EU core) | RelatedPerson | Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core)) Who attested the composition
.... attester:legalAuthenticator 0..* BackboneElement Attests to accuracy of composition
..... mode 1..1 code personal | professional | legal | official
Required Pattern: legal
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
.... attester:resultValidator 0..* BackboneElement Attests to accuracy of composition
..... mode 1..1 code personal | professional | legal | official
Required Pattern: professional
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
... custodian 0..1 Reference(Organization (EU core)) Organization which maintains the composition
... section
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:section-note 0..* Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
.... title 1..1 string Label for section (e.g. for ToC)
.... code 1..1 CodeableConcept Classification of section (recommended)
.... text 1..1 Narrative Text summary of the section, for human interpretation
.... emptyReason 0..1 CodeableConcept Empty reason

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 (Complex) An explicitly assigned identifer of a variation of the content in the Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version"
..... value[x] 0..1 string An explicitly assigned identifer of a variation of the content in the Composition
.... extension:basedOnOrder 0..* (Complex) Composition: Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueIdentifier Identifier
...... valueReference Reference(ServiceRequest)
...... value[x]:valueReference 0..1 Reference(ServiceRequest) Value of extension
.... extension:informationRecipient 0..* (Complex) Composition: Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
..... value[x] 0..1 Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Value of extension
.... extension:diagnosticReport 0..1 Reference(DiagnosticReport) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference
.... extension:basedOn 0..* Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Report identifier
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Type of document/report (e.g. imaging report LOINC)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Document Category
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Patient (EU core) | Group | Location (EU core) | Device) Who and/or what the composition is about
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
... Slices for attester 0..* BackboneElement Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
..... time 0..1 dateTime When the composition was attested
..... party 0..1 Reference(Patient (EU core) | RelatedPerson | Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core)) Who attested the composition
.... attester:legalAuthenticator 0..* BackboneElement Attests to accuracy of composition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: legal
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
.... attester:resultValidator 0..* BackboneElement Attests to accuracy of composition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: professional
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
... custodian Σ 0..1 Reference(Organization (EU core)) Organization which maintains the composition
... relatesTo 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... section C 0..* BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:section-note 0..* Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 1..1 string Label for section (e.g. for ToC)
.... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
.... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
.... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
.... text C 1..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
.... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
.... entry C 0..* Reference(Resource) A reference to data that supports this section
.... emptyReason C 0..1 CodeableConcept Empty reason
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:legalAuthenticator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:resultValidator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v7.0
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 (Complex) An explicitly assigned identifer of a variation of the content in the Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version"
.... extension:basedOnOrder 0..* (Complex) Composition: Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueIdentifier Identifier
...... valueReference Reference(ServiceRequest)
...... value[x]:valueReference 0..1 Reference(ServiceRequest) Value of extension
.... extension:informationRecipient 0..* (Complex) Composition: Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
..... value[x] 0..1 Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Value of extension
.... extension:diagnosticReport 0..1 Reference(DiagnosticReport) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference
.... extension:basedOn 0..* Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Type of document/report (e.g. imaging report LOINC)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Document Category
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Patient (EU core) | Group | Location (EU core) | Device) Who and/or what the composition is about
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... Slices for attester 0..* BackboneElement Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
..... party 0..1 Reference(Patient (EU core) | RelatedPerson | Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core)) Who attested the composition
.... attester:legalAuthenticator 0..* BackboneElement Attests to accuracy of composition
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: legal
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
.... attester:resultValidator 0..* BackboneElement Attests to accuracy of composition
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: professional
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
... custodian Σ 0..1 Reference(Organization (EU core)) Organization which maintains the composition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:legalAuthenticator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:resultValidator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 (Complex) An explicitly assigned identifer of a variation of the content in the Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
..... extension 0..0 Extension
.... extension:basedOnOrder 0..* (Complex) Composition: Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... Slices for value[x] 0..1 Identifier, Reference(ServiceRequest) Value of extension
Slice: Unordered, Open by type:$this
...... value[x]:valueReference 0..1 Reference(ServiceRequest) Value of extension
.... extension:informationRecipient 0..* (Complex) Composition: Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... value[x] 0..1 Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Value of extension
.... extension:diagnosticReport 0..1 Reference(DiagnosticReport) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference
.... extension:basedOn 0..* Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
... identifier 1..1 Identifier Report identifier
... type 1..1 CodeableConcept Type of document/report (e.g. imaging report LOINC)
... subject 1..1 Reference(Patient (EU core) | Group | Location (EU core) | Device) Who and/or what the composition is about
... author 1..* Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Who and/or what authored the composition
... Slices for attester 0..* BackboneElement Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... party 0..1 Reference(Patient (EU core) | RelatedPerson | Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core)) Who attested the composition
.... attester:legalAuthenticator 0..* BackboneElement Attests to accuracy of composition
..... mode 1..1 code personal | professional | legal | official
Required Pattern: legal
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
.... attester:resultValidator 0..* BackboneElement Attests to accuracy of composition
..... mode 1..1 code personal | professional | legal | official
Required Pattern: professional
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
... custodian 0..1 Reference(Organization (EU core)) Organization which maintains the composition
... section
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:section-note 0..* Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
.... title 1..1 string Label for section (e.g. for ToC)
.... code 1..1 CodeableConcept Classification of section (recommended)
.... text 1..1 Narrative Text summary of the section, for human interpretation
.... emptyReason 0..1 CodeableConcept Empty reason

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:version 0..1 (Complex) An explicitly assigned identifer of a variation of the content in the Composition
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version"
..... value[x] 0..1 string An explicitly assigned identifer of a variation of the content in the Composition
.... extension:basedOnOrder 0..* (Complex) Composition: Based On Order
URL: http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition"
..... Slices for value[x] 0..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueIdentifier Identifier
...... valueReference Reference(ServiceRequest)
...... value[x]:valueReference 0..1 Reference(ServiceRequest) Value of extension
.... extension:informationRecipient 0..* (Complex) Composition: Information recipient
URL: http://hl7.eu/fhir/StructureDefinition/information-recipient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.eu/fhir/StructureDefinition/information-recipient"
..... value[x] 0..1 Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Value of extension
.... extension:diagnosticReport 0..1 Reference(DiagnosticReport) Document DiagnosticReport Reference
URL: http://hl7.eu/fhir/extensions/StructureDefinition/composition-diagnosticReportReference
.... extension:basedOn 0..* Reference(Resource) Fulfills plan, proposal or order
URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 Identifier Report identifier
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Type of document/report (e.g. imaging report LOINC)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Document Category
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Patient (EU core) | Group | Location (EU core) | Device) Who and/or what the composition is about
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core) | Device | Patient (EU core) | RelatedPerson) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... confidentiality Σ 0..1 code As defined by affinity domain
Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
... Slices for attester 0..* BackboneElement Attests to accuracy of composition
Slice: Unordered, Open by value:mode
.... attester:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
..... time 0..1 dateTime When the composition was attested
..... party 0..1 Reference(Patient (EU core) | RelatedPerson | Practitioner (EU core) | PractitionerRole (EU core) | Organization (EU core)) Who attested the composition
.... attester:legalAuthenticator 0..* BackboneElement Attests to accuracy of composition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: legal
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
.... attester:resultValidator 0..* BackboneElement Attests to accuracy of composition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Required Pattern: professional
..... time 1..1 dateTime When the composition was attested
..... party 0..1 Reference(PractitionerRole (EU core) | Practitioner (EU core)) Who attested the composition
... custodian Σ 0..1 Reference(Organization (EU core)) Organization which maintains the composition
... relatesTo 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target[x] 1..1 Target of the relationship
..... targetIdentifier Identifier
..... targetReference Reference(Composition)
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* Reference(Resource) The event(s) being documented
... section C 0..* BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:section-note 0..* Annotation Additional notes that apply to the section (but not to specific resource).
URL: http://hl7.org/fhir/StructureDefinition/note
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 1..1 string Label for section (e.g. for ToC)
.... code 1..1 CodeableConcept Classification of section (recommended)
Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
.... author 0..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
.... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
.... text C 1..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... mode 0..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this section.
.... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
.... entry C 0..* Reference(Resource) A reference to data that supports this section
.... emptyReason C 0..1 CodeableConcept Empty reason
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section C 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Composition.status Base required CompositionStatus 📍4.0.1 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍4.0.1 FHIR Std.
Composition.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
Composition.confidentiality Base required V3 Value SetConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:legalAuthenticator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.attester:resultValidator.​mode Base required CompositionAttestationMode 📍4.0.1 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
Composition.event.code Base example v3 Code System ActCode 📦3.0.0 THO v7.0
Composition.section.​code Base example Document Section Codes 📍4.0.1 FHIR Std.
Composition.section.​mode Base required ListMode 📍4.0.1 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍4.0.1 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section A section must contain at least one of text, entries, or sub-sections text.exists() or entry.exists() or section.exists()
cmp-2 error Composition.section A section can only have an emptyReason if it is empty emptyReason.empty() or entry.empty()
dom-2 error Composition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Composition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron