Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot2 - STU 1 ballot International flag

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: EvidenceReport

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-report Version: 1.0.0-ballot2
Standards status: Trial-use Maturity Level: 1 Computable Name: EvidenceReport
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.39

Profile of Composition for Evidence Based Medicine IG. The EvidenceReport Profile is used for a base structure (canonical resource management) for a report combining any number of Citation, Evidence, EvidenceVariable, EvidenceReport, and related Resources.

See Understanding the Composition Resource for additional information.

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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
.... extension:experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
.... extension:description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:purpose 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
.... extension:copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:additionalLanguage 0..* code The additional language
URL: http://hl7.org/fhir/StructureDefinition/additional-language
Binding: AllLanguages (required): IETF language tag for a human language
.... extension:extendedContactDetail 0..* ExtendedContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-extended-contact-detail
.... extension:publicationDate 0..1 date Publication date of Resource
URL: http://hl7.org/fhir/StructureDefinition/artifact-publicationDate
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... 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.
... subject Σ 0..* Reference(Resource) Who and/or what the composition is about
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... Slices for relatesTo 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:citeAs 0..1 BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: cite-as
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:partOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: part-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:derivedFrom 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:specificationOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: specification-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:dependsOn 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: depends-on
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required Composition Status 📍6.0.0-ballot3 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:citeAs.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:partOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:derivedFrom.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:specificationOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:dependsOn.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:supportedWith.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
.... extension:experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
.... extension:description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:purpose 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
.... extension:copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:additionalLanguage 0..* code The additional language
URL: http://hl7.org/fhir/StructureDefinition/additional-language
Binding: AllLanguages (required): IETF language tag for a human language
.... extension:extendedContactDetail 0..* ExtendedContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-extended-contact-detail
.... extension:publicationDate 0..1 date Publication date of Resource
URL: http://hl7.org/fhir/StructureDefinition/artifact-publicationDate
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... subject 0..* Reference(Resource) Who and/or what the composition is about
... attester
.... mode 1..1 CodeableConcept reviewer | editor | endorser | informant | recorder
Binding: Contributor Role (preferred)
.... relatesTo:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
.... relatesTo:citeAs 0..1 BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: cite-as
.... relatesTo:partOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: part-of
.... relatesTo:derivedFrom 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: derived-from
.... relatesTo:specificationOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: specification-of
.... relatesTo:dependsOn 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: depends-on
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: supported-with
... section
.... code 0..1 CodeableConcept Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.attester.​mode Base preferred Contributor Role 📦1.0.0 THO v6.5
Composition.section.​code Base extensible EvidenceReportSectionCode Value Set 📦1.0.0-ballot2 This IG
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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
.... extension:experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
.... extension:description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:purpose 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
.... extension:copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:additionalLanguage 0..* code The additional language
URL: http://hl7.org/fhir/StructureDefinition/additional-language
Binding: AllLanguages (required): IETF language tag for a human language
.... extension:extendedContactDetail 0..* ExtendedContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-extended-contact-detail
.... extension:publicationDate 0..1 date Publication date of Resource
URL: http://hl7.org/fhir/StructureDefinition/artifact-publicationDate
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Version-independent identifier for the Composition
... version Σ 0..1 string An explicitly assigned identifier of a variation of the content in the Composition
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..* Reference(Resource) Who and/or what the composition is about
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... name Σ 0..1 string Name for this Composition (computer friendly)
... title Σ 1..1 string Human Readable name/title
... note 0..* Annotation For any additional notes
... attester 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept reviewer | editor | endorser | informant | recorder
Binding: Contributor Role (preferred)
.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 0..1 Reference(Organization) Organization which maintains the composition
... Slices for relatesTo 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:citeAs 0..1 BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: cite-as
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:partOf 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: part-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:derivedFrom 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:specificationOf 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: specification-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:dependsOn 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: depends-on
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* CodeableReference(Resource) The event(s) being documented, as code(s), reference(s), or both
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
... section C 0..* BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 0..1 string Label for section (e.g. for ToC)
.... code 0..1 CodeableConcept Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)
.... author 0..* Reference(Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section, when the section is authored by someone other than the composition.author
.... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
.... text C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
.... entry C 0..* Reference(Resource) A reference to data that supports this section
.... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Composition.status Base required Composition Status 📍6.0.0-ballot3 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍6.0.0-ballot3 FHIR Std.
Composition.category Base example Referenced Item Category Value Set 📍6.0.0-ballot3 FHIR Std.
Composition.attester.​mode Base preferred Contributor Role 📦1.0.0 THO v6.5
Composition.relatesTo.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:citeAs.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:partOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:derivedFrom.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:specificationOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:dependsOn.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:supportedWith.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.event.detail Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base extensible EvidenceReportSectionCode Value Set 📦1.0.0-ballot2 This IG
Composition.section.​orderedBy Base preferred List Order Codes 📍6.0.0-ballot3 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍6.0.0-ballot3 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 no entries are included 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
.... extension:experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
.... extension:description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:purpose 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
.... extension:copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:additionalLanguage 0..* code The additional language
URL: http://hl7.org/fhir/StructureDefinition/additional-language
Binding: AllLanguages (required): IETF language tag for a human language
.... extension:extendedContactDetail 0..* ExtendedContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-extended-contact-detail
.... extension:publicationDate 0..1 date Publication date of Resource
URL: http://hl7.org/fhir/StructureDefinition/artifact-publicationDate
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... 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.
... subject Σ 0..* Reference(Resource) Who and/or what the composition is about
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... Slices for relatesTo 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:citeAs 0..1 BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: cite-as
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:partOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: part-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:derivedFrom 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:specificationOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: specification-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:dependsOn 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: depends-on
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.status Base required Composition Status 📍6.0.0-ballot3 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:citeAs.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:partOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:derivedFrom.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:specificationOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:dependsOn.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:supportedWith.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Composition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Composition 0..* Composition A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
.... extension:experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
.... extension:description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:purpose 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
.... extension:copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:additionalLanguage 0..* code The additional language
URL: http://hl7.org/fhir/StructureDefinition/additional-language
Binding: AllLanguages (required): IETF language tag for a human language
.... extension:extendedContactDetail 0..* ExtendedContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-extended-contact-detail
.... extension:publicationDate 0..1 date Publication date of Resource
URL: http://hl7.org/fhir/StructureDefinition/artifact-publicationDate
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... subject 0..* Reference(Resource) Who and/or what the composition is about
... attester
.... mode 1..1 CodeableConcept reviewer | editor | endorser | informant | recorder
Binding: Contributor Role (preferred)
.... relatesTo:All Slices Content/Rules for all slices
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
.... relatesTo:citeAs 0..1 BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: cite-as
.... relatesTo:partOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: part-of
.... relatesTo:derivedFrom 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: derived-from
.... relatesTo:specificationOf 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: specification-of
.... relatesTo:dependsOn 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: depends-on
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other compositions/documents
..... Slices for extension Content/Rules for all slices
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: supported-with
... section
.... code 0..1 CodeableConcept Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Composition.attester.​mode Base preferred Contributor Role 📦1.0.0 THO v6.5
Composition.section.​code Base extensible EvidenceReportSectionCode Value Set 📦1.0.0-ballot2 This IG

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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
.... extension:experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
.... extension:description 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:purpose 0..1 markdown Why this artifact is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
.... extension:copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
.... extension:copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
.... extension:approvalDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
.... extension:lastReviewDate 0..1 date When the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
.... extension:effectivePeriod 0..1 Period When the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
.... extension:additionalLanguage 0..* code The additional language
URL: http://hl7.org/fhir/StructureDefinition/additional-language
Binding: AllLanguages (required): IETF language tag for a human language
.... extension:extendedContactDetail 0..* ExtendedContactDetail Contact details for the publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-extended-contact-detail
.... extension:publicationDate 0..1 date Publication date of Resource
URL: http://hl7.org/fhir/StructureDefinition/artifact-publicationDate
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this Composition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Version-independent identifier for the Composition
... version Σ 0..1 string An explicitly assigned identifier of a variation of the content in the Composition
... status ?!Σ 1..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): The workflow/clinical status of the composition.
... type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
... category Σ 0..* CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.
... subject Σ 0..* Reference(Resource) Who and/or what the composition is about
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... name Σ 0..1 string Name for this Composition (computer friendly)
... title Σ 1..1 string Human Readable name/title
... note 0..* Annotation For any additional notes
... attester 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept reviewer | editor | endorser | informant | recorder
Binding: Contributor Role (preferred)
.... time 0..1 dateTime When the composition was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the composition
... custodian Σ 0..1 Reference(Organization) Organization which maintains the composition
... Slices for relatesTo 0..* BackboneElement Relationships to other compositions/documents
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:citeAs 0..1 BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: cite-as
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:partOf 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: part-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:derivedFrom 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:specificationOf 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: specification-of
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:dependsOn 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: depends-on
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other compositions/documents
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:classifier 0..1 CodeableConcept Additional classifiers for RelatedArtifacts
URL: http://hl7.org/fhir/StructureDefinition/relatesto-classifier
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... target[x] 1..1 The artifact that is related to this Composition
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
... event Σ 0..* BackboneElement The clinical service(s) being documented
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... period Σ 0..1 Period The period covered by the documentation
.... detail Σ 0..* CodeableReference(Resource) The event(s) being documented, as code(s), reference(s), or both
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
... section C 0..* BackboneElement Composition is broken into sections
Constraints: cmp-1, cmp-2
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... title 0..1 string Label for section (e.g. for ToC)
.... code 0..1 CodeableConcept Classification of section (recommended)
Binding: EvidenceReportSectionCode Value Set (extensible)
.... author 0..* Reference(Practitioner | PractitionerRole | CareTeam | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section, when the section is authored by someone other than the composition.author
.... focus 0..1 Reference(Resource) Who/what the section is about, when it is not about the subject of composition
.... text C 0..1 Narrative Text summary of the section, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
.... entry C 0..* Reference(Resource) A reference to data that supports this section
.... emptyReason C 0..1 CodeableConcept Why the section is empty
Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
.... section 0..* See section (Composition) Nested Section

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Composition.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
Composition.status Base required Composition Status 📍6.0.0-ballot3 FHIR Std.
Composition.type Base preferred FHIR Document Type Codes 📍6.0.0-ballot3 FHIR Std.
Composition.category Base example Referenced Item Category Value Set 📍6.0.0-ballot3 FHIR Std.
Composition.attester.​mode Base preferred Contributor Role 📦1.0.0 THO v6.5
Composition.relatesTo.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:citeAs.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:partOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:derivedFrom.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:specificationOf.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:dependsOn.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.relatesTo:supportedWith.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
Composition.event.detail Base example v3 Code System ActCode 📦3.0.0 THO v6.5
Composition.section.​code Base extensible EvidenceReportSectionCode Value Set 📦1.0.0-ballot2 This IG
Composition.section.​orderedBy Base preferred List Order Codes 📍6.0.0-ballot3 FHIR Std.
Composition.section.​emptyReason Base preferred List Empty Reasons 📍6.0.0-ballot3 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 no entries are included 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.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Composition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Composition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Composition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron