Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot - ballot
Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot - ballot
This page is part of the Evidence Based Medicine on FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-report | Version: 1.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: EvidenceReport | ||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Composition
| Path | Conformance | ValueSet |
| Composition.attester.mode | preferred | ContributorRole |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Set |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 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 |
| 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 | |
 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| 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 | 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 | ||||
| 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 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 | ||||
| relatesTo | 0..* | RelatedArtifact | Relationships to other compositions/documents | |||||
| 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 | ||||
| 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 |
| Composition.language | required | AllLanguages |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | ReferencedItemCategoryValueSet |
| Composition.attester.mode | preferred | ContributorRole |
| Composition.event.detail | example | ActCode |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Set |
| Composition.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| 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: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from Composition
| Path | Conformance | ValueSet |
| Composition.attester.mode | preferred | ContributorRole |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Set |
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 | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 |
| 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 | |
| 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| 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 | 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 | ||||
| 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 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 | ||||
| relatesTo | 0..* | RelatedArtifact | Relationships to other compositions/documents | |||||
| 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 | ||||
| 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 |
| Composition.language | required | AllLanguages |
| Composition.status | required | CompositionStatus |
| Composition.type | preferred | FHIRDocumentTypeCodes |
| Composition.category | example | ReferencedItemCategoryValueSet |
| Composition.attester.mode | preferred | ContributorRole |
| Composition.event.detail | example | ActCode |
| Composition.section.code | extensible | EvidenceReportSectionCode_Value_Set |
| Composition.section.orderedBy | preferred | ListOrderCodes |
| Composition.section.emptyReason | preferred | ListEmptyReasons |
| 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: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.ebm#1.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change