Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot - 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-ballot 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: ParticipantFlowReport

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/participant-flow-report Version: 1.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: ParticipantFlowReport

Profile of Composition for Evidence Based Medicine IG. The ParticipantFlowReport Profile is used for an evidence report including the counts (and proportions) for any number of participant flow measures in a research study. For example, the ParticipantFlowReport may include the data for a CONSORT Participant Flow Diagram reported with a randomized controlled trial.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from EvidenceReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* EvidenceReport A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for category 1..* CodeableConcept Categorization of Composition
Slice: Unordered, Open by value:coding
.... category:participantFlowReport S 1..1 CodeableConcept Categorization of Composition
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ParticipantFlowReport
...... display 1..1 string Representation defined by the system
Fixed Value: ParticipantFlowReport
..... text 0..1 string Plain text representation of the concept
Required Pattern: Participant Flow Report
... Slices for relatesTo 1..* RelatedArtifact Relationships to other compositions/documents
Slice: Unordered, Open by value:label
.... relatesTo:interventionGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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
Required Pattern: depends-on
..... label 1..1 string Short label
Required Pattern: Intervention Group
..... resourceReference 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:comparatorGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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
Required Pattern: depends-on
..... label 1..1 string Short label
Required Pattern: Comparator Group
..... resourceReference 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:totalGroup S 0..1 RelatedArtifact Relationships to other compositions/documents
..... 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
Required Pattern: depends-on
..... label 1..1 string Short label
Required Pattern: Total Group
..... resourceReference 0..1 Reference(StudyGroup) What artifact, if not a conformance resource
... section 1..* BackboneElement Composition is broken into sections
.... focus 0..1 Reference(ParticipantFlowMeasure) Who/what the section is about, when it is not about the subject of composition
.... Slices for section 0..* Nested Section
Slice: Unordered, Open by value:code.coding
..... section:comparatorEvidence S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-comparator-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with comparator alone
...... entry 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:interventionEvidence S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention alone
...... entry 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:totalGroup S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-total-group
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with total group
...... entry 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:comparativeEvidence S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-vs-comparator
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention vs. comparator
...... entry 0..1 Reference(ComparativeParticipantFlow) A reference to data that supports this section

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* EvidenceReport 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
... versionAlgorithm 0..1 string How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
... description 0..1 markdown Natural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... purpose 0..1 markdown Why this {{title}} is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
... copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
... copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate 0..1 date When the resource was approved by publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-approvalDate
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-lastReviewDate
... effectivePeriod 0..1 Period When the resource is expected to be used
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-effectivePeriod
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... 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.

.... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EvidenceReport
..... display 1..1 string Representation defined by the system
Fixed Value: EvidenceReport
... Slices for category Σ 1..* CodeableConcept Categorization of Composition
Slice: Unordered, Open by value:coding
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


.... category:participantFlowReport SΣ 1..1 CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ParticipantFlowReport
...... display 1..1 string Representation defined by the system
Fixed Value: ParticipantFlowReport
..... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Participant Flow Report
... subject Σ 0..1 Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) Who and/or what the composition is about
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... Slices for relatesTo 1..* RelatedArtifact Relationships to other compositions/documents
Slice: Unordered, Open by value:label
.... relatesTo:interventionGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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.


Required Pattern: depends-on
..... label Σ 1..1 string Short label
Required Pattern: Intervention Group
..... resourceReference Σ 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:comparatorGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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.


Required Pattern: depends-on
..... label Σ 1..1 string Short label
Required Pattern: Comparator Group
..... resourceReference Σ 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:totalGroup S 0..1 RelatedArtifact Relationships to other compositions/documents
..... 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.


Required Pattern: depends-on
..... label Σ 1..1 string Short label
Required Pattern: Total Group
..... resourceReference Σ 0..1 Reference(StudyGroup) What artifact, if not a conformance resource
... section C 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... focus 0..1 Reference(ParticipantFlowMeasure) Who/what the section is about, when it is not about the subject of composition
.... entry C 0..* Reference(Resource) A reference to data that supports this section
.... Slices for section 0..* See section (Composition) Nested Section
Slice: Unordered, Open by value:code.coding
..... section:comparatorEvidence S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:interventionEvidence S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:totalGroup S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:comparativeEvidence S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ComparativeParticipantFlow) A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.category:participantFlowReportexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.relatesTo:interventionGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:comparatorGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:totalGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* EvidenceReport 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 Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... versionAlgorithm 0..1 string How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
... experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
... description 0..1 markdown Natural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... purpose 0..1 markdown Why this {{title}} is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
... copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
... copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate 0..1 date When the resource was approved by publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-approvalDate
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-lastReviewDate
... effectivePeriod 0..1 Period When the resource is expected to be used
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-effectivePeriod
... 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 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.

.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EvidenceReport
..... display 1..1 string Representation defined by the system
Fixed Value: EvidenceReport
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for category Σ 1..* CodeableConcept Categorization of Composition
Slice: Unordered, Open by value:coding
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


.... category:participantFlowReport SΣ 1..1 CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ParticipantFlowReport
...... display 1..1 string Representation defined by the system
Fixed Value: ParticipantFlowReport
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Participant Flow Report
... subject Σ 0..1 Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) Who and/or what the composition is about
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... name Σ 0..1 string Name for this Composition (computer friendly)
... title Σ 1..1 string Human Readable name/title
... note 0..* Annotation For any additional notes
... attester 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept reviewer | editor | endorser | informant
Binding: ContributorRole (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 1..* RelatedArtifact Relationships to other compositions/documents
Slice: Unordered, Open by value:label
.... relatesTo:interventionGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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.


Required Pattern: depends-on
..... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.


..... label Σ 1..1 string Short label
Required Pattern: Intervention Group
..... 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(ExposureGroup | ComparatorGroup) 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
.... relatesTo:comparatorGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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.


Required Pattern: depends-on
..... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.


..... label Σ 1..1 string Short label
Required Pattern: Comparator Group
..... 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(ExposureGroup | ComparatorGroup) 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
.... relatesTo:totalGroup S 0..1 RelatedArtifact Relationships to other compositions/documents
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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.


Required Pattern: depends-on
..... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.


..... label Σ 1..1 string Short label
Required Pattern: Total Group
..... 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(StudyGroup) 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
.... 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 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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 | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
.... focus 0..1 Reference(ParticipantFlowMeasure) 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
.... 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.

.... Slices for section 0..* See section (Composition) Nested Section
Slice: Unordered, Open by value:code.coding
..... section:comparatorEvidence S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-comparator-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with comparator alone
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ParticipantFlow) 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
..... section:interventionEvidence S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention alone
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ParticipantFlow) 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
..... section:totalGroup S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-total-group
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with total group
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ParticipantFlow) 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
..... section:comparativeEvidence S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-vs-comparator
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention vs. comparator
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ComparativeParticipantFlow) 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

PathConformanceValueSet / CodeURI
Composition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.category:participantFlowReportexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.attester.modepreferredContributorRole
http://hl7.org/fhir/ValueSet/contributor-role
from the FHIR Standard
Composition.relatesTo:interventionGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:interventionGroup.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Composition.relatesTo:interventionGroup.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Composition.relatesTo:comparatorGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:comparatorGroup.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Composition.relatesTo:comparatorGroup.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Composition.relatesTo:totalGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:totalGroup.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Composition.relatesTo:totalGroup.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Composition.event.detailexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeextensibleEvidenceReportSectionCode_Value_Set
https://fevir.net/resources/ValueSet/179431
from this IG
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:comparatorEvidence.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:comparatorEvidence.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:comparatorEvidence.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:interventionEvidence.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:interventionEvidence.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:interventionEvidence.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:totalGroup.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:totalGroup.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:totalGroup.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:comparativeEvidence.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:comparativeEvidence.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:comparativeEvidence.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EvidenceReport

Summary

Mandatory: 5 elements(7 nested mandatory elements)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.category
  • The element 1 is sliced based on the value of Composition.relatesTo
  • The element 1 is sliced based on the value of Composition.section.section

Maturity: 1

Differential View

This structure is derived from EvidenceReport

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* EvidenceReport A set of resources composed into a single coherent clinical statement with clinical attestation
... Slices for category 1..* CodeableConcept Categorization of Composition
Slice: Unordered, Open by value:coding
.... category:participantFlowReport S 1..1 CodeableConcept Categorization of Composition
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ParticipantFlowReport
...... display 1..1 string Representation defined by the system
Fixed Value: ParticipantFlowReport
..... text 0..1 string Plain text representation of the concept
Required Pattern: Participant Flow Report
... Slices for relatesTo 1..* RelatedArtifact Relationships to other compositions/documents
Slice: Unordered, Open by value:label
.... relatesTo:interventionGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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
Required Pattern: depends-on
..... label 1..1 string Short label
Required Pattern: Intervention Group
..... resourceReference 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:comparatorGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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
Required Pattern: depends-on
..... label 1..1 string Short label
Required Pattern: Comparator Group
..... resourceReference 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:totalGroup S 0..1 RelatedArtifact Relationships to other compositions/documents
..... 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
Required Pattern: depends-on
..... label 1..1 string Short label
Required Pattern: Total Group
..... resourceReference 0..1 Reference(StudyGroup) What artifact, if not a conformance resource
... section 1..* BackboneElement Composition is broken into sections
.... focus 0..1 Reference(ParticipantFlowMeasure) Who/what the section is about, when it is not about the subject of composition
.... Slices for section 0..* Nested Section
Slice: Unordered, Open by value:code.coding
..... section:comparatorEvidence S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-comparator-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with comparator alone
...... entry 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:interventionEvidence S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention alone
...... entry 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:totalGroup S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-total-group
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with total group
...... entry 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:comparativeEvidence S 0..1 BackboneElement Nested Section
...... code
....... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-vs-comparator
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention vs. comparator
...... entry 0..1 Reference(ComparativeParticipantFlow) A reference to data that supports this section

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* EvidenceReport 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
... versionAlgorithm 0..1 string How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
... description 0..1 markdown Natural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... purpose 0..1 markdown Why this {{title}} is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
... copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
... copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate 0..1 date When the resource was approved by publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-approvalDate
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-lastReviewDate
... effectivePeriod 0..1 Period When the resource is expected to be used
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-effectivePeriod
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... 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.

.... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EvidenceReport
..... display 1..1 string Representation defined by the system
Fixed Value: EvidenceReport
... Slices for category Σ 1..* CodeableConcept Categorization of Composition
Slice: Unordered, Open by value:coding
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


.... category:participantFlowReport SΣ 1..1 CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ParticipantFlowReport
...... display 1..1 string Representation defined by the system
Fixed Value: ParticipantFlowReport
..... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Participant Flow Report
... subject Σ 0..1 Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) Who and/or what the composition is about
... date Σ 1..1 dateTime Composition editing time
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... title Σ 1..1 string Human Readable name/title
... Slices for relatesTo 1..* RelatedArtifact Relationships to other compositions/documents
Slice: Unordered, Open by value:label
.... relatesTo:interventionGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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.


Required Pattern: depends-on
..... label Σ 1..1 string Short label
Required Pattern: Intervention Group
..... resourceReference Σ 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:comparatorGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... 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.


Required Pattern: depends-on
..... label Σ 1..1 string Short label
Required Pattern: Comparator Group
..... resourceReference Σ 0..1 Reference(ExposureGroup | ComparatorGroup) What artifact, if not a conformance resource
.... relatesTo:totalGroup S 0..1 RelatedArtifact Relationships to other compositions/documents
..... 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.


Required Pattern: depends-on
..... label Σ 1..1 string Short label
Required Pattern: Total Group
..... resourceReference Σ 0..1 Reference(StudyGroup) What artifact, if not a conformance resource
... section C 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... focus 0..1 Reference(ParticipantFlowMeasure) Who/what the section is about, when it is not about the subject of composition
.... entry C 0..* Reference(Resource) A reference to data that supports this section
.... Slices for section 0..* See section (Composition) Nested Section
Slice: Unordered, Open by value:code.coding
..... section:comparatorEvidence S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:interventionEvidence S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:totalGroup S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ParticipantFlow) A reference to data that supports this section
..... section:comparativeEvidence S 0..1 BackboneElement Nested Section
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... entry C 0..1 Reference(ComparativeParticipantFlow) A reference to data that supports this section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.category:participantFlowReportexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.relatesTo:interventionGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:comparatorGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:totalGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Composition 0..* EvidenceReport 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 Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... versionAlgorithm 0..1 string How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-version profiled by http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
... experimental 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
... description 0..1 markdown Natural language description of the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
... purpose 0..1 markdown Why this {{title}} is defined
URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose
... copyright 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
... copyrightLabel 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate 0..1 date When the resource was approved by publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-approvalDate
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-lastReviewDate
... effectivePeriod 0..1 Period When the resource is expected to be used
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-effectivePeriod
... 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 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.

.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: EvidenceReport
..... display 1..1 string Representation defined by the system
Fixed Value: EvidenceReport
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for category Σ 1..* CodeableConcept Categorization of Composition
Slice: Unordered, Open by value:coding
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


.... category:participantFlowReport SΣ 1..1 CodeableConcept Categorization of Composition
Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level.


..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ParticipantFlowReport
...... display 1..1 string Representation defined by the system
Fixed Value: ParticipantFlowReport
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
Required Pattern: Participant Flow Report
... subject Σ 0..1 Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) Who and/or what the composition is about
... encounter Σ 0..1 Reference(Encounter) Context of the Composition
... date Σ 1..1 dateTime Composition editing time
... useContext Σ 0..* UsageContext The context that the content is intended to support
... author Σ 1..* Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) Who and/or what authored the composition
... name Σ 0..1 string Name for this Composition (computer friendly)
... title Σ 1..1 string Human Readable name/title
... note 0..* Annotation For any additional notes
... attester 0..* BackboneElement Attests to accuracy of composition
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept reviewer | editor | endorser | informant
Binding: ContributorRole (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 1..* RelatedArtifact Relationships to other compositions/documents
Slice: Unordered, Open by value:label
.... relatesTo:interventionGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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.


Required Pattern: depends-on
..... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.


..... label Σ 1..1 string Short label
Required Pattern: Intervention Group
..... 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(ExposureGroup | ComparatorGroup) 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
.... relatesTo:comparatorGroup S 0..* RelatedArtifact Relationships to other compositions/documents
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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.


Required Pattern: depends-on
..... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.


..... label Σ 1..1 string Short label
Required Pattern: Comparator Group
..... 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(ExposureGroup | ComparatorGroup) 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
.... relatesTo:totalGroup S 0..1 RelatedArtifact Relationships to other compositions/documents
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... 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.


Required Pattern: depends-on
..... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.


..... label Σ 1..1 string Short label
Required Pattern: Total Group
..... 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(StudyGroup) 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
.... 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 1..* BackboneElement Composition is broken into sections
cmp-1: A section must contain at least one of text, entries, or sub-sections
cmp-2: A section can only have an emptyReason if it is empty
.... 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 | Device | Patient | RelatedPerson | Organization) Who and/or what authored the section
.... focus 0..1 Reference(ParticipantFlowMeasure) 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
.... 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.

.... Slices for section 0..* See section (Composition) Nested Section
Slice: Unordered, Open by value:code.coding
..... section:comparatorEvidence S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-comparator-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with comparator alone
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ParticipantFlow) 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
..... section:interventionEvidence S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-alone
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention alone
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ParticipantFlow) 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
..... section:totalGroup S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-total-group
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with total group
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ParticipantFlow) 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
..... section:comparativeEvidence S 0..1 BackboneElement Nested Section
...... 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: DocumentSectionCodes (example): Classification of a section of a composition/document.

....... id 0..1 id Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: evidence-with-intervention-vs-comparator
........ display 1..1 string Representation defined by the system
Fixed Value: Evidence with intervention vs. comparator
........ userSelected 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
...... 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
...... orderedBy 0..1 CodeableConcept Order of section entries
Binding: ListOrderCodes (preferred): What order applies to the items in the entry.

...... entry C 0..1 Reference(ComparativeParticipantFlow) 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

PathConformanceValueSet / CodeURI
Composition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Composition.statusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
Composition.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
Composition.categoryexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.category:participantFlowReportexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
Composition.attester.modepreferredContributorRole
http://hl7.org/fhir/ValueSet/contributor-role
from the FHIR Standard
Composition.relatesTo:interventionGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:interventionGroup.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Composition.relatesTo:interventionGroup.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Composition.relatesTo:comparatorGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:comparatorGroup.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Composition.relatesTo:comparatorGroup.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Composition.relatesTo:totalGroup.typerequiredPattern: depends-on
http://hl7.org/fhir/ValueSet/related-artifact-type|5.0.0
from the FHIR Standard
Composition.relatesTo:totalGroup.classifierexampleCitationArtifactClassifier
http://hl7.org/fhir/ValueSet/citation-artifact-classifier
from the FHIR Standard
Composition.relatesTo:totalGroup.publicationStatusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
Composition.event.detailexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Composition.section.codeextensibleEvidenceReportSectionCode_Value_Set
https://fevir.net/resources/ValueSet/179431
from this IG
Composition.section.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:comparatorEvidence.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:comparatorEvidence.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:comparatorEvidence.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:interventionEvidence.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:interventionEvidence.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:interventionEvidence.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:totalGroup.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:totalGroup.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:totalGroup.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard
Composition.section.section:comparativeEvidence.codeexampleDocumentSectionCodes
http://hl7.org/fhir/ValueSet/doc-section-codes
from the FHIR Standard
Composition.section.section:comparativeEvidence.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
Composition.section.section:comparativeEvidence.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmp-1errorComposition.sectionA section must contain at least one of text, entries, or sub-sections
: text.exists() or entry.exists() or section.exists()
cmp-2errorComposition.sectionA section can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
dom-2errorCompositionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCompositionIf 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-4errorCompositionIf 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-5errorCompositionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCompositionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EvidenceReport

Summary

Mandatory: 5 elements(7 nested mandatory elements)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Composition.category
  • The element 1 is sliced based on the value of Composition.relatesTo
  • The element 1 is sliced based on the value of Composition.section.section

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron