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 |
The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.
The scope of the EvidenceVariable resource is to describe an element that knowledge (evidence) is about. The EvidenceVariable resources are expected to be used with Evidence resources to facilitate searching and knowledge representation.
Evidence may be reported for different types of knowledge. One commonly used format for expression of what evidence is about is the "PICO" format. PICO stands for:
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 EvidenceVariable resource allows expression of the components of a PICO question in codeable and reusable formats. As an exception, the Population specification will NOT use the EvidenceVariable resource. The Population specification will use the Group resource to facilitate interoperability in matching Evidence resources to actual groups.
The resource describing evidence findings (Evidence) will reference EvidenceVariable to describe what the evidence findings are about.
This resource is referenced by Evidence and itself.
This resource implements the Definition pattern.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EvidenceVariable | TU | MetadataResource | A definition of an exposure, outcome, or other variable + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod | |
url | Σ | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the evidence variable |
version | Σ | 0..1 | string | Business version of the evidence variable |
name | ΣI | 0..1 | string | Name for this evidence variable (computer friendly) |
title | Σ | 0..1 | string | Name for this evidence variable (human friendly) |
shortTitle | Σ | 0..1 | string | Title for use in informal contexts |
subtitle | 0..1 | string | Subordinate title of the EvidenceVariable | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the evidence variable |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for evidence variable (if applicable) Jurisdiction (Extensible) |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the evidence variable was approved by publisher | |
lastReviewDate | 0..1 | date | When the evidence variable was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the evidence variable is expected to be used |
topic | 0..* | CodeableConcept | The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
type | Σ | 0..1 | code | dichotomous | continuous | descriptive EvidenceVariableType (Required) |
actual | 0..1 | boolean | Actual or conceptual | |
characteristicCombination | 0..1 | code | intersection | union CharacteristicCombination (Required) | |
characteristic | Σ | 0..* | BackboneElement | What defines the members of the evidence element |
description | 0..1 | string | Natural language description of the characteristic | |
definition[x] | Σ | 1..1 | What code or expression defines members? | |
definitionReference | Reference(Group | EvidenceVariable) | |||
definitionCanonical | canonical(Any) | |||
definitionCodeableConcept | CodeableConcept | |||
definitionExpression | Expression | |||
method | 0..1 | CodeableConcept | Method used for describing characteristic CharacteristicMethod (Example) | |
device | 0..1 | Reference(Device | DeviceMetric) | Device used for determining characteristic | |
exclude | 0..1 | boolean | Whether the characteristic includes or excludes members | |
timeFromStart | 0..1 | BackboneElement | Observation time from study start | |
description | 0..1 | string | Human readable description | |
quantity | 0..1 | Quantity | Used to express the observation at a defined amount of time after the study start | |
range | 0..1 | Range | Used to express the observation within a period after the study start | |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
groupMeasure | 0..1 | code | mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median GroupMeasure (Required) | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<EvidenceVariable xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier> <version value="[string]"/><!-- 0..1 Business version of the evidence variable --> <name value="[string]"/><!-- 0..1 Name for this evidence variable (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this evidence variable (human friendly) --> <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the evidence variable --> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for evidence variable (if applicable) --></jurisdiction> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the evidence variable was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the evidence variable was last reviewed --> <effectivePeriod><!-- 0..1 Period When the evidence variable is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <type value="[code]"/><!-- 0..1 dichotomous | continuous | descriptive --> <actual value="[boolean]"/><!-- 0..1 Actual or conceptual --> <characteristicCombination value="[code]"/><!-- 0..1 intersection | union --> <characteristic> <!-- 0..* What defines the members of the evidence element --> <description value="[string]"/><!-- 0..1 Natural language description of the characteristic --> <definition[x]><!-- 1..1 Reference(EvidenceVariable|Group)|canonical(Any)| CodeableConcept|Expression What code or expression defines members? --></definition[x]> <method><!-- 0..1 CodeableConcept Method used for describing characteristic --></method> <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device> <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members --> <timeFromStart> <!-- 0..1 Observation time from study start --> <description value="[string]"/><!-- 0..1 Human readable description --> <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity> <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> </timeFromStart> <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median --> </characteristic> </EvidenceVariable>
JSON Template
{ "resourceType" : "EvidenceVariable", // from Resource: id, meta, implicitRules, and language "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the evidence variable "version" : "<string>", // Business version of the evidence variable "name" : "<string>", // C? Name for this evidence variable (computer friendly) "title" : "<string>", // Name for this evidence variable (human friendly) "shortTitle" : "<string>", // Title for use in informal contexts "subtitle" : "<string>", // Subordinate title of the EvidenceVariable "status" : "<code>", // R! draft | active | retired | unknown "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the evidence variable "note" : [{ Annotation }], // Used for footnotes or explanatory notes "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for evidence variable (if applicable) "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the evidence variable was approved by publisher "lastReviewDate" : "<date>", // When the evidence variable was last reviewed "effectivePeriod" : { Period }, // When the evidence variable is expected to be used "topic" : [{ CodeableConcept }], // The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // Who authored the content "editor" : [{ ContactDetail }], // Who edited the content "reviewer" : [{ ContactDetail }], // Who reviewed the content "endorser" : [{ ContactDetail }], // Who endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc. "type" : "<code>", // dichotomous | continuous | descriptive "actual" : <boolean>, // Actual or conceptual "characteristicCombination" : "<code>", // intersection | union "characteristic" : [{ // What defines the members of the evidence element "description" : "<string>", // Natural language description of the characteristic // definition[x]: What code or expression defines members?. One of these 4: "definitionReference" : { Reference(EvidenceVariable|Group) }, "definitionCanonical" : { canonical(Any) }, "definitionCodeableConcept" : { CodeableConcept }, "definitionExpression" : { Expression }, "method" : { CodeableConcept }, // Method used for describing characteristic "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic "exclude" : <boolean>, // Whether the characteristic includes or excludes members "timeFromStart" : { // Observation time from study start "description" : "<string>", // Human readable description "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start "range" : { Range }, // Used to express the observation within a period after the study start "note" : [{ Annotation }] // Used for footnotes or explanatory notes }, "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:EvidenceVariable; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable fhir:EvidenceVariable.name [ string ]; # 0..1 Name for this evidence variable (computer friendly) fhir:EvidenceVariable.title [ string ]; # 0..1 Name for this evidence variable (human friendly) fhir:EvidenceVariable.shortTitle [ string ]; # 0..1 Title for use in informal contexts fhir:EvidenceVariable.subtitle [ string ]; # 0..1 Subordinate title of the EvidenceVariable fhir:EvidenceVariable.status [ code ]; # 1..1 draft | active | retired | unknown fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:EvidenceVariable.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for evidence variable (if applicable) fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the evidence variable was approved by publisher fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the evidence variable was last reviewed fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the evidence variable is expected to be used fhir:EvidenceVariable.topic [ CodeableConcept ], ... ; # 0..* The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:EvidenceVariable.type [ code ]; # 0..1 dichotomous | continuous | descriptive fhir:EvidenceVariable.actual [ boolean ]; # 0..1 Actual or conceptual fhir:EvidenceVariable.characteristicCombination [ code ]; # 0..1 intersection | union fhir:EvidenceVariable.characteristic [ # 0..* What defines the members of the evidence element fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic # EvidenceVariable.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 4 fhir:EvidenceVariable.characteristic.definitionReference [ Reference(EvidenceVariable|Group) ] fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Any) ] fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ] fhir:EvidenceVariable.characteristic.method [ CodeableConcept ]; # 0..1 Method used for describing characteristic fhir:EvidenceVariable.characteristic.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members fhir:EvidenceVariable.characteristic.timeFromStart [ # 0..1 Observation time from study start fhir:EvidenceVariable.characteristic.timeFromStart.description [ string ]; # 0..1 Human readable description fhir:EvidenceVariable.characteristic.timeFromStart.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start fhir:EvidenceVariable.characteristic.timeFromStart.range [ Range ]; # 0..1 Used to express the observation within a period after the study start fhir:EvidenceVariable.characteristic.timeFromStart.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes ]; fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median ], ...; ]
Changes since R3
EvidenceVariable | |
EvidenceVariable.status |
|
EvidenceVariable.type |
|
EvidenceVariable.actual |
|
EvidenceVariable.characteristicCombination |
|
EvidenceVariable.characteristic |
|
EvidenceVariable.characteristic.definition[x] |
|
EvidenceVariable.characteristic.method |
|
EvidenceVariable.characteristic.device |
|
EvidenceVariable.characteristic.timeFromStart |
|
EvidenceVariable.characteristic.timeFromStart.description |
|
EvidenceVariable.characteristic.timeFromStart.quantity |
|
EvidenceVariable.characteristic.timeFromStart.range |
|
EvidenceVariable.characteristic.timeFromStart.note |
|
EvidenceVariable.characteristic.groupMeasure |
|
EvidenceVariable.characteristic.usageContext |
|
EvidenceVariable.characteristic.participantEffective[x] |
|
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
EvidenceVariable | TU | MetadataResource | A definition of an exposure, outcome, or other variable + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod | |
url | Σ | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the evidence variable |
version | Σ | 0..1 | string | Business version of the evidence variable |
name | ΣI | 0..1 | string | Name for this evidence variable (computer friendly) |
title | Σ | 0..1 | string | Name for this evidence variable (human friendly) |
shortTitle | Σ | 0..1 | string | Title for use in informal contexts |
subtitle | 0..1 | string | Subordinate title of the EvidenceVariable | |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | Σ | 0..1 | markdown | Natural language description of the evidence variable |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for evidence variable (if applicable) Jurisdiction (Extensible) |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
approvalDate | 0..1 | date | When the evidence variable was approved by publisher | |
lastReviewDate | 0..1 | date | When the evidence variable was last reviewed | |
effectivePeriod | Σ | 0..1 | Period | When the evidence variable is expected to be used |
topic | 0..* | CodeableConcept | The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. DefinitionTopic (Example) | |
author | 0..* | ContactDetail | Who authored the content | |
editor | 0..* | ContactDetail | Who edited the content | |
reviewer | 0..* | ContactDetail | Who reviewed the content | |
endorser | 0..* | ContactDetail | Who endorsed the content | |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. | |
type | Σ | 0..1 | code | dichotomous | continuous | descriptive EvidenceVariableType (Required) |
actual | 0..1 | boolean | Actual or conceptual | |
characteristicCombination | 0..1 | code | intersection | union CharacteristicCombination (Required) | |
characteristic | Σ | 0..* | BackboneElement | What defines the members of the evidence element |
description | 0..1 | string | Natural language description of the characteristic | |
definition[x] | Σ | 1..1 | What code or expression defines members? | |
definitionReference | Reference(Group | EvidenceVariable) | |||
definitionCanonical | canonical(Any) | |||
definitionCodeableConcept | CodeableConcept | |||
definitionExpression | Expression | |||
method | 0..1 | CodeableConcept | Method used for describing characteristic CharacteristicMethod (Example) | |
device | 0..1 | Reference(Device | DeviceMetric) | Device used for determining characteristic | |
exclude | 0..1 | boolean | Whether the characteristic includes or excludes members | |
timeFromStart | 0..1 | BackboneElement | Observation time from study start | |
description | 0..1 | string | Human readable description | |
quantity | 0..1 | Quantity | Used to express the observation at a defined amount of time after the study start | |
range | 0..1 | Range | Used to express the observation within a period after the study start | |
note | 0..* | Annotation | Used for footnotes or explanatory notes | |
groupMeasure | 0..1 | code | mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median GroupMeasure (Required) | |
Documentation for this format |
XML Template
<EvidenceVariable xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) --> <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier> <version value="[string]"/><!-- 0..1 Business version of the evidence variable --> <name value="[string]"/><!-- 0..1 Name for this evidence variable (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this evidence variable (human friendly) --> <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts --> <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!-- 0..1 Natural language description of the evidence variable --> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for evidence variable (if applicable) --></jurisdiction> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the evidence variable was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the evidence variable was last reviewed --> <effectivePeriod><!-- 0..1 Period When the evidence variable is expected to be used --></effectivePeriod> <topic><!-- 0..* CodeableConcept The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. --></topic> <author><!-- 0..* ContactDetail Who authored the content --></author> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact> <type value="[code]"/><!-- 0..1 dichotomous | continuous | descriptive --> <actual value="[boolean]"/><!-- 0..1 Actual or conceptual --> <characteristicCombination value="[code]"/><!-- 0..1 intersection | union --> <characteristic> <!-- 0..* What defines the members of the evidence element --> <description value="[string]"/><!-- 0..1 Natural language description of the characteristic --> <definition[x]><!-- 1..1 Reference(EvidenceVariable|Group)|canonical(Any)| CodeableConcept|Expression What code or expression defines members? --></definition[x]> <method><!-- 0..1 CodeableConcept Method used for describing characteristic --></method> <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device> <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members --> <timeFromStart> <!-- 0..1 Observation time from study start --> <description value="[string]"/><!-- 0..1 Human readable description --> <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity> <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> </timeFromStart> <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median --> </characteristic> </EvidenceVariable>
JSON Template
{ "resourceType" : "EvidenceVariable", // from Resource: id, meta, implicitRules, and language "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique) "identifier" : [{ Identifier }], // Additional identifier for the evidence variable "version" : "<string>", // Business version of the evidence variable "name" : "<string>", // C? Name for this evidence variable (computer friendly) "title" : "<string>", // Name for this evidence variable (human friendly) "shortTitle" : "<string>", // Title for use in informal contexts "subtitle" : "<string>", // Subordinate title of the EvidenceVariable "status" : "<code>", // R! draft | active | retired | unknown "date" : "<dateTime>", // Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // Natural language description of the evidence variable "note" : [{ Annotation }], // Used for footnotes or explanatory notes "useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for evidence variable (if applicable) "copyright" : "<markdown>", // Use and/or publishing restrictions "approvalDate" : "<date>", // When the evidence variable was approved by publisher "lastReviewDate" : "<date>", // When the evidence variable was last reviewed "effectivePeriod" : { Period }, // When the evidence variable is expected to be used "topic" : [{ CodeableConcept }], // The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. "author" : [{ ContactDetail }], // Who authored the content "editor" : [{ ContactDetail }], // Who edited the content "reviewer" : [{ ContactDetail }], // Who reviewed the content "endorser" : [{ ContactDetail }], // Who endorsed the content "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc. "type" : "<code>", // dichotomous | continuous | descriptive "actual" : <boolean>, // Actual or conceptual "characteristicCombination" : "<code>", // intersection | union "characteristic" : [{ // What defines the members of the evidence element "description" : "<string>", // Natural language description of the characteristic // definition[x]: What code or expression defines members?. One of these 4: "definitionReference" : { Reference(EvidenceVariable|Group) }, "definitionCanonical" : { canonical(Any) }, "definitionCodeableConcept" : { CodeableConcept }, "definitionExpression" : { Expression }, "method" : { CodeableConcept }, // Method used for describing characteristic "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic "exclude" : <boolean>, // Whether the characteristic includes or excludes members "timeFromStart" : { // Observation time from study start "description" : "<string>", // Human readable description "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start "range" : { Range }, // Used to express the observation within a period after the study start "note" : [{ Annotation }] // Used for footnotes or explanatory notes }, "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:EvidenceVariable; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable fhir:EvidenceVariable.name [ string ]; # 0..1 Name for this evidence variable (computer friendly) fhir:EvidenceVariable.title [ string ]; # 0..1 Name for this evidence variable (human friendly) fhir:EvidenceVariable.shortTitle [ string ]; # 0..1 Title for use in informal contexts fhir:EvidenceVariable.subtitle [ string ]; # 0..1 Subordinate title of the EvidenceVariable fhir:EvidenceVariable.status [ code ]; # 1..1 draft | active | retired | unknown fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:EvidenceVariable.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for evidence variable (if applicable) fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the evidence variable was approved by publisher fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the evidence variable was last reviewed fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the evidence variable is expected to be used fhir:EvidenceVariable.topic [ CodeableConcept ], ... ; # 0..* The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc. fhir:EvidenceVariable.type [ code ]; # 0..1 dichotomous | continuous | descriptive fhir:EvidenceVariable.actual [ boolean ]; # 0..1 Actual or conceptual fhir:EvidenceVariable.characteristicCombination [ code ]; # 0..1 intersection | union fhir:EvidenceVariable.characteristic [ # 0..* What defines the members of the evidence element fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic # EvidenceVariable.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 4 fhir:EvidenceVariable.characteristic.definitionReference [ Reference(EvidenceVariable|Group) ] fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Any) ] fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ] fhir:EvidenceVariable.characteristic.method [ CodeableConcept ]; # 0..1 Method used for describing characteristic fhir:EvidenceVariable.characteristic.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members fhir:EvidenceVariable.characteristic.timeFromStart [ # 0..1 Observation time from study start fhir:EvidenceVariable.characteristic.timeFromStart.description [ string ]; # 0..1 Human readable description fhir:EvidenceVariable.characteristic.timeFromStart.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start fhir:EvidenceVariable.characteristic.timeFromStart.range [ Range ]; # 0..1 Used to express the observation within a period after the study start fhir:EvidenceVariable.characteristic.timeFromStart.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes ]; fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median ], ...; ]
Changes since Release 3
EvidenceVariable | |
EvidenceVariable.status |
|
EvidenceVariable.type |
|
EvidenceVariable.actual |
|
EvidenceVariable.characteristicCombination |
|
EvidenceVariable.characteristic |
|
EvidenceVariable.characteristic.definition[x] |
|
EvidenceVariable.characteristic.method |
|
EvidenceVariable.characteristic.device |
|
EvidenceVariable.characteristic.timeFromStart |
|
EvidenceVariable.characteristic.timeFromStart.description |
|
EvidenceVariable.characteristic.timeFromStart.quantity |
|
EvidenceVariable.characteristic.timeFromStart.range |
|
EvidenceVariable.characteristic.timeFromStart.note |
|
EvidenceVariable.characteristic.groupMeasure |
|
EvidenceVariable.characteristic.usageContext |
|
EvidenceVariable.characteristic.participantEffective[x] |
|
See the Full Difference for further information
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a
Path | Definition | Type | Reference |
---|---|---|---|
EvidenceVariable.status | The lifecycle status of an artifact. | Required | PublicationStatus |
EvidenceVariable.jurisdiction | Countries and regions within which this artifact is targeted for use. | Extensible | Jurisdiction ValueSet |
EvidenceVariable.topic | High-level categorization of the definition, used for searching, sorting, and filtering. | Example | DefinitionTopic |
EvidenceVariable.type | The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). | Required | EvidenceVariableType |
EvidenceVariable.characteristicCombination | Logical grouping of characteristics. | Required | CharacteristicCombination |
EvidenceVariable.characteristic.method | The method used to determine the characteristic(s) of the variable. | Example | CharacteristicMethod |
EvidenceVariable.characteristic.groupMeasure | Possible group measure aggregates (E.g. Mean, Median). | Required | GroupMeasure |
id | Level | Location | Description | Expression |
cnl-0 | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
composed-of | reference | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='composed-of').resource (Any) | |
context | token | A use context assigned to the evidence variable | (EvidenceVariable.useContext.value as CodeableConcept) | |
context-quantity | quantity | A quantity- or range-valued use context assigned to the evidence variable | (EvidenceVariable.useContext.value as Quantity) | (EvidenceVariable.useContext.value as Range) | |
context-type | token | A type of use context assigned to the evidence variable | EvidenceVariable.useContext.code | |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the evidence variable | On EvidenceVariable.useContext: context-type: code context-quantity: value.as(Quantity) | value.as(Range) | |
context-type-value | composite | A use context type and value assigned to the evidence variable | On EvidenceVariable.useContext: context-type: code context: value.as(CodeableConcept) | |
date N | date | The evidence variable publication date | EvidenceVariable.date | |
depends-on | reference | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='depends-on').resource (Any) | |
derived-from | reference | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='derived-from').resource (Any) | |
description N | string | The description of the evidence variable | EvidenceVariable.description | |
effective | date | The time during which the evidence variable is intended to be in use | EvidenceVariable.effectivePeriod | |
identifier | token | External identifier for the evidence variable | EvidenceVariable.identifier | |
jurisdiction | token | Intended jurisdiction for the evidence variable | EvidenceVariable.jurisdiction | |
name N | string | Computationally friendly name of the evidence variable | EvidenceVariable.name | |
predecessor | reference | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='predecessor').resource (Any) | |
publisher N | string | Name of the publisher of the evidence variable | EvidenceVariable.publisher | |
status N | token | The current status of the evidence variable | EvidenceVariable.status | |
successor | reference | What resource is being referenced | EvidenceVariable.relatedArtifact.where(type='successor').resource (Any) | |
title N | string | The human-friendly name of the evidence variable | EvidenceVariable.title | |
topic | token | Topics associated with the EvidenceVariable | EvidenceVariable.topic | |
url N | uri | The uri that identifies the evidence variable | EvidenceVariable.url | |
version N | token | The business version of the evidence variable | EvidenceVariable.version |