Path | Short | Definition | Comments |
---|---|---|---|
A research context or question | The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about. | ||
url | Canonical identifier for this evidence, represented as a URI (globally unique) | An absolute URI that is used to identify this evidence 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 evidence is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence is stored on different servers. | 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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found. |
identifier | Additional identifier for the evidence | A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance. | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this evidence outside of FHIR, where it is not possible to use the logical URI. |
version | Business version of the evidence | The identifier that is used to identify this version of the evidence when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. | There may be different evidence instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the evidence with the format [url]|[version]. |
name | Name for this evidence (computer friendly) | A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation. | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
title | Name for this evidence (human friendly) | A short, descriptive, user-friendly title for the evidence. | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
shortTitle | Title for use in informal contexts | The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. | |
subtitle | Subordinate title of the Evidence | An explanatory or alternate title for the Evidence giving additional information about its content. | |
status | draft | active | retired | unknown | The status of this evidence. Enables tracking the life-cycle of the content. | Allows filtering of evidences that are appropriate for use versus not. |
date | Date last changed | The date (and optionally time) when the evidence was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence changes. | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the evidence. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
publisher | Name of the publisher (organization or individual) | The name of the organization or individual that published the evidence. | Usually an organization but may be an individual. The publisher (or steward) of the evidence is the organization or individual primarily responsible for the maintenance and upkeep of the evidence. 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. This item SHOULD be populated unless the information is available from context. |
contact | Contact details for the publisher | Contact details to assist a user in finding and communicating with the publisher. | May be a web site, an email address, a telephone number, etc. |
description | Natural language description of the evidence | A free text natural language description of the evidence from a consumer's perspective. | This description can be used to capture details such as why the evidence was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the evidence as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the evidence is presumed to be the predominant language in the place the evidence was created). |
note | Used for footnotes or explanatory notes | A human-readable string to clarify or explain concepts about the resource. | |
useContext | The context that the content is intended to support | 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 instances. | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
jurisdiction | Intended jurisdiction for evidence (if applicable) | A legal or geographic region in which the evidence is intended to be used. | It may be possible for the evidence to be used in jurisdictions other than those for which it was originally designed or intended. |
copyright | Use and/or publishing restrictions | A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence. | |
approvalDate | When the evidence was approved by publisher | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. |
lastReviewDate | When the evidence was last reviewed | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | If specified, this date follows the original approval date. |
effectivePeriod | When the evidence is expected to be used | The period during which the evidence content was or is planned to be in active use. | The effective period for a evidence determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. |
topic | The category of the Evidence, such as Education, Treatment, Assessment, etc. | Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching. | |
author | Who authored the content | An individiual or organization primarily involved in the creation and maintenance of the content. | |
editor | Who edited the content | An individual or organization primarily responsible for internal coherence of the content. | |
reviewer | Who reviewed the content | An individual or organization primarily responsible for review of some aspect of the content. | |
endorser | Who endorsed the content | An individual or organization responsible for officially endorsing the content for use in some setting. | |
relatedArtifact | Additional documentation, citations, etc. | Related artifacts such as additional documentation, justification, or bibliographic references. | Each related artifact is either an attachment, or a reference to another resource, but not both. |
exposureBackground | What population? | A reference to a EvidenceVariable resource that defines the population for the research. | |
exposureVariant | What exposure? | A reference to a EvidenceVariable resource that defines the exposure for the research. | |
outcome | What outcome? | A reference to a EvidenceVariable resomece that defines the outcome for the research. |
The scope of the Evidence resource is to describe the conditional state (population and exposures being considered or compared within a population) with or without the outcomes that knowledge (evidence, assertion, recommendation) is about. The Evidence resource is a commonly bundled series of evidence variables from the "PICO" specification of medical knowledge: Population - the population within which exposures and outcomes are being considered Intervention - the conditional state or exposure state being described for which one is expressing the risk of or effect on an outcome Comparison - the alternative conditional state or alternative exposure state when one is comparing states for the effect on an outcome Outcome - the result or effect of an intervention or exposure in a population PICO (and its variants like PECO or PICOT) is a universal acronym used in evidence-based medicine communities to clearly express research questions and evidence findings. The Evidence resource allows expression of the higher-order concept for recommendations in healthcare where multiple outcomes are considered, and the higher-order concept/combination for framing research questions.
The Evidence resource references the EvidenceVariable resource two or more times to clearly specify the relationship among evidence variable concepts in framing a research question, evidence assertion, or recommendation.
composed-of | What resource is being referenced | Evidence.relatedArtifact.where(type='composed-of').resource |
context | A use context assigned to the evidence | (Evidence.useContext.value as CodeableConcept) |
context-quantity | A quantity- or range-valued use context assigned to the evidence | (Evidence.useContext.value as Quantity) | (Evidence.useContext.value as Range) |
context-type | A type of use context assigned to the evidence | Evidence.useContext.code |
date | The evidence publication date | Evidence.date |
depends-on | What resource is being referenced | Evidence.relatedArtifact.where(type='depends-on').resource |
derived-from | What resource is being referenced | Evidence.relatedArtifact.where(type='derived-from').resource |
description | The description of the evidence | Evidence.description |
effective | The time during which the evidence is intended to be in use | Evidence.effectivePeriod |
identifier | External identifier for the evidence | Evidence.identifier |
jurisdiction | Intended jurisdiction for the evidence | Evidence.jurisdiction |
name | Computationally friendly name of the evidence | Evidence.name |
predecessor | What resource is being referenced | Evidence.relatedArtifact.where(type='predecessor').resource |
publisher | Name of the publisher of the evidence | Evidence.publisher |
status | The current status of the evidence | Evidence.status |
successor | What resource is being referenced | Evidence.relatedArtifact.where(type='successor').resource |
title | The human-friendly name of the evidence | Evidence.title |
topic | Topics associated with the Evidence | Evidence.topic |
url | The uri that identifies the evidence | Evidence.url |
version | The business version of the evidence | Evidence.version |
context-type-quantity | A use context type and quantity- or range-based value assigned to the evidence | Evidence.useContext |
context-type-value | A use context type and value assigned to the evidence | Evidence.useContext |
Explanation of what this profile contains/is for.
Path | Short | Definition | Comments |
---|---|---|---|
A research context or question | The Evidence resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about. | PICO stands for Population (the population within which exposures are being compared), Intervention (the conditional state or exposure state being described for its effect on outcomes), Comparison (the alternative conditional state or alternative exposure state being compared against), and Outcome (the result or effect of the intervention in the population). | |
url | Canonical identifier for this evidence, represented as a URI (globally unique) | An absolute URI that is used to identify this evidence 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 evidence is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence is stored on different servers. | 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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found. |
identifier | Additional identifier for the evidence | A formal identifier that is used to identify this evidence when it is represented in other formats, or referenced in a specification, model, design or an instance. | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this evidence outside of FHIR, where it is not possible to use the logical URI. |
version | Business version of the evidence | The identifier that is used to identify this version of the evidence when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. | There may be different evidence instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the evidence with the format [url]|[version]. |
name | Name for this evidence (computer friendly) | A natural language name identifying the evidence. This name should be usable as an identifier for the module by machine processing applications such as code generation. | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. |
title | Name for this evidence (human friendly) | A short, descriptive, user-friendly title for the evidence. | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
shortTitle | Title for use in informal contexts | The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. | |
subtitle | Subordinate title of the Evidence | An explanatory or alternate title for the Evidence giving additional information about its content. | |
status | draft | active | retired | unknown | The status of this evidence. Enables tracking the life-cycle of the content. | Allows filtering of evidences that are appropriate for use versus not. |
date | Date last changed | The date (and optionally time) when the evidence was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence changes. | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the evidence. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
publisher | Name of the publisher (organization or individual) | The name of the organization or individual that published the evidence. | Usually an organization but may be an individual. The publisher (or steward) of the evidence is the organization or individual primarily responsible for the maintenance and upkeep of the evidence. 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. This item SHOULD be populated unless the information is available from context. |
contact | Contact details for the publisher | Contact details to assist a user in finding and communicating with the publisher. | May be a web site, an email address, a telephone number, etc. |
description | Natural language description of the evidence | A free text natural language description of the evidence from a consumer's perspective. | This description can be used to capture details such as why the evidence was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the evidence as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the evidence is presumed to be the predominant language in the place the evidence was created). |
note | Used for footnotes or explanatory notes | A human-readable string to clarify or explain concepts about the resource. | |
useContext | The context that the content is intended to support | 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 instances. | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
jurisdiction | Intended jurisdiction for evidence (if applicable) | A legal or geographic region in which the evidence is intended to be used. | It may be possible for the evidence to be used in jurisdictions other than those for which it was originally designed or intended. |
copyright | Use and/or publishing restrictions | A copyright statement relating to the evidence and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence. | |
approvalDate | When the evidence was approved by publisher | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. |
lastReviewDate | When the evidence was last reviewed | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | If specified, this date follows the original approval date. |
effectivePeriod | When the evidence is expected to be used | The period during which the evidence content was or is planned to be in active use. | The effective period for a evidence determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. |
topic | The category of the Evidence, such as Education, Treatment, Assessment, etc. | Descriptive topics related to the content of the Evidence. Topics provide a high-level categorization grouping types of Evidences that can be useful for filtering and searching. | |
author | Who authored the content | An individiual or organization primarily involved in the creation and maintenance of the content. | |
editor | Who edited the content | An individual or organization primarily responsible for internal coherence of the content. | |
reviewer | Who reviewed the content | An individual or organization primarily responsible for review of some aspect of the content. | |
endorser | Who endorsed the content | An individual or organization responsible for officially endorsing the content for use in some setting. | |
relatedArtifact | Additional documentation, citations, etc. | Related artifacts such as additional documentation, justification, or bibliographic references. | Each related artifact is either an attachment, or a reference to another resource, but not both. |
exposureBackground | What population? | A reference to a EvidenceVariable resource that defines the population for the research. | |
exposureVariant | What exposure? | A reference to a EvidenceVariable resource that defines the exposure for the research. | |
outcome | What outcome? | A reference to a EvidenceVariable resomece that defines the outcome for the research. |