This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Clinical Decision Support Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the EvidenceVariable resource.
EvidenceVariable | |||||||||
Element Id | EvidenceVariable | ||||||||
Definition | The EvidenceVariable resource describes an element that knowledge (Evidence) is about. | ||||||||
Cardinality | 0..* | ||||||||
Type | MetadataResource | ||||||||
Requirements | Need to be able to define and reuse the definition of individual elements of a research question. | ||||||||
Comments | The EvidenceVariable may be an exposure variable (intervention, condition, or state), a measured variable (outcome or observed parameter), or other variable (such as confounding factor). | ||||||||
Invariants |
| ||||||||
EvidenceVariable.url | |||||||||
Element Id | EvidenceVariable.url | ||||||||
Definition | An absolute URI that is used to identify this evidence variable 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 variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers. | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Requirements | Allows the evidence variable 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. 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. 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 element to indicate where the current master source of the resource can be found. | ||||||||
EvidenceVariable.identifier | |||||||||
Element Id | EvidenceVariable.identifier | ||||||||
Definition | A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
Summary | true | ||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this evidence variable outside of FHIR, where it is not possible to use the logical URI. | ||||||||
EvidenceVariable.version | |||||||||
Element Id | EvidenceVariable.version | ||||||||
Definition | The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable 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. | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | There may be different evidence variable 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 variable with the format [url]|[version]. | ||||||||
EvidenceVariable.name | |||||||||
Element Id | EvidenceVariable.name | ||||||||
Definition | A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Support human navigation and code generation. | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
Invariants |
| ||||||||
To Do | Note: This was added back in because this is a metadata resource and it's a required element for metadata resource searching. | ||||||||
EvidenceVariable.title | |||||||||
Element Id | EvidenceVariable.title | ||||||||
Definition | A short, descriptive, user-friendly title for the evidence variable. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
EvidenceVariable.shortTitle | |||||||||
Element Id | EvidenceVariable.shortTitle | ||||||||
Definition | The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content. | ||||||||
Summary | true | ||||||||
EvidenceVariable.subtitle | |||||||||
Element Id | EvidenceVariable.subtitle | ||||||||
Definition | An explanatory or alternate title for the EvidenceVariable giving additional information about its content. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
EvidenceVariable.status | |||||||||
Element Id | EvidenceVariable.status | ||||||||
Definition | The status of this evidence variable. Enables tracking the life-cycle of the content. | ||||||||
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) | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of evidence variables that are appropriate for use versus not. | ||||||||
EvidenceVariable.date | |||||||||
Element Id | EvidenceVariable.date | ||||||||
Definition | The date (and optionally time) when the evidence variable 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 variable changes. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Alternate Names | Revision Date | ||||||||
Summary | true | ||||||||
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the evidence variable. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||||||
EvidenceVariable.publisher | |||||||||
Element Id | EvidenceVariable.publisher | ||||||||
Definition | The name of the organization or individual that published the evidence variable. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the evidence variable. May also allow for contact. | ||||||||
Summary | true | ||||||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the evidence variable is the organization or individual primarily responsible for the maintenance and upkeep of the evidence variable. 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 variable. This item SHOULD be populated unless the information is available from context. | ||||||||
EvidenceVariable.contact | |||||||||
Element Id | EvidenceVariable.contact | ||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||
EvidenceVariable.description | |||||||||
Element Id | EvidenceVariable.description | ||||||||
Definition | A free text natural language description of the evidence variable from a consumer's perspective. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | true | ||||||||
Comments | This description can be used to capture details such as why the evidence variable 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 variable 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 variable is presumed to be the predominant language in the place the evidence variable was created). | ||||||||
EvidenceVariable.note | |||||||||
Element Id | EvidenceVariable.note | ||||||||
Definition | A human-readable string to clarify or explain concepts about the resource. | ||||||||
Cardinality | 0..* | ||||||||
Type | Annotation | ||||||||
EvidenceVariable.useContext | |||||||||
Element Id | EvidenceVariable.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 variable instances. | ||||||||
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. | ||||||||
To Do | Note: This was added back in because this is a metadata resource and it's a required element for metadata resource searching. | ||||||||
EvidenceVariable.jurisdiction | |||||||||
Element Id | EvidenceVariable.jurisdiction | ||||||||
Definition | A legal or geographic region in which the evidence variable is intended to be used. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Jurisdiction (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
Comments | It may be possible for the evidence variable to be used in jurisdictions other than those for which it was originally designed or intended. | ||||||||
To Do | Note: This was added back in because this is a metadata resource and it's a required element for metadata resource searching. | ||||||||
EvidenceVariable.copyright | |||||||||
Element Id | EvidenceVariable.copyright | ||||||||
Definition | A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the evidence variable and/or its content. | ||||||||
Alternate Names | License; Restrictions | ||||||||
EvidenceVariable.approvalDate | |||||||||
Element Id | EvidenceVariable.approvalDate | ||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||
To Do | Consider how this applies to this resource. | ||||||||
EvidenceVariable.lastReviewDate | |||||||||
Element Id | EvidenceVariable.lastReviewDate | ||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||
Comments | If specified, this date follows the original approval date. | ||||||||
To Do | Consider how this applies to this resource. | ||||||||
EvidenceVariable.effectivePeriod | |||||||||
Element Id | EvidenceVariable.effectivePeriod | ||||||||
Definition | The period during which the evidence variable content was or is planned to be in active use. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Period | ||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the evidence variable are or are expected to be used instead. | ||||||||
Summary | true | ||||||||
Comments | The effective period for a evidence variable 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. | ||||||||
To Do | Consider how this applies to this resource. | ||||||||
EvidenceVariable.topic | |||||||||
Element Id | EvidenceVariable.topic | ||||||||
Definition | Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searching. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | DefinitionTopic (Example) | ||||||||
Type | CodeableConcept | ||||||||
Requirements | Repositories must be able to determine how to categorize the EvidenceVariable so that it can be found by topical searches. | ||||||||
To Do | Consider how this applies to this resource. | ||||||||
EvidenceVariable.author | |||||||||
Element Id | EvidenceVariable.author | ||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the content. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
EvidenceVariable.editor | |||||||||
Element Id | EvidenceVariable.editor | ||||||||
Definition | An individual or organization primarily responsible for internal coherence of the content. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
EvidenceVariable.reviewer | |||||||||
Element Id | EvidenceVariable.reviewer | ||||||||
Definition | An individual or organization primarily responsible for review of some aspect of the content. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
EvidenceVariable.endorser | |||||||||
Element Id | EvidenceVariable.endorser | ||||||||
Definition | An individual or organization responsible for officially endorsing the content for use in some setting. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
EvidenceVariable.relatedArtifact | |||||||||
Element Id | EvidenceVariable.relatedArtifact | ||||||||
Definition | Related artifacts such as additional documentation, justification, or bibliographic references. | ||||||||
Cardinality | 0..* | ||||||||
Type | RelatedArtifact | ||||||||
Requirements | EvidenceVariables must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. | ||||||||
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||
To Do | Consider how this applies to this resource. | ||||||||
EvidenceVariable.type | |||||||||
Element Id | EvidenceVariable.type | ||||||||
Definition | Used for an outcome to classify. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | EvidenceVariableType (Required) | ||||||||
Type | code | ||||||||
Summary | true | ||||||||
EvidenceVariable.actual | |||||||||
Element Id | EvidenceVariable.actual | ||||||||
Definition | True if the actual variable measured, false if a conceptual representation of the intended variable. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
EvidenceVariable.characteristicCombination | |||||||||
Element Id | EvidenceVariable.characteristicCombination | ||||||||
Definition | Used to specify if two or more characteristics are combined with OR or AND. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | CharacteristicCombination (Required) | ||||||||
Type | code | ||||||||
EvidenceVariable.characteristic | |||||||||
Element Id | EvidenceVariable.characteristic | ||||||||
Definition | A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics. | ||||||||
Cardinality | 0..* | ||||||||
Summary | true | ||||||||
Comments | Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria. | ||||||||
EvidenceVariable.characteristic.description | |||||||||
Element Id | EvidenceVariable.characteristic.description | ||||||||
Definition | A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Need to be able to describe characteristics in natural language so that end users can understand the criteria. | ||||||||
EvidenceVariable.characteristic.definition[x] | |||||||||
Element Id | EvidenceVariable.characteristic.definition[x] | ||||||||
Definition | Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year). | ||||||||
Cardinality | 1..1 | ||||||||
Type | Reference(Group | EvidenceVariable)|canonical(Any)|CodeableConcept|Expression | ||||||||
Patterns | Reference(Group,EvidenceVariable): No common pattern | ||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||
Requirements | Need to be able to define members in simple codes when the membership aligns well with terminology, with common criteria such as observations in a value set or lab tests within a year, or with expression language to support criteria that do not fit in the above. | ||||||||
Summary | true | ||||||||
EvidenceVariable.characteristic.method | |||||||||
Element Id | EvidenceVariable.characteristic.method | ||||||||
Definition | Method used for describing characteristic. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | CharacteristicMethod (Example) | ||||||||
Type | CodeableConcept | ||||||||
EvidenceVariable.characteristic.device | |||||||||
Element Id | EvidenceVariable.characteristic.device | ||||||||
Definition | Device used for determining characteristic. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Device | DeviceMetric) | ||||||||
Patterns | Reference(Device,DeviceMetric): No common pattern | ||||||||
EvidenceVariable.characteristic.exclude | |||||||||
Element Id | EvidenceVariable.characteristic.exclude | ||||||||
Definition | When true, members with this characteristic are excluded from the element. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Meaning if Missing | False | ||||||||
EvidenceVariable.characteristic.timeFromStart | |||||||||
Element Id | EvidenceVariable.characteristic.timeFromStart | ||||||||
Definition | Indicates duration, period, or point of observation from the participant's study entry. | ||||||||
Cardinality | 0..1 | ||||||||
EvidenceVariable.characteristic.timeFromStart.description | |||||||||
Element Id | EvidenceVariable.characteristic.timeFromStart.description | ||||||||
Definition | A short, natural language description. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
EvidenceVariable.characteristic.timeFromStart.quantity | |||||||||
Element Id | EvidenceVariable.characteristic.timeFromStart.quantity | ||||||||
Definition | Used to express the observation at a defined amount of time after the study start. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Quantity | ||||||||
EvidenceVariable.characteristic.timeFromStart.range | |||||||||
Element Id | EvidenceVariable.characteristic.timeFromStart.range | ||||||||
Definition | Used to express the observation within a period after the study start. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Range | ||||||||
EvidenceVariable.characteristic.timeFromStart.note | |||||||||
Element Id | EvidenceVariable.characteristic.timeFromStart.note | ||||||||
Definition | A human-readable string to clarify or explain concepts about the resource. | ||||||||
Cardinality | 0..* | ||||||||
Type | Annotation | ||||||||
EvidenceVariable.characteristic.groupMeasure | |||||||||
Element Id | EvidenceVariable.characteristic.groupMeasure | ||||||||
Definition | Indicates how elements are aggregated within the study effective period. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | GroupMeasure (Required) | ||||||||
Type | code |