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

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

Resource Profile: Profile_R5_Composition_R3

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_R3

This cross-version profile allows R5 Composition content to be represented via FHIR STU3 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 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: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..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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: R5CompositionStatusForR3 (0.1.0) (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIR Document Type Codes (preferred): Type of a composition.
... subject Σ 1..1 Reference(Resource) Who and/or what the composition is about
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | Device | Patient | RelatedPerson) Who and/or what authored the composition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... title Σ 1..1 string Human Readable name/title
... confidentiality ?!Σ 0..1 code ​As defined by affinity domain
Binding: ConfidentialityClassification|2014-03-26 (required): Codes specifying the level of confidentiality of the composition.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus . 📍3.0.2 tx.fhir.org
Composition.type Base preferred FHIR Document Type Codes 📍3.0.2 FHIR Std.
Composition.confidentiality Base required ConfidentialityClassification 📍2014-03-26 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Composition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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: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..* (Complex) 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: R5CompositionStatusForR3 (0.1.0) (required): The workflow/clinical status of the composition.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... 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.
.... party
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:party 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... event
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:detail 0..* CodeableConcept R5: The event(s) being documented, as code(s), reference(s), or both additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.event.detail
Binding: R5V3ActCodeForR3 (0.1.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:author 0..* Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Who and/or what authored the section (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.author
..... extension:focus 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Who/what the section is about, when it is not about the subject of composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.focus
.... entry
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entry 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: entry additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

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: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..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Logical identifier of composition (version-independent)
... 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
..... 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: R5CompositionStatusForR3 (0.1.0) (required): The workflow/clinical status of the composition.
.... value 0..1 code Primitive value for code
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIR Document Type Codes (preferred): Type of a composition.
... class Σ 0..1 CodeableConcept Categorization of Composition
Binding: FHIR Document Class Codes (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Resource) Who and/or what the composition is about
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context 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
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | Device | Patient | RelatedPerson) Who and/or what authored the composition
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... title Σ 1..1 string Human Readable name/title
... confidentiality ?!Σ 0..1 code ​As defined by affinity domain
Binding: 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... mode Σ 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
...... 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.
..... value 0..1 code Primitive value for code
.... time Σ 0..1 dateTime When the composition was attested
.... party Σ 0..1 Reference(Patient | Practitioner | Organization) Who attested the composition
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:party 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... custodian Σ 0..1 Reference(Organization) Organization which maintains the composition
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo Σ 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 0..* CodeableConcept ​Code(s) that apply to the event being documented
Binding: ActCode|2016-11-11 (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
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:detail 0..* CodeableConcept R5: The event(s) being documented, as code(s), reference(s), or both additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.event.detail
Binding: R5V3ActCodeForR3 (0.1.0) (example): This list of codes represents the main clinical acts being documented.
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... section C 0..* BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Who and/or what authored the section (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.author
..... extension:focus 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Who/what the section is about, when it is not about the subject of composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.focus
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... title 0..1 string Label for section (e.g. for ToC)
.... code 0..1 CodeableConcept Classification of section (recommended)
Binding: Document Section Codes (example): Classification of a section of a composition/document.
.... 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: List Order Codes (preferred): What order applies to the items in the entry.
.... entry C 0..* Reference(Resource) A reference to data that supports this section
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entry 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: entry additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: List Empty Reasons (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 extensible Common Languages . 📍3.0.2 tx.fhir.org
Composition.status Base required CompositionStatus . 📍3.0.2 tx.fhir.org
Composition.type Base preferred FHIR Document Type Codes 📍3.0.2 FHIR Std.
Composition.class Base example FHIR Document Class Codes 📍3.0.2 FHIR Std.
Composition.confidentiality Base required ConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍3.0.2 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType . 📍3.0.2 tx.fhir.org
Composition.event.code Base example v3 Code System ActCode . 📍2016-11-11 tx.fhir.org
Composition.section.​code Base example Document Section Codes 📍3.0.2 FHIR Std.
Composition.section.​mode Base required ListMode 📍3.0.2 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍3.0.2 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section A section must 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-1 error Composition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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: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..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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: R5CompositionStatusForR3 (0.1.0) (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIR Document Type Codes (preferred): Type of a composition.
... subject Σ 1..1 Reference(Resource) Who and/or what the composition is about
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | Device | Patient | RelatedPerson) Who and/or what authored the composition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... title Σ 1..1 string Human Readable name/title
... confidentiality ?!Σ 0..1 code ​As defined by affinity domain
Binding: ConfidentialityClassification|2014-03-26 (required): Codes specifying the level of confidentiality of the composition.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required CompositionStatus . 📍3.0.2 tx.fhir.org
Composition.type Base preferred FHIR Document Type Codes 📍3.0.2 FHIR Std.
Composition.confidentiality Base required ConfidentialityClassification 📍2014-03-26 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Composition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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: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..* (Complex) 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: R5CompositionStatusForR3 (0.1.0) (required): The workflow/clinical status of the composition.
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... 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.
.... party
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:party 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... custodian
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... event
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:detail 0..* CodeableConcept R5: The event(s) being documented, as code(s), reference(s), or both additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.event.detail
Binding: R5V3ActCodeForR3 (0.1.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:author 0..* Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Who and/or what authored the section (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.author
..... extension:focus 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Who/what the section is about, when it is not about the subject of composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.focus
.... entry
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entry 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: entry additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

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: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..* (Complex) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Logical identifier of composition (version-independent)
... 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
..... 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: R5CompositionStatusForR3 (0.1.0) (required): The workflow/clinical status of the composition.
.... value 0..1 code Primitive value for code
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIR Document Type Codes (preferred): Type of a composition.
... class Σ 0..1 CodeableConcept Categorization of Composition
Binding: FHIR Document Class Codes (example): High-level kind of a clinical document at a macro level.
... subject Σ 1..1 Reference(Resource) Who and/or what the composition is about
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context 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
..... extension:encounter 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | Device | Patient | RelatedPerson) Who and/or what authored the composition
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... title Σ 1..1 string Human Readable name/title
... confidentiality ?!Σ 0..1 code ​As defined by affinity domain
Binding: 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... mode Σ 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
...... 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.
..... value 0..1 code Primitive value for code
.... time Σ 0..1 dateTime When the composition was attested
.... party Σ 0..1 Reference(Patient | Practitioner | Organization) Who attested the composition
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:party 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... custodian Σ 0..1 Reference(Organization) Organization which maintains the composition
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:custodian 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... relatesTo Σ 0..* BackboneElement Relationships to other compositions/documents
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... code Σ 0..* CodeableConcept ​Code(s) that apply to the event being documented
Binding: ActCode|2016-11-11 (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
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:detail 0..* CodeableConcept R5: The event(s) being documented, as code(s), reference(s), or both additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.event.detail
Binding: R5V3ActCodeForR3 (0.1.0) (example): This list of codes represents the main clinical acts being documented.
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... section C 0..* BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization) R5: Who and/or what authored the section (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.author
..... extension:focus 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Who/what the section is about, when it is not about the subject of composition (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Composition.section.focus
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... title 0..1 string Label for section (e.g. for ToC)
.... code 0..1 CodeableConcept Classification of section (recommended)
Binding: Document Section Codes (example): Classification of a section of a composition/document.
.... 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: List Order Codes (preferred): What order applies to the items in the entry.
.... entry C 0..* Reference(Resource) A reference to data that supports this section
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entry 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: entry additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: List Empty Reasons (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 extensible Common Languages . 📍3.0.2 tx.fhir.org
Composition.status Base required CompositionStatus . 📍3.0.2 tx.fhir.org
Composition.type Base preferred FHIR Document Type Codes 📍3.0.2 FHIR Std.
Composition.class Base example FHIR Document Class Codes 📍3.0.2 FHIR Std.
Composition.confidentiality Base required ConfidentialityClassification 📍2014-03-26 FHIR Std.
Composition.attester.​mode Base required CompositionAttestationMode 📍3.0.2 FHIR Std.
Composition.relatesTo.​code Base required DocumentRelationshipType . 📍3.0.2 tx.fhir.org
Composition.event.code Base example v3 Code System ActCode . 📍2016-11-11 tx.fhir.org
Composition.section.​code Base example Document Section Codes 📍3.0.2 FHIR Std.
Composition.section.​mode Base required ListMode 📍3.0.2 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍3.0.2 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cmp-1 error Composition.section A section must 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-1 error Composition If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (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