Release 5 Preview #2
Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the EvidenceReport resource.

EvidenceReport
Element IdEvidenceReport
Definition

The EvidenceReport.

Cardinality0..*
TypeMetadataResource
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
EvidenceReport.url
Element IdEvidenceReport.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 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.

Cardinality0..1
Typeuri
Requirements

Allows the EvidenceReport to be referenced by a single globally unique identifier.

Summarytrue
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.

EvidenceReport.status
Element IdEvidenceReport.status
Definition

The status of this summary. Enables tracking the life-cycle of the content.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (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.

Summarytrue
Comments

Allows filtering of summaries that are appropriate for use versus not.

EvidenceReport.useContext
Element IdEvidenceReport.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.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

EvidenceReport.identifier
Element IdEvidenceReport.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable identifiers to be associated with this EvidenceReport.

Summarytrue
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 IdEvidenceReport.relatedIdentifier
Definition

A formal identifier that is used to identify things closely related to this EvidenceReport.

Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable identifiers to be associated with this EvidenceReport.

Summarytrue
Comments

May include trial registry identifiers, e.g. NCT04372602 from clinicaltrials.gov. This identifier can be valid for multiple EvidenceReport resources.

EvidenceReport.citeAs
Element IdEvidenceReport.citeAs
Definition

Citation Resource or display of suggested citation for this report.

Cardinality0..1
TypeReference(Citation)
Comments

used for reports for which external citation is expected, such as use in support of scholarly publications.

EvidenceReport.type
Element IdEvidenceReport.type
Definition

Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expression.

Cardinality0..1
Terminology BindingEvidenceReportType (Extensible)
TypeCodeableConcept
Requirements

May be used in searching and filtering.

EvidenceReport.note
Element IdEvidenceReport.note
Definition

Used for footnotes and annotations.

Cardinality0..*
TypeAnnotation
EvidenceReport.relatedArtifact
Element IdEvidenceReport.relatedArtifact
Definition

Link, description or reference to artifact associated with the report.

Cardinality0..*
TypeRelatedArtifact
EvidenceReport.subject
Element IdEvidenceReport.subject
Definition

Specifies the subject or focus of the report. Answers "What is this report about?".

Cardinality1..1
Requirements

Expression to match search queries and search results.

Summarytrue
EvidenceReport.subject.characteristic
Element IdEvidenceReport.subject.characteristic
Definition

Characteristic.

Cardinality0..*
EvidenceReport.subject.characteristic.code
Element IdEvidenceReport.subject.characteristic.code
Definition

Characteristic code.

Cardinality1..1
Terminology BindingFocusCharacteristicCode (Extensible)
TypeCodeableConcept
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 IdEvidenceReport.subject.characteristic.value[x]
Definition

Characteristic value.

Cardinality1..1
TypeReference(Any)|CodeableConcept|boolean|Quantity|Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Example 1 is Citation #37. Example 2 is selecting clinical outcomes. Example 3 is 1-year mortality.

EvidenceReport.subject.characteristic.exclude
Element IdEvidenceReport.subject.characteristic.exclude
Definition

Is used to express not the characteristic.

Cardinality0..1
Typeboolean
EvidenceReport.subject.characteristic.period
Element IdEvidenceReport.subject.characteristic.period
Definition

Timeframe for the characteristic.

Cardinality0..1
TypePeriod
EvidenceReport.subject.note
Element IdEvidenceReport.subject.note
Definition

Used for general notes and annotations not coded elsewhere.

Cardinality0..*
TypeAnnotation
EvidenceReport.publisher
Element IdEvidenceReport.publisher
Definition

The name of the organization or individual that published the evidence report.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the evidence report. May also allow for contact.

Summarytrue
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 IdEvidenceReport.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/clinicalreasoning-module.html).

EvidenceReport.author
Element IdEvidenceReport.author
Definition

An individiual, organization, or device primarily involved in the creation and maintenance of the content.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/clinicalreasoning-module.html).

EvidenceReport.editor
Element IdEvidenceReport.editor
Definition

An individiual, organization, or device primarily responsible for internal coherence of the content.

Cardinality0..*
TypeContactDetail
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/clinicalreasoning-module.html).

EvidenceReport.reviewer
Element IdEvidenceReport.reviewer
Definition

An individiual, organization, or device primarily responsible for review of some aspect of the content.

Cardinality0..*
TypeContactDetail
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/clinicalreasoning-module.html).

EvidenceReport.endorser
Element IdEvidenceReport.endorser
Definition

An individiual, organization, or device responsible for officially endorsing the content for use in some setting.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (Details at: http://build.fhir.org/clinicalreasoning-module.html).

EvidenceReport.relatesTo
Element IdEvidenceReport.relatesTo
Definition

Relationships that this composition has with other compositions or documents that already exist.

Cardinality0..*
Comments

A document is a version specific composition.

EvidenceReport.relatesTo.code
Element IdEvidenceReport.relatesTo.code
Definition

The type of relationship that this composition has with anther composition or document.

Cardinality1..1
Terminology BindingReportRelationshipType (Required)
Typecode
Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

EvidenceReport.relatesTo.target[x]
Element IdEvidenceReport.relatesTo.target[x]
Definition

The target composition/document of this relationship.

Cardinality1..1
TypeIdentifier|Reference(EvidenceReport)
[x] NoteSee Choice of Data Types for further information about how to use [x]
EvidenceReport.section
Element IdEvidenceReport.section
Definition

The root of the sections that make up the composition.

Cardinality0..*
EvidenceReport.section.title
Element IdEvidenceReport.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.

Cardinality0..1
Typestring
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Alternate Namesheader; label; caption
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 IdEvidenceReport.section.focus
Definition

A code identifying the kind of content contained within the section. This should be consistent with the section title.

Cardinality0..1
Terminology BindingReportSectionType (Extensible)
TypeCodeableConcept
Requirements

Provides computable standardized labels to sections within the document.

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 IdEvidenceReport.section.focusReference
Definition

A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section title.

Cardinality0..1
TypeReference(Any)
EvidenceReport.section.author
Element IdEvidenceReport.section.author
Definition

Identifies who is responsible for the information in this section, not necessarily who typed it in.

Cardinality0..*
TypeReference(Person | Device | Group | Organization)
PatternsReference(Person,Device,Group,Organization): No common pattern
Requirements

Identifies who is responsible for the content.

EvidenceReport.section.text
Element IdEvidenceReport.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.

Cardinality0..1
TypeNarrative
Comments

Document profiles may define what content should be represented in the narrative.

EvidenceReport.section.mode
Element IdEvidenceReport.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.

Cardinality0..1
Terminology BindingListMode (Required)
Typecode
Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be misunderstood as a complete list.

EvidenceReport.section.orderedBy
Element IdEvidenceReport.section.orderedBy
Definition

Specifies the order applied to the items in the section entries.

Cardinality0..1
Terminology BindingList Order Codes (Preferred)
TypeCodeableConcept
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

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 IdEvidenceReport.section.entryClassifier
Definition

Specifies any type of classification of the evidence report.

Cardinality0..*
Terminology BindingEvidenceClassifier (Extensible)
TypeCodeableConcept
Requirements

May be used in searching and filtering, or may be the key content of the report.

EvidenceReport.section.entryReference
Element IdEvidenceReport.section.entryReference
Definition

A reference to the actual resource from which the narrative in the section is derived.

Cardinality0..*
TypeReference(Any)
Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

EvidenceReport.section.emptyReason
Element IdEvidenceReport.section.emptyReason
Definition

If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.

Cardinality0..1
Terminology BindingList Empty Reasons (Preferred)
TypeCodeableConcept
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

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 IdEvidenceReport.section.section
Definition

A nested sub-section within this section.

Cardinality0..*
TypeSee EvidenceReport.section
Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.