Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Composition_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Composition Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Composition_R4

This cross-version profile allows R5 Composition content to be represented via FHIR R4 Composition resources.

Usages:

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(4.0.1) 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
Constraints: ext-1
.... extension:url 0..1 uri R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the Composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
.... extension:useContext 0..* UsageContext R5: The context that the content is intended to support (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.useContext
Constraints: ext-1
.... extension:name 0..1 string R5: Name for this Composition (computer friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.name
Constraints: ext-1
.... extension:note 0..* Annotation R5: For any additional notes (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.note
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.status
Binding: R5CompositionStatusForR4 (0.1.0) (required): The workflow/clinical status of the composition.
Constraints: ext-1
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus . 📍4.0.1 tx.fhir.org
Composition.type Base preferred FHIR Document Type Codes 📍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 Composition.implicitRules, Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.status, Composition.status.extension, Composition.status.extension:status, Composition.type, Composition.date, Composition.author, Composition.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.status.extension, Composition.status.extension:status 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(4.0.1) 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:url 0..1 uri R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.url
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the Composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
.... extension:useContext 0..* UsageContext R5: The context that the content is intended to support (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.useContext
.... extension:name 0..1 string R5: Name for this Composition (computer friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.name
.... extension:note 0..* Annotation R5: For any additional notes (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.note
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.status
Binding: R5CompositionStatusForR4 (0.1.0) (required): The workflow/clinical status of the composition.
... attester
.... mode
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:mode 0..1 CodeableConcept R5: mode additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition(4.0.1) 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
Constraints: ext-1
.... extension:url 0..1 uri R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the Composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
.... extension:useContext 0..* UsageContext R5: The context that the content is intended to support (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.useContext
Constraints: ext-1
.... extension:name 0..1 string R5: Name for this Composition (computer friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.name
Constraints: ext-1
.... extension:note 0..* Annotation R5: For any additional notes (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.note
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus . (required): The workflow/clinical status of the composition.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.status
Binding: R5CompositionStatusForR4 (0.1.0) (required): The workflow/clinical status of the composition.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Resource) 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 | PractitionerRole | Device | Patient | RelatedPerson | Organization) 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.
... attester 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:mode 0..1 CodeableConcept R5: mode additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 0..1 Reference(Organization) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: ActCode (3.0.0) (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
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... title 0..1 string Label for section (e.g. for ToC)
.... code 0..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 0..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 Why the section is empty
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 tx.fhir.org
Composition.status Base required CompositionStatus . 📍4.0.1 tx.fhir.org
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.relatesTo.​code Base required DocumentRelationshipType . 📍4.0.1 tx.fhir.org
Composition.event.code Base example v3 Code System ActCode 📍3.0.0 THO v7.1
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 Composition.meta, Composition.implicitRules, Composition.language, Composition.text, Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.identifier, Composition.status, Composition.status.extension, Composition.status.extension:status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.author, Composition.title, Composition.confidentiality, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.attester.time, Composition.attester.party, Composition.custodian, Composition.relatesTo, Composition.relatesTo.extension, Composition.relatesTo.modifierExtension, Composition.relatesTo.code, Composition.relatesTo.target[x], Composition.event, Composition.event.extension, Composition.event.modifierExtension, Composition.event.code, Composition.event.period, Composition.event.detail, Composition.section, Composition.section.extension, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, Composition.section.mode, Composition.section.orderedBy, Composition.section.entry, Composition.section.emptyReason, Composition.section.section All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.status.extension, Composition.status.extension:status, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.relatesTo.extension, Composition.relatesTo.modifierExtension, Composition.event.extension, Composition.event.modifierExtension, Composition.section.extension, Composition.section.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition(4.0.1) 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
Constraints: ext-1
.... extension:url 0..1 uri R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the Composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
.... extension:useContext 0..* UsageContext R5: The context that the content is intended to support (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.useContext
Constraints: ext-1
.... extension:name 0..1 string R5: Name for this Composition (computer friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.name
Constraints: ext-1
.... extension:note 0..* Annotation R5: For any additional notes (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.note
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.status
Binding: R5CompositionStatusForR4 (0.1.0) (required): The workflow/clinical status of the composition.
Constraints: ext-1
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus . 📍4.0.1 tx.fhir.org
Composition.type Base preferred FHIR Document Type Codes 📍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 Composition.implicitRules, Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.status, Composition.status.extension, Composition.status.extension:status, Composition.type, Composition.date, Composition.author, Composition.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.status.extension, Composition.status.extension:status 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(4.0.1) 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:url 0..1 uri R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.url
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the Composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
.... extension:useContext 0..* UsageContext R5: The context that the content is intended to support (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.useContext
.... extension:name 0..1 string R5: Name for this Composition (computer friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.name
.... extension:note 0..* Annotation R5: For any additional notes (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.note
... status
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:status 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.status
Binding: R5CompositionStatusForR4 (0.1.0) (required): The workflow/clinical status of the composition.
... attester
.... mode
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:mode 0..1 CodeableConcept R5: mode additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition(4.0.1) 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
Constraints: ext-1
.... extension:url 0..1 uri R5: Canonical identifier for this Composition, represented as a URI (globally unique) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.url
Constraints: ext-1
.... extension:version 0..1 string R5: An explicitly assigned identifer of a variation of the content in the Composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.version
Constraints: ext-1
.... extension:useContext 0..* UsageContext R5: The context that the content is intended to support (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.useContext
Constraints: ext-1
.... extension:name 0..1 string R5: Name for this Composition (computer friendly) (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.name
Constraints: ext-1
.... extension:note 0..* Annotation R5: For any additional notes (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.note
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..1 Identifier Version-independent identifier for the Composition
... status ?!Σ 1..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus . (required): The workflow/clinical status of the composition.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:status 0..1 code R5: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.status
Binding: R5CompositionStatusForR4 (0.1.0) (required): The workflow/clinical status of the composition.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..1 Reference(Resource) 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 | PractitionerRole | Device | Patient | RelatedPerson | Organization) 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.
... attester 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... mode 1..1 code personal | professional | legal | official
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:mode 0..1 CodeableConcept R5: mode additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
Constraints: ext-1
..... value 0..1 string Primitive value for code
.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 0..1 Reference(Organization) 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
Binding: ActCode (3.0.0) (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
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... title 0..1 string Label for section (e.g. for ToC)
.... code 0..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 0..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 Why the section is empty
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 tx.fhir.org
Composition.status Base required CompositionStatus . 📍4.0.1 tx.fhir.org
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.relatesTo.​code Base required DocumentRelationshipType . 📍4.0.1 tx.fhir.org
Composition.event.code Base example v3 Code System ActCode 📍3.0.0 THO v7.1
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 Composition.meta, Composition.implicitRules, Composition.language, Composition.text, Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.identifier, Composition.status, Composition.status.extension, Composition.status.extension:status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.author, Composition.title, Composition.confidentiality, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.attester.time, Composition.attester.party, Composition.custodian, Composition.relatesTo, Composition.relatesTo.extension, Composition.relatesTo.modifierExtension, Composition.relatesTo.code, Composition.relatesTo.target[x], Composition.event, Composition.event.extension, Composition.event.modifierExtension, Composition.event.code, Composition.event.period, Composition.event.detail, Composition.section, Composition.section.extension, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, Composition.section.mode, Composition.section.orderedBy, Composition.section.entry, Composition.section.emptyReason, Composition.section.section All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Composition.extension, Composition.extension:url, Composition.extension:version, Composition.extension:useContext, Composition.extension:name, Composition.extension:note, Composition.modifierExtension, Composition.status.extension, Composition.status.extension:status, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.relatesTo.extension, Composition.relatesTo.modifierExtension, Composition.event.extension, Composition.event.modifierExtension, Composition.section.extension, Composition.section.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron