R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Clinical Decision Support icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the EvidenceVariable resource.

EvidenceVariable
Element IdEvidenceVariable
Definition

The EvidenceVariable resource describes an element that knowledge (Evidence) is about.

Short DisplayA definition of an exposure, outcome, or other variable
Cardinality0..*
TypeMetadataResource
Requirements

Need to be able to define and reuse the definition of individual elements of a research question.

Summaryfalse
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
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
EvidenceVariable.url
Element IdEvidenceVariable.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 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.

Short DisplayCanonical identifier for this evidence variable, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

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

Summarytrue
Comments

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.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
EvidenceVariable.identifier
Element IdEvidenceVariable.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.

Short DisplayAdditional identifier for the evidence variable
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

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

Short DisplayBusiness version of the evidence variable
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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]. The version SHOULD NOT contain a '#' - see Business Version.

EvidenceVariable.versionAlgorithm[x]
Element IdEvidenceVariable.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 is newer, and a 0 if the version ordering can't successfully be determined.

EvidenceVariable.name
Element IdEvidenceVariable.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.

Short DisplayName for this evidence variable (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
EvidenceVariable.title
Element IdEvidenceVariable.title
Definition

A short, descriptive, user-friendly title for the evidence variable.

Short DisplayName for this evidence variable (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

EvidenceVariable.shortTitle
Element IdEvidenceVariable.shortTitle
Definition

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

Short DisplayTitle for use in informal contexts
Cardinality0..1
Typestring
Requirements

Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.

Summarytrue
EvidenceVariable.status
Element IdEvidenceVariable.status
Definition

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

Short Displaydraft | active | retired | unknown
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)
Summarytrue
Comments

Allows filtering of evidence variables that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

EvidenceVariable.experimental
Element IdEvidenceVariable.experimental
Definition

A Boolean value to indicate that this resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Summaryfalse
EvidenceVariable.date
Element IdEvidenceVariable.date
Definition

The date (and optionally time) when the evidence variable was last significantly changed. 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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

The date is often not tracked until the resource is published, but may be present on draft content. 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.

See guidance around (not) making local changes to elements here.

EvidenceVariable.publisher
Element IdEvidenceVariable.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variable.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

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

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

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

See guidance around (not) making local changes to elements here.

EvidenceVariable.description
Element IdEvidenceVariable.description
Definition

A free text natural language description of the evidence variable from a consumer's perspective.

Short DisplayNatural language description of the evidence variable
Cardinality0..1
Typemarkdown
Summarytrue
Comments

This description can be used to capture details such as 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 IdEvidenceVariable.note
Definition

A human-readable string to clarify or explain concepts about the resource.

Short DisplayUsed for footnotes or explanatory notes
Cardinality0..*
TypeAnnotation
Summaryfalse
EvidenceVariable.useContext
Element IdEvidenceVariable.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.

Short DisplayThe context that the content is intended to support
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.

EvidenceVariable.purpose
Element IdEvidenceVariable.purpose
Definition

Explanation of why this EvidenceVariable is needed and why it has been designed as it has.

Short DisplayWhy this EvidenceVariable is defined
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the EvidenceVariable. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this EvidenceVariable.

EvidenceVariable.copyright
Element IdEvidenceVariable.copyright
Definition

A copyright statement relating to the resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resource.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Summaryfalse
EvidenceVariable.copyrightLabel
Element IdEvidenceVariable.copyrightLabel
Definition

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

EvidenceVariable.approvalDate
Element IdEvidenceVariable.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.

See guidance around (not) making local changes to elements here.

Short DisplayWhen the resource was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
EvidenceVariable.lastReviewDate
Element IdEvidenceVariable.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.

Short DisplayWhen the resource was last reviewed by the publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

EvidenceVariable.effectivePeriod
Element IdEvidenceVariable.effectivePeriod
Definition

The period during which the resource content was or is planned to be in active use.

Short DisplayWhen the resource is expected to be used
Cardinality0..1
TypePeriod
Summaryfalse
Comments

The effective period for an EvidenceVariable determines when the content is applicable for usage and is independent of publication and review dates. For example, a variable intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

EvidenceVariable.author
Element IdEvidenceVariable.author
Definition

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

Short DisplayWho authored the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

EvidenceVariable.editor
Element IdEvidenceVariable.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Short DisplayWho edited the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

EvidenceVariable.reviewer
Element IdEvidenceVariable.reviewer
Definition

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content.

Short DisplayWho reviewed the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

See guidance around (not) making local changes to elements here.

EvidenceVariable.endorser
Element IdEvidenceVariable.endorser
Definition

An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting.

Short DisplayWho endorsed the content
Cardinality0..*
TypeContactDetail
Summaryfalse
Comments

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

See guidance around (not) making local changes to elements here.

EvidenceVariable.relatedArtifact
Element IdEvidenceVariable.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Short DisplayAdditional documentation, citations, etc
Cardinality0..*
TypeRelatedArtifact
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.

Summaryfalse
Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

EvidenceVariable.actual
Element IdEvidenceVariable.actual
Definition

True if the actual variable measured, false if a conceptual representation of the intended variable.

Short DisplayActual or conceptual
Cardinality0..1
Typeboolean
Summaryfalse
EvidenceVariable.definition
Element IdEvidenceVariable.definition
Definition

Defines the variable with a concept and/or Reference.

Short DisplayDefines the variable with a concept and/or Reference
Cardinality0..1
Terminology BindingEvidence Variable Definition (Example)
TypeCodeableReference(Group)
Summarytrue
EvidenceVariable.handling
Element IdEvidenceVariable.handling
Definition

The method of handling in statistical analysis.

Short Displaycontinuous | dichotomous | ordinal | polychotomous
Cardinality0..1
Terminology BindingEvidence Variable Handling (Required)
Typecode
Summaryfalse
EvidenceVariable.category
Element IdEvidenceVariable.category
Definition

A grouping for ordinal or polychotomous variables.

Short DisplayA grouping for ordinal or polychotomous variables
Cardinality0..*
Summaryfalse
EvidenceVariable.category.name
Element IdEvidenceVariable.category.name
Definition

Description of the grouping.

Short DisplayDescription of the grouping
Cardinality0..1
Typestring
Summaryfalse
EvidenceVariable.category.value[x]
Element IdEvidenceVariable.category.value[x]
Definition

Definition of the grouping.

Short DisplayDefinition of the grouping
Cardinality0..1
TypeCodeableConcept|Quantity|Range|Reference(Group)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summaryfalse