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

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

Resource Profile: Profile_R3_Composition_R5

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

This cross-version profile allows STU3 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 modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:confidentiality ?!Σ 0..1 code STU3: As defined by affinity domain (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.confidentiality
Binding: R3V3ConfidentialityClassificationForR5 (0.1.0) (required): Codes specifying the level of confidentiality 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:author 0..1 Reference(Resource) STU3: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... 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.modifierExtension, Composition.modifierExtension:confidentiality, Composition.status, Composition.type, Composition.date, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.author.reference, Composition.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Composition.modifierExtension, Composition.modifierExtension:confidentiality, Composition.author.extension, Composition.author.extension:author 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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.text
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:confidentiality 0..1 code STU3: As defined by affinity domain (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.confidentiality
Binding: R3V3ConfidentialityClassificationForR5 (0.1.0) (required): Codes specifying the level of confidentiality of the composition.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier STU3: Logical identifier of composition (version-independent) additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.identifier
... subject
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 1..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 Reference(Resource) STU3: 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..* Reference(Resource) STU3: 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..* code STU3: mode
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (required): 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 Reference(Resource) STU3: 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 Reference(Resource) STU3: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relatesTo
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 code STU3: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.relatesTo.code
Binding: DocumentRelationshipType (required): The type of relationship between documents.
..... extension:target 1..1 Identifier, Reference(Cross-version Profile for STU3.Composition for use in FHIR R5(0.1.0) | Composition) STU3: Target of the relationship (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.relatesTo.target
... event
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 0..* CodeableConcept STU3: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.code
Binding: R3V3ActCodeForR5 (0.1.0) (example): This list of codes represents the main clinical acts being documented.
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.period
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:detail 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R5(0.1.0) | Resource) STU3: The event(s) being documented additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.detail
... section
.... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... modifierExtension:mode 0..1 code STU3: working | snapshot | changes (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.
.... text
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.text
.... entry
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entry 0..* Reference(Resource) STU3: entry additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

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
.... 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:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
.... 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:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:confidentiality ?!Σ 0..1 code STU3: As defined by affinity domain (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.confidentiality
Binding: R3V3ConfidentialityClassificationForR5 (0.1.0) (required): Codes specifying the level of confidentiality of the composition.
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
.... 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:identifier 0..1 Identifier STU3: Logical identifier of composition (version-independent) additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 1..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the 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:encounter 0..1 Reference(Resource) STU3: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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
.... 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:author 0..1 Reference(Resource) STU3: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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..* code STU3: mode
URL: http://hl7.org/fhir/3.0/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
..... 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:party 0..1 Reference(Resource) STU3: party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
... custodian Σ 0..1 Reference(Organization) Organization which maintains the 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:custodian 0..1 Reference(Resource) STU3: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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 STU3: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/3.0/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 STU3.Composition for use in FHIR R5(0.1.0) | Composition) STU3: Target of the relationship (new)
URL: http://hl7.org/fhir/3.0/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 STU3: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.code
Binding: R3V3ActCodeForR5 (0.1.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
..... 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:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... 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.
..... 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:detail 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R5(0.1.0) | Resource) STU3: The event(s) being documented additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.detail
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
... 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
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension:mode ?!Σ 0..1 code STU3: working | snapshot | changes (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.
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
..... 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:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.text
Constraints: ext-1
..... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
..... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
.... 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
..... 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:entry 0..1 Reference(Resource) STU3: entry additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... 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.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Composition.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Composition.language Base required All Languages 📍5.0.0 FHIR Std.
Composition.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Composition.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Composition.identifier.​type Base extensible Identifier Type Codes 📍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.subject.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.encounter.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.author.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
Composition.attester.​party.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.custodian.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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 tx.fhir.org
Composition.section.​code Base example Document Section Codes 📍5.0.0 FHIR Std.
Composition.section.​text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
Composition.section.​entry.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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.meta.extension, Composition.meta.extension:meta, Composition.meta.versionId, Composition.meta.lastUpdated, Composition.meta.source, Composition.meta.profile, Composition.meta.security, Composition.meta.tag, Composition.implicitRules, Composition.language, Composition.text, Composition.text.extension, Composition.text.extension:text, Composition.text.status, Composition.text.div, Composition.extension, Composition.modifierExtension, Composition.modifierExtension:confidentiality, Composition.url, Composition.identifier, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.identifier.use, Composition.identifier.type, Composition.identifier.system, Composition.identifier.value, Composition.identifier.period, Composition.identifier.assigner, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.subject.extension, Composition.subject.extension:subject, Composition.subject.reference, Composition.subject.type, Composition.subject.identifier, Composition.subject.display, Composition.encounter, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.encounter.reference, Composition.encounter.type, Composition.encounter.identifier, Composition.encounter.display, Composition.date, Composition.useContext, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.author.reference, Composition.author.type, Composition.author.identifier, Composition.author.display, 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.attester.party.extension, Composition.attester.party.extension:party, Composition.attester.party.reference, Composition.attester.party.type, Composition.attester.party.identifier, Composition.attester.party.display, Composition.custodian, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.custodian.reference, Composition.custodian.type, Composition.custodian.identifier, Composition.custodian.display, 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.period.extension, Composition.event.period.extension:period, Composition.event.period.start, Composition.event.period.end, Composition.event.detail, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.event.detail.concept, Composition.event.detail.reference, Composition.section, Composition.section.extension, Composition.section.modifierExtension, Composition.section.modifierExtension:mode, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.text.status, Composition.section.text.div, Composition.section.orderedBy, Composition.section.entry, Composition.section.entry.extension, Composition.section.entry.extension:entry, Composition.section.entry.reference, Composition.section.entry.type, Composition.section.entry.identifier, Composition.section.entry.display, 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.meta.extension, Composition.meta.extension:meta, Composition.text.extension, Composition.text.extension:text, Composition.extension, Composition.modifierExtension, Composition.modifierExtension:confidentiality, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.subject.extension, Composition.subject.extension:subject, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.author.extension, Composition.author.extension:author, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.attester.party.extension, Composition.attester.party.extension:party, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.relatesTo.extension, Composition.relatesTo.extension:code, Composition.relatesTo.extension:target, Composition.event.extension, Composition.event.extension:code, Composition.event.modifierExtension, Composition.event.period.extension, Composition.event.period.extension:period, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.section.extension, Composition.section.modifierExtension, Composition.section.modifierExtension:mode, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.entry.extension, Composition.section.entry.extension:entry Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Composition.text.div, Composition.section.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Composition.text.div, Composition.section.text.div The narrative SHALL have some non-whitespace content htmlChecks()

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 modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:confidentiality ?!Σ 0..1 code STU3: As defined by affinity domain (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.confidentiality
Binding: R3V3ConfidentialityClassificationForR5 (0.1.0) (required): Codes specifying the level of confidentiality 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:author 0..1 Reference(Resource) STU3: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... 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.modifierExtension, Composition.modifierExtension:confidentiality, Composition.status, Composition.type, Composition.date, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.author.reference, Composition.title All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Composition.modifierExtension, Composition.modifierExtension:confidentiality, Composition.author.extension, Composition.author.extension:author 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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.text
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:confidentiality 0..1 code STU3: As defined by affinity domain (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.confidentiality
Binding: R3V3ConfidentialityClassificationForR5 (0.1.0) (required): Codes specifying the level of confidentiality of the composition.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier STU3: Logical identifier of composition (version-independent) additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.identifier
... subject
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 1..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:encounter 0..1 Reference(Resource) STU3: 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..* Reference(Resource) STU3: 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..* code STU3: mode
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.attester.mode
Binding: CompositionAttestationMode (required): 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 Reference(Resource) STU3: 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 Reference(Resource) STU3: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relatesTo
.... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 code STU3: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.relatesTo.code
Binding: DocumentRelationshipType (required): The type of relationship between documents.
..... extension:target 1..1 Identifier, Reference(Cross-version Profile for STU3.Composition for use in FHIR R5(0.1.0) | Composition) STU3: Target of the relationship (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.relatesTo.target
... event
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 0..* CodeableConcept STU3: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.code
Binding: R3V3ActCodeForR5 (0.1.0) (example): This list of codes represents the main clinical acts being documented.
.... period
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.period
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:detail 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R5(0.1.0) | Resource) STU3: The event(s) being documented additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.detail
... section
.... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... modifierExtension:mode 0..1 code STU3: working | snapshot | changes (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.
.... text
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.text
.... entry
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:entry 0..* Reference(Resource) STU3: 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(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
.... 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:meta 0..1 Meta STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... 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
.... 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:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:confidentiality ?!Σ 0..1 code STU3: As defined by affinity domain (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.confidentiality
Binding: R3V3ConfidentialityClassificationForR5 (0.1.0) (required): Codes specifying the level of confidentiality of the composition.
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
.... 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:identifier 0..1 Identifier STU3: Logical identifier of composition (version-independent) additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 1..1 Reference(Resource) STU3: subject additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Context of the 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:encounter 0..1 Reference(Resource) STU3: encounter additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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
.... 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:author 0..1 Reference(Resource) STU3: author
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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..* code STU3: mode
URL: http://hl7.org/fhir/3.0/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
..... 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:party 0..1 Reference(Resource) STU3: party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
... custodian Σ 0..1 Reference(Organization) Organization which maintains the 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:custodian 0..1 Reference(Resource) STU3: custodian additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... 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 STU3: replaces | transforms | signs | appends additional types
URL: http://hl7.org/fhir/3.0/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 STU3.Composition for use in FHIR R5(0.1.0) | Composition) STU3: Target of the relationship (new)
URL: http://hl7.org/fhir/3.0/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 STU3: Code(s) that apply to the event being documented (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.code
Binding: R3V3ActCodeForR5 (0.1.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
..... 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:period 0..1 Period STU3: period additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.period
Constraints: ext-1
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... 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.
..... 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:detail 0..* Reference(Cross-version Profile for STU3.Resource for use in FHIR R5(0.1.0) | Resource) STU3: The event(s) being documented additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.event.detail
Constraints: ext-1
..... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
..... reference Σ 0..1 Reference() Reference to a resource (by instance)
... 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
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... modifierExtension:mode ?!Σ 0..1 code STU3: working | snapshot | changes (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.mode
Binding: ListMode (required): The processing mode that applies to this section.
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
..... 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:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Composition.section.text
Constraints: ext-1
..... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
..... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
.... 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
..... 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:entry 0..1 Reference(Resource) STU3: entry additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
.... 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.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
Composition.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Composition.language Base required All Languages 📍5.0.0 FHIR Std.
Composition.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Composition.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Composition.identifier.​type Base extensible Identifier Type Codes 📍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.subject.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.encounter.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.author.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
Composition.attester.​party.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
Composition.custodian.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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 tx.fhir.org
Composition.section.​code Base example Document Section Codes 📍5.0.0 FHIR Std.
Composition.section.​text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
Composition.section.​orderedBy Base preferred List Order Codes 📍5.0.0 FHIR Std.
Composition.section.​entry.type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
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.meta.extension, Composition.meta.extension:meta, Composition.meta.versionId, Composition.meta.lastUpdated, Composition.meta.source, Composition.meta.profile, Composition.meta.security, Composition.meta.tag, Composition.implicitRules, Composition.language, Composition.text, Composition.text.extension, Composition.text.extension:text, Composition.text.status, Composition.text.div, Composition.extension, Composition.modifierExtension, Composition.modifierExtension:confidentiality, Composition.url, Composition.identifier, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.identifier.use, Composition.identifier.type, Composition.identifier.system, Composition.identifier.value, Composition.identifier.period, Composition.identifier.assigner, Composition.version, Composition.status, Composition.type, Composition.category, Composition.subject, Composition.subject.extension, Composition.subject.extension:subject, Composition.subject.reference, Composition.subject.type, Composition.subject.identifier, Composition.subject.display, Composition.encounter, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.encounter.reference, Composition.encounter.type, Composition.encounter.identifier, Composition.encounter.display, Composition.date, Composition.useContext, Composition.author, Composition.author.extension, Composition.author.extension:author, Composition.author.reference, Composition.author.type, Composition.author.identifier, Composition.author.display, 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.attester.party.extension, Composition.attester.party.extension:party, Composition.attester.party.reference, Composition.attester.party.type, Composition.attester.party.identifier, Composition.attester.party.display, Composition.custodian, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.custodian.reference, Composition.custodian.type, Composition.custodian.identifier, Composition.custodian.display, 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.period.extension, Composition.event.period.extension:period, Composition.event.period.start, Composition.event.period.end, Composition.event.detail, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.event.detail.concept, Composition.event.detail.reference, Composition.section, Composition.section.extension, Composition.section.modifierExtension, Composition.section.modifierExtension:mode, Composition.section.title, Composition.section.code, Composition.section.author, Composition.section.focus, Composition.section.text, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.text.status, Composition.section.text.div, Composition.section.orderedBy, Composition.section.entry, Composition.section.entry.extension, Composition.section.entry.extension:entry, Composition.section.entry.reference, Composition.section.entry.type, Composition.section.entry.identifier, Composition.section.entry.display, 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.meta.extension, Composition.meta.extension:meta, Composition.text.extension, Composition.text.extension:text, Composition.extension, Composition.modifierExtension, Composition.modifierExtension:confidentiality, Composition.identifier.extension, Composition.identifier.extension:identifier, Composition.subject.extension, Composition.subject.extension:subject, Composition.encounter.extension, Composition.encounter.extension:encounter, Composition.author.extension, Composition.author.extension:author, Composition.attester.extension, Composition.attester.modifierExtension, Composition.attester.mode.extension, Composition.attester.mode.extension:mode, Composition.attester.party.extension, Composition.attester.party.extension:party, Composition.custodian.extension, Composition.custodian.extension:custodian, Composition.relatesTo.extension, Composition.relatesTo.extension:code, Composition.relatesTo.extension:target, Composition.event.extension, Composition.event.extension:code, Composition.event.modifierExtension, Composition.event.period.extension, Composition.event.period.extension:period, Composition.event.detail.extension, Composition.event.detail.extension:detail, Composition.section.extension, Composition.section.modifierExtension, Composition.section.modifierExtension:mode, Composition.section.text.extension, Composition.section.text.extension:text, Composition.section.entry.extension, Composition.section.entry.extension:entry Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error Composition.text.div, Composition.section.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Composition.text.div, Composition.section.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron