Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot
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 2.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
| Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-report | Version: 2.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: EvidenceReport | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.36 | ||||
Profile of Composition for Evidence Based Medicine IG. The EvidenceReport Profile is used for a base structure (canonical resource management) for a report combining any number of Citation, Evidence, EvidenceVariable, EvidenceReport, and related Resources.
See Understanding the Composition Resource for additional information.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   versionAlgorithm |
0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |
| 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 artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| purpose |
0..1 | markdown | Why this artifact 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 artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |
| lastReviewDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |
 effectivePeriod |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |
  subject |
0..1 | Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) | Who and/or what the composition is about | |
 attester |
||||
 mode |
1..1 | CodeableConcept | reviewer | editor | endorser | informant | recorder Binding: Evidence Report Contributor Role Value Set (preferred) | |
 Slices for relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents Slice: Unordered, Open by value:label | |
 relatesTo:citeAs |
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: cite-as | |
 label |
1..1 | string | Short label Required Pattern: Cite as | |
| relatesTo:partOf |
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: part-of | |
| label |
1..1 | string | Short label Required Pattern: Part of | |
| relatesTo:derivedFrom |
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: derived-from | |
| label |
1..1 | string | Short label Required Pattern: Derived from | |
 relatesTo:specificationOfOriginal |
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: specification-of | |
| label |
1..1 | string | Short label Required Pattern: Original publication | |
 section |
||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: EvidenceReportSectionCode Value Set (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.attester.mode | preferred | EvidenceReportContributorRolehttp://hl7.org/fhir/uv/ebm/ValueSet/evidence-report-contributor-rolefrom this IG | |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Sethttps://fevir.net/resources/ValueSet/179431from this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children | |
| versionAlgorithm |
0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| experimental |
0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| description |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| purpose |
0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| copyright |
0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| copyrightLabel |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| approvalDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| lastReviewDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| effectivePeriod |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
 type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 0..1 | Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) | Who and/or what the composition is about ele-1: All FHIR elements must have a @value or children |
| date |
Σ | 1..1 | dateTime | Composition editing time ele-1: All FHIR elements must have a @value or children |
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition ele-1: All FHIR elements must have a @value or children |
| title |
Σ | 1..1 | string | Human Readable name/title ele-1: All FHIR elements must have a @value or children |
| Slices for relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents Slice: Unordered, Open by value:label ele-1: All FHIR elements must have a @value or children | |
| relatesTo:citeAs |
0..1 | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: cite-as | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Cite as | |
| relatesTo:partOf |
0..* | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: part-of | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Part of | |
| relatesTo:derivedFrom |
0..* | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: derived-from | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Derived from | |
| relatesTo:specificationOfOriginal |
0..* | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: specification-of | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Original publication | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.relatesTo:citeAs.type | required | Pattern: cite-ashttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:partOf.type | required | Pattern: part-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:derivedFrom.type | required | Pattern: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.type | required | Pattern: specification-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |||||
| 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 artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| purpose |
0..1 | markdown | Why this artifact 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 artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |||||
| lastReviewDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |||||
| effectivePeriod |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/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 identifier of a variation of the content in the Composition | ||||
| status |
?!Σ | 1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
Σ | 0..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 | recorder Binding: Evidence Report Contributor Role Value Set (preferred) | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents Slice: Unordered, Open by value:label | |||||
| relatesTo:citeAs |
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: cite-as | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Cite as | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| relatesTo:partOf |
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: part-of | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Part of | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| relatesTo:derivedFrom |
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: derived-from | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Derived from | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| relatesTo:specificationOfOriginal |
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: specification-of | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Original publication | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| event |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail |
Σ | 0..* | CodeableReference(Resource) | The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| section |
C | 0..* | BackboneElement | Composition is broken into sections 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(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..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-categoryfrom the FHIR Standard | |
| Composition.attester.mode | preferred | EvidenceReportContributorRolehttp://hl7.org/fhir/uv/ebm/ValueSet/evidence-report-contributor-rolefrom this IG | |
| Composition.relatesTo:citeAs.type | required | Pattern: cite-ashttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:citeAs.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:citeAs.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:partOf.type | required | Pattern: part-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:partOf.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:partOf.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:derivedFrom.type | required | Pattern: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:derivedFrom.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:derivedFrom.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.type | required | Pattern: specification-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.event.detail | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Sethttps://fevir.net/resources/ValueSet/179431from this IG | |
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | |
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Composition
Summary
Mandatory: 0 element(4 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| versionAlgorithm |
0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |
| 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 artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |
| purpose |
0..1 | markdown | Why this artifact 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 artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |
| lastReviewDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |
| effectivePeriod |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | |
| subject |
0..1 | Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) | Who and/or what the composition is about | |
| attester |
||||
| mode |
1..1 | CodeableConcept | reviewer | editor | endorser | informant | recorder Binding: Evidence Report Contributor Role Value Set (preferred) | |
| Slices for relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents Slice: Unordered, Open by value:label | |
| relatesTo:citeAs |
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: cite-as | |
| label |
1..1 | string | Short label Required Pattern: Cite as | |
| relatesTo:partOf |
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: part-of | |
| label |
1..1 | string | Short label Required Pattern: Part of | |
| relatesTo:derivedFrom |
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: derived-from | |
| label |
1..1 | string | Short label Required Pattern: Derived from | |
| relatesTo:specificationOfOriginal |
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: specification-of | |
| label |
1..1 | string | Short label Required Pattern: Original publication | |
| section |
||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: EvidenceReportSectionCode Value Set (extensible) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Composition.attester.mode | preferred | EvidenceReportContributorRolehttp://hl7.org/fhir/uv/ebm/ValueSet/evidence-report-contributor-rolefrom this IG | |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Sethttps://fevir.net/resources/ValueSet/179431from this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children | |
| versionAlgorithm |
0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| experimental |
0..1 | boolean | For testing purposes, not real usage URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| description |
0..1 | markdown | Natural language description of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| purpose |
0..1 | markdown | Why this artifact is defined URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| copyright |
0..1 | markdown | Use and/or publishing restrictions URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| copyrightLabel |
0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| approvalDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| lastReviewDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| effectivePeriod |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children |
| subject |
Σ | 0..1 | Reference(Citation | Classification | EvidenceReportSubject | ResearchStudy) | Who and/or what the composition is about ele-1: All FHIR elements must have a @value or children |
| date |
Σ | 1..1 | dateTime | Composition editing time ele-1: All FHIR elements must have a @value or children |
| author |
Σ | 1..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the composition ele-1: All FHIR elements must have a @value or children |
| title |
Σ | 1..1 | string | Human Readable name/title ele-1: All FHIR elements must have a @value or children |
| Slices for relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents Slice: Unordered, Open by value:label ele-1: All FHIR elements must have a @value or children | |
| relatesTo:citeAs |
0..1 | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: cite-as | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Cite as | |
| relatesTo:partOf |
0..* | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: part-of | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Part of | |
| relatesTo:derivedFrom |
0..* | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: derived-from | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Derived from | |
| relatesTo:specificationOfOriginal |
0..* | RelatedArtifact | Relationships to other compositions/documents ele-1: All FHIR elements must have a @value or children | |
| 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. ele-1: All FHIR elements must have a @value or children Required Pattern: specification-of | |
| label |
1..1 | string | Short label ele-1: All FHIR elements must have a @value or children Required Pattern: Original publication | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.relatesTo:citeAs.type | required | Pattern: cite-ashttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:partOf.type | required | Pattern: part-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:derivedFrom.type | required | Pattern: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.type | required | Pattern: specification-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible) | |||||
| 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 artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-description | |||||
| purpose |
0..1 | markdown | Why this artifact 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 artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | |||||
| lastReviewDate |
0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | |||||
| effectivePeriod |
0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/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 identifier of a variation of the content in the Composition | ||||
| status |
?!Σ | 1..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. | ||||
| category |
Σ | 0..* | CodeableConcept | Categorization of Composition Binding: ReferencedItemCategoryValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| subject |
Σ | 0..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 | recorder Binding: Evidence Report Contributor Role Value Set (preferred) | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo |
0..* | RelatedArtifact | Relationships to other compositions/documents Slice: Unordered, Open by value:label | |||||
| relatesTo:citeAs |
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: cite-as | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Cite as | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| relatesTo:partOf |
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: part-of | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Part of | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| relatesTo:derivedFrom |
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: derived-from | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Derived from | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| relatesTo:specificationOfOriginal |
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: specification-of | |||||
| classifier |
0..* | CodeableConcept | Additional classifiers Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact. | |||||
| label |
1..1 | string | Short label Required Pattern: Original publication | |||||
| display |
0..1 | string | Brief description of the related artifact | |||||
| citation |
0..1 | markdown | Bibliographic citation for the artifact | |||||
| document |
0..1 | Attachment | What document is being referenced | |||||
| resource |
0..1 | canonical(Resource) | What artifact is being referenced | |||||
| resourceReference |
0..1 | Reference(Resource) | What artifact, if not a conformance resource | |||||
| publicationStatus |
0..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Publication status of an artifact being referred to. | |||||
| publicationDate |
0..1 | date | Date of publication of the artifact being referred to | |||||
| event |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail |
Σ | 0..* | CodeableReference(Resource) | The event(s) being documented, as code(s), reference(s), or both Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | ||||
| section |
C | 0..* | BackboneElement | Composition is broken into sections 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(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..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
0..* | See section (Composition) | Nested Section | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2from the FHIR Standard | |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| Composition.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-categoryfrom the FHIR Standard | |
| Composition.attester.mode | preferred | EvidenceReportContributorRolehttp://hl7.org/fhir/uv/ebm/ValueSet/evidence-report-contributor-rolefrom this IG | |
| Composition.relatesTo:citeAs.type | required | Pattern: cite-ashttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:citeAs.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:citeAs.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:partOf.type | required | Pattern: part-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:partOf.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:partOf.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:derivedFrom.type | required | Pattern: derived-fromhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:derivedFrom.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:derivedFrom.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.type | required | Pattern: specification-ofhttp://hl7.org/fhir/ValueSet/related-artifact-type|6.0.0-ballot2from the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.classifier | example | CitationArtifactClassifierhttp://hl7.org/fhir/ValueSet/citation-artifact-classifierfrom the FHIR Standard | |
| Composition.relatesTo:specificationOfOriginal.publicationStatus | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2from the FHIR Standard | |
| Composition.event.detail | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Sethttps://fevir.net/resources/ValueSet/179431from this IG | |
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | |
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Composition
Summary
Mandatory: 0 element(4 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.ebm#2.0.0-ballot based on FHIR 6.0.0-ballot2. Generated 2024-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change