This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: No defined compartments |
Detailed Descriptions for the elements in the EvidenceReport resource.
EvidenceReport | |||||||||
Element Id | EvidenceReport | ||||||||
Definition | The EvidenceReport Resource is a specialized container for a collection of resources and codeable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts. | ||||||||
Short Display | A EvidenceReport | ||||||||
Cardinality | 0..* | ||||||||
Type | MetadataResource | ||||||||
Summary | false | ||||||||
EvidenceReport.url | |||||||||
Element Id | EvidenceReport.url | ||||||||
Definition | An absolute URI that is used to identify this EvidenceReport when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different servers. | ||||||||
Short Display | Canonical identifier for this EvidenceReport, represented as a globally unique URI | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Requirements | Allows the EvidenceReport to be referenced by a single globally unique identifier. | ||||||||
Summary | true | ||||||||
Comments | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. | ||||||||
Invariants |
| ||||||||
EvidenceReport.status | |||||||||
Element Id | EvidenceReport.status | ||||||||
Definition | The status of this summary. Enables tracking the life-cycle of the content. | ||||||||
Short Display | draft | active | retired | unknown | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||
Type | code | ||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||
Requirements | Allows filtering of EvidenceReports that are appropriate for use versus not. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of summaries that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||||||||
EvidenceReport.useContext | |||||||||
Element Id | EvidenceReport.useContext | ||||||||
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence report instances. | ||||||||
Short Display | The context that the content is intended to support | ||||||||
Cardinality | 0..* | ||||||||
Type | UsageContext | ||||||||
Requirements | Assist in searching for appropriate content. | ||||||||
Summary | true | ||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
EvidenceReport.identifier | |||||||||
Element Id | EvidenceReport.identifier | ||||||||
Definition | A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||
Short Display | Unique identifier for the evidence report | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable identifiers to be associated with this EvidenceReport. | ||||||||
Summary | true | ||||||||
Comments | This element will contain unique identifiers that support de-duplication of EvidenceReports. This identifier can be valid for only one EvidenceReport resource. | ||||||||
EvidenceReport.relatedIdentifier | |||||||||
Element Id | EvidenceReport.relatedIdentifier | ||||||||
Definition | A formal identifier that is used to identify things closely related to this EvidenceReport. | ||||||||
Short Display | Identifiers for articles that may relate to more than one evidence report | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable identifiers to be associated with this EvidenceReport. | ||||||||
Summary | true | ||||||||
Comments | May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This identifier can be valid for multiple EvidenceReport resources. | ||||||||
EvidenceReport.citeAs[x] | |||||||||
Element Id | EvidenceReport.citeAs[x] | ||||||||
Definition | Citation Resource or display of suggested citation for this report. | ||||||||
Short Display | Citation for this report | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Citation)|markdown | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | false | ||||||||
Comments | used for reports for which external citation is expected, such as use in support of scholarly publications. | ||||||||
EvidenceReport.type | |||||||||
Element Id | EvidenceReport.type | ||||||||
Definition | Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression. | ||||||||
Short Display | Kind of report | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Evidence Report Type (Example) | ||||||||
Type | CodeableConcept | ||||||||
Requirements | May be used in searching and filtering. | ||||||||
Summary | false | ||||||||
EvidenceReport.note | |||||||||
Element Id | EvidenceReport.note | ||||||||
Definition | Used for footnotes and annotations. | ||||||||
Short Display | Used for footnotes and annotations | ||||||||
Cardinality | 0..* | ||||||||
Type | Annotation | ||||||||
Summary | false | ||||||||
EvidenceReport.relatedArtifact | |||||||||
Element Id | EvidenceReport.relatedArtifact | ||||||||
Definition | Link, description or reference to artifact associated with the report. | ||||||||
Short Display | Link, description or reference to artifact associated with the report | ||||||||
Cardinality | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Summary | false | ||||||||
EvidenceReport.subject | |||||||||
Element Id | EvidenceReport.subject | ||||||||
Definition | Specifies the subject or focus of the report. Answers "What is this report about?". | ||||||||
Short Display | Focus of the report | ||||||||
Cardinality | 1..1 | ||||||||
Summary | true | ||||||||
Comments | May be used as an expression for search queries and search results | ||||||||
EvidenceReport.subject.characteristic | |||||||||
Element Id | EvidenceReport.subject.characteristic | ||||||||
Definition | Characteristic. | ||||||||
Short Display | Characteristic | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
EvidenceReport.subject.characteristic.code | |||||||||
Element Id | EvidenceReport.subject.characteristic.code | ||||||||
Definition | Characteristic code. | ||||||||
Short Display | Characteristic code | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Focus Characteristic Code (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Comments | Example 1 is a Citation. Example 2 is a type of outcome. Example 3 is a specific outcome. | ||||||||
EvidenceReport.subject.characteristic.value[x] | |||||||||
Element Id | EvidenceReport.subject.characteristic.value[x] | ||||||||
Definition | Characteristic value. | ||||||||
Short Display | Characteristic value | ||||||||
Cardinality | 1..1 | ||||||||
Type | Reference(Any)|CodeableConcept|boolean|Quantity|Range | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | false | ||||||||
Comments | Example 1 is Citation #37. Example 2 is selecting clinical outcomes. Example 3 is 1-year mortality. | ||||||||
EvidenceReport.subject.characteristic.exclude | |||||||||
Element Id | EvidenceReport.subject.characteristic.exclude | ||||||||
Definition | Is used to express not the characteristic. | ||||||||
Short Display | Is used to express not the characteristic | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
EvidenceReport.subject.characteristic.period | |||||||||
Element Id | EvidenceReport.subject.characteristic.period | ||||||||
Definition | Timeframe for the characteristic. | ||||||||
Short Display | Timeframe for the characteristic | ||||||||
Cardinality | 0..1 | ||||||||
Type | Period | ||||||||
Summary | false | ||||||||
EvidenceReport.subject.note | |||||||||
Element Id | EvidenceReport.subject.note | ||||||||
Definition | Used for general notes and annotations not coded elsewhere. | ||||||||
Short Display | Footnotes and/or explanatory notes | ||||||||
Cardinality | 0..* | ||||||||
Type | Annotation | ||||||||
Summary | false | ||||||||
EvidenceReport.publisher | |||||||||
Element Id | EvidenceReport.publisher | ||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the evidence report. | ||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the evidence report. May also allow for contact. | ||||||||
Summary | true | ||||||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the evidence report is the organization or individual primarily responsible for the maintenance and upkeep of the evidence report. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the evidence report. This item SHOULD be populated unless the information is available from context. | ||||||||
EvidenceReport.contact | |||||||||
Element Id | EvidenceReport.contact | ||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Short Display | Contact details for the publisher | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module). See guidance around (not) making local changes to elements here. | ||||||||
EvidenceReport.author | |||||||||
Element Id | EvidenceReport.author | ||||||||
Definition | An individiual, organization, or device primarily involved in the creation and maintenance of the content. | ||||||||
Short Display | Who authored the content | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module). | ||||||||
EvidenceReport.editor | |||||||||
Element Id | EvidenceReport.editor | ||||||||
Definition | An individiual, organization, or device primarily responsible for internal coherence of the content. | ||||||||
Short Display | Who edited the content | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
Comments | Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module). | ||||||||
EvidenceReport.reviewer | |||||||||
Element Id | EvidenceReport.reviewer | ||||||||
Definition | An individiual, organization, or device primarily responsible for review of some aspect of the content. | ||||||||
Short Display | Who reviewed the content | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | false | ||||||||
Comments | Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module). See guidance around (not) making local changes to elements here. | ||||||||
EvidenceReport.endorser | |||||||||
Element Id | EvidenceReport.endorser | ||||||||
Definition | An individiual, organization, or device responsible for officially endorsing the content for use in some setting. | ||||||||
Short Display | Who endorsed the content | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module). See guidance around (not) making local changes to elements here. | ||||||||
EvidenceReport.relatesTo | |||||||||
Element Id | EvidenceReport.relatesTo | ||||||||
Definition | Relationships that this composition has with other compositions or documents that already exist. | ||||||||
Short Display | Relationships to other compositions/documents | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Comments | A document is a version specific composition. | ||||||||
EvidenceReport.relatesTo.code | |||||||||
Element Id | EvidenceReport.relatesTo.code | ||||||||
Definition | The type of relationship that this composition has with anther composition or document. | ||||||||
Short Display | replaces | amends | appends | transforms | replacedWith | amendedWith | appendedWith | transformedWith | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | Report Relationship Type (Required) | ||||||||
Type | code | ||||||||
Summary | false | ||||||||
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. | ||||||||
EvidenceReport.relatesTo.target | |||||||||
Element Id | EvidenceReport.relatesTo.target | ||||||||
Definition | The target composition/document of this relationship. | ||||||||
Short Display | Target of the relationship | ||||||||
Cardinality | 1..1 | ||||||||
Summary | false | ||||||||
EvidenceReport.relatesTo.target.url | |||||||||
Element Id | EvidenceReport.relatesTo.target.url | ||||||||
Definition | Target of the relationship URL. | ||||||||
Short Display | Target of the relationship URL | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Summary | false | ||||||||
EvidenceReport.relatesTo.target.identifier | |||||||||
Element Id | EvidenceReport.relatesTo.target.identifier | ||||||||
Definition | Target of the relationship Identifier. | ||||||||
Short Display | Target of the relationship Identifier | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | Identifier | ||||||||
Summary | false | ||||||||
EvidenceReport.relatesTo.target.display | |||||||||
Element Id | EvidenceReport.relatesTo.target.display | ||||||||
Definition | Target of the relationship Display. | ||||||||
Short Display | Target of the relationship Display | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
EvidenceReport.relatesTo.target.resource | |||||||||
Element Id | EvidenceReport.relatesTo.target.resource | ||||||||
Definition | Target of the relationship Resource reference. | ||||||||
Short Display | Target of the relationship Resource reference | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Any) | ||||||||
Summary | false | ||||||||
EvidenceReport.section | |||||||||
Element Id | EvidenceReport.section | ||||||||
Definition | The root of the sections that make up the composition. | ||||||||
Short Display | Composition is broken into sections | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
EvidenceReport.section.title | |||||||||
Element Id | EvidenceReport.section.title | ||||||||
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. | ||||||||
Short Display | Label for section (e.g. for ToC) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. | ||||||||
Alternate Names | header; label; caption | ||||||||
Summary | false | ||||||||
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. | ||||||||
EvidenceReport.section.focus | |||||||||
Element Id | EvidenceReport.section.focus | ||||||||
Definition | A code identifying the kind of content contained within the section. This should be consistent with the section title. | ||||||||
Short Display | Classification of section (recommended) | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Report Section Type (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Requirements | Provides computable standardized labels to sections within the document. | ||||||||
Summary | false | ||||||||
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. | ||||||||
EvidenceReport.section.focusReference | |||||||||
Element Id | EvidenceReport.section.focusReference | ||||||||
Definition | A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title. | ||||||||
Short Display | Classification of section by Resource | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Any) | ||||||||
Summary | false | ||||||||
EvidenceReport.section.author | |||||||||
Element Id | EvidenceReport.section.author | ||||||||
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||||||||
Short Display | Who and/or what authored the section | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | Group | Organization) | ||||||||
Requirements | Identifies who is responsible for the content. | ||||||||
Summary | false | ||||||||
EvidenceReport.section.text | |||||||||
Element Id | EvidenceReport.section.text | ||||||||
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is peferred to contain sufficient detail to make it acceptable for a human to just read the narrative. | ||||||||
Short Display | Text summary of the section, for human interpretation | ||||||||
Cardinality | 0..1 | ||||||||
Type | Narrative | ||||||||
Summary | false | ||||||||
Comments | Document profiles may define what content should be represented in the narrative. | ||||||||
EvidenceReport.section.mode | |||||||||
Element Id | EvidenceReport.section.mode | ||||||||
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. | ||||||||
Short Display | working | snapshot | changes | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | List Mode (Required) | ||||||||
Type | code | ||||||||
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. | ||||||||
Summary | false | ||||||||
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. | ||||||||
EvidenceReport.section.orderedBy | |||||||||
Element Id | EvidenceReport.section.orderedBy | ||||||||
Definition | Specifies the order applied to the items in the section entries. | ||||||||
Short Display | Order of section entries | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | List Order Codes (Preferred) | ||||||||
Type | CodeableConcept | ||||||||
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. | ||||||||
Summary | false | ||||||||
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. | ||||||||
EvidenceReport.section.entryClassifier | |||||||||
Element Id | EvidenceReport.section.entryClassifier | ||||||||
Definition | Specifies any type of classification of the evidence report. | ||||||||
Short Display | Extensible classifiers as content | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Evidence Classifier (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Requirements | May be used in searching and filtering, or may be the key content of the report. | ||||||||
Summary | false | ||||||||
EvidenceReport.section.entryReference | |||||||||
Element Id | EvidenceReport.section.entryReference | ||||||||
Definition | A reference to the actual resource from which the narrative in the section is derived. | ||||||||
Short Display | Reference to resources as content | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Any) | ||||||||
Summary | false | ||||||||
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. | ||||||||
EvidenceReport.section.entryQuantity | |||||||||
Element Id | EvidenceReport.section.entryQuantity | ||||||||
Definition | Quantity as content. | ||||||||
Short Display | Quantity as content | ||||||||
Cardinality | 0..* | ||||||||
Type | Quantity | ||||||||
Summary | false | ||||||||
EvidenceReport.section.emptyReason | |||||||||
Element Id | EvidenceReport.section.emptyReason | ||||||||
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. | ||||||||
Short Display | Why the section is empty | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | List Empty Reasons (Preferred) | ||||||||
Type | CodeableConcept | ||||||||
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. | ||||||||
Summary | false | ||||||||
Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. | ||||||||
EvidenceReport.section.section | |||||||||
Element Id | EvidenceReport.section.section | ||||||||
Definition | A nested sub-section within this section. | ||||||||
Short Display | Nested Section | ||||||||
Cardinality | 0..* | ||||||||
Type | See EvidenceReport.section | ||||||||
Summary | false | ||||||||
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |