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

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

Resource Profile: Profile_R4B_Composition_R5

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

This cross-version profile allows R4B Composition content to be represented via FHIR R5 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(5.0.0) 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:confidentiality 0..1 code ​R4B: As defined by affinity domain (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.confidentiality
Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition.
Constraints: ext-1
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... 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 Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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:confidentiality, Composition.modifierExtension, Composition.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:confidentiality, Composition.modifierExtension 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(5.0.0) 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:confidentiality 0..1 code ​R4B: As defined by affinity domain (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.confidentiality
Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition.
... attester
.... mode
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:mode 0..1 code R4B: mode
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
... relatesTo
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 code R4B: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.code
Binding: DocumentRelationshipType (required): The type of relationship between documents.
..... extension:target 1..1 Identifier, Reference(Cross-version Profile for R4B.Composition for use in FHIR R5(0.1.0) | Composition) R4B: Target of the relationship (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 0..* CodeableConcept ​R4B: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.event.code
Binding: http://terminology.hl7.org/ValueSet/v3-ActCode|2.0.0 (example): This list of codes represents the main clinical acts being documented.
... section
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:mode 0..1 code R4B: working | snapshot | changes (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition(5.0.0) 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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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:confidentiality 0..1 code ​R4B: As defined by affinity domain (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.confidentiality
Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition.
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Version-independent identifier for the Composition
... version Σ 0..1 string An explicitly assigned identifer of a variation of the content in the Composition
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..* 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
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... name Σ 0..1 string Name for this Composition (computer friendly)
... title Σ 1..1 string Human Readable name/title
... note 0..* Annotation For any additional notes
... 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 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:mode 1..1 code R4B: mode
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Constraints: ext-1
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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..* RelatedArtifact Relationships to other compositions/documents
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 code R4B: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.code
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Constraints: ext-1
..... extension:target 1..1 Identifier, Reference(Cross-version Profile for R4B.Composition for use in FHIR R5(0.1.0) | Composition) R4B: Target of the relationship (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.target
Constraints: ext-1
.... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
.... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
.... label Σ 0..1 string Short label
.... display Σ 0..1 string Brief description of the related artifact
.... citation Σ 0..1 markdown Bibliographic citation for the artifact
.... document Σ 0..1 Attachment What document is being referenced
.... resource Σ 0..1 canonical(Resource) What artifact is being referenced
.... resourceReference Σ 0..1 Reference(Resource) What artifact, if not a conformance resource
.... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.
.... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 0..* CodeableConcept ​R4B: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.event.code
Binding: http://terminology.hl7.org/ValueSet/v3-ActCode|2.0.0 (example): This list of codes represents the main clinical acts being documented.
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* CodeableReference(Resource) The event(s) being documented, as code(s), reference(s), or both
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts 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
Constraints: ext-1
..... extension:mode 0..1 code R4B: working | snapshot | changes (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.
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
.... 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 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base required All Languages 📍5.0.0 FHIR Std.
Composition.status Base required Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
Composition.category Base example Referenced Item Category Value Set 📍5.0.0 FHIR Std.
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
Composition.relatesTo.​type Base required RelatedArtifactType 📍5.0.0 FHIR Std.
Composition.relatesTo.​classifier Base example Citation Artifact Classifier 📍5.0.0 FHIR Std.
Composition.relatesTo.​publicationStatus Base required PublicationStatus 📍5.0.0 FHIR Std.
Composition.event.detail Base example v3 Code System ActCode 📍3.0.0 THO v7.1
Composition.section.​code Base example Document Section Codes 📍5.0.0 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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:confidentiality, Composition.modifierExtension, Composition.url, Composition.identifier, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.useContext, Composition.author, Composition.name, Composition.title, Composition.note, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.attester.mode.coding, Composition.attester.mode.text, Composition.attester.time, Composition.attester.party, Composition.custodian, Composition.relatesTo, Composition.relatesTo.extension, Composition.relatesTo.extension:code, Composition.relatesTo.extension:target, Composition.relatesTo.type, Composition.relatesTo.classifier, Composition.relatesTo.label, Composition.relatesTo.display, Composition.relatesTo.citation, Composition.relatesTo.document, Composition.relatesTo.resource, Composition.relatesTo.resourceReference, Composition.relatesTo.publicationStatus, Composition.relatesTo.publicationDate, Composition.event, Composition.event.extension, Composition.event.extension:code, Composition.event.modifierExtension, Composition.event.period, Composition.event.detail, Composition.section, Composition.section.extension, Composition.section.extension:mode, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, 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:confidentiality, Composition.modifierExtension, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.relatesTo.extension, Composition.relatesTo.extension:code, Composition.relatesTo.extension:target, Composition.event.extension, Composition.event.extension:code, Composition.event.modifierExtension, Composition.section.extension, Composition.section.extension:mode, 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(5.0.0) 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:confidentiality 0..1 code ​R4B: As defined by affinity domain (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.confidentiality
Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition.
Constraints: ext-1
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... 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 Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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:confidentiality, Composition.modifierExtension, Composition.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:confidentiality, Composition.modifierExtension 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(5.0.0) 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:confidentiality 0..1 code ​R4B: As defined by affinity domain (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.confidentiality
Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition.
... attester
.... mode
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:mode 0..1 code R4B: mode
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
... relatesTo
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 code R4B: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.code
Binding: DocumentRelationshipType (required): The type of relationship between documents.
..... extension:target 1..1 Identifier, Reference(Cross-version Profile for R4B.Composition for use in FHIR R5(0.1.0) | Composition) R4B: Target of the relationship (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 0..* CodeableConcept ​R4B: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.event.code
Binding: http://terminology.hl7.org/ValueSet/v3-ActCode|2.0.0 (example): This list of codes represents the main clinical acts being documented.
... section
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:mode 0..1 code R4B: working | snapshot | changes (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition(5.0.0) 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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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:confidentiality 0..1 code ​R4B: As defined by affinity domain (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.confidentiality
Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition.
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Version-independent identifier for the Composition
... version Σ 0..1 string An explicitly assigned identifer of a variation of the content in the Composition
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..* 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
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... name Σ 0..1 string Name for this Composition (computer friendly)
... title Σ 1..1 string Human Readable name/title
... note 0..* Annotation For any additional notes
... 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 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a composition.
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:mode 1..1 code R4B: mode
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
Constraints: ext-1
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
.... 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..* RelatedArtifact Relationships to other compositions/documents
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 code R4B: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.code
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Constraints: ext-1
..... extension:target 1..1 Identifier, Reference(Cross-version Profile for R4B.Composition for use in FHIR R5(0.1.0) | Composition) R4B: Target of the relationship (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.relatesTo.target
Constraints: ext-1
.... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
.... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
.... label Σ 0..1 string Short label
.... display Σ 0..1 string Brief description of the related artifact
.... citation Σ 0..1 markdown Bibliographic citation for the artifact
.... document Σ 0..1 Attachment What document is being referenced
.... resource Σ 0..1 canonical(Resource) What artifact is being referenced
.... resourceReference Σ 0..1 Reference(Resource) What artifact, if not a conformance resource
.... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.
.... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 0..* CodeableConcept ​R4B: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.event.code
Binding: http://terminology.hl7.org/ValueSet/v3-ActCode|2.0.0 (example): This list of codes represents the main clinical acts being documented.
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* CodeableReference(Resource) The event(s) being documented, as code(s), reference(s), or both
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts 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
Constraints: ext-1
..... extension:mode 0..1 code R4B: working | snapshot | changes (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.
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
.... 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 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base required All Languages 📍5.0.0 FHIR Std.
Composition.status Base required Composition Status 📍5.0.0 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
Composition.category Base example Referenced Item Category Value Set 📍5.0.0 FHIR Std.
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
Composition.relatesTo.​type Base required RelatedArtifactType 📍5.0.0 FHIR Std.
Composition.relatesTo.​classifier Base example Citation Artifact Classifier 📍5.0.0 FHIR Std.
Composition.relatesTo.​publicationStatus Base required PublicationStatus 📍5.0.0 FHIR Std.
Composition.event.detail Base example v3 Code System ActCode 📍3.0.0 THO v7.1
Composition.section.​code Base example Document Section Codes 📍5.0.0 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 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:confidentiality, Composition.modifierExtension, Composition.url, Composition.identifier, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.encounter, Composition.date, Composition.useContext, Composition.author, Composition.name, Composition.title, Composition.note, Composition.attester, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.attester.mode.coding, Composition.attester.mode.text, Composition.attester.time, Composition.attester.party, Composition.custodian, Composition.relatesTo, Composition.relatesTo.extension, Composition.relatesTo.extension:code, Composition.relatesTo.extension:target, Composition.relatesTo.type, Composition.relatesTo.classifier, Composition.relatesTo.label, Composition.relatesTo.display, Composition.relatesTo.citation, Composition.relatesTo.document, Composition.relatesTo.resource, Composition.relatesTo.resourceReference, Composition.relatesTo.publicationStatus, Composition.relatesTo.publicationDate, Composition.event, Composition.event.extension, Composition.event.extension:code, Composition.event.modifierExtension, Composition.event.period, Composition.event.detail, Composition.section, Composition.section.extension, Composition.section.extension:mode, Composition.section.modifierExtension, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, 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:confidentiality, Composition.modifierExtension, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.relatesTo.extension, Composition.relatesTo.extension:code, Composition.relatesTo.extension:target, Composition.event.extension, Composition.event.extension:code, Composition.event.modifierExtension, Composition.section.extension, Composition.section.extension:mode, Composition.section.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron