Release 5 Ballot
Clinical ReasoningThis page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: 1 | 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.
Ballot question: The EvidenceVariable Resource has been modified to support expressions of complex eligibility criteria for implementer communities seeking alternatives to Group Resource for eligibility criteria for clinical trials. With these changes, the current EvidenceVariable Resource has greater flexibility than the Group Resource for Population specification. Please submit a ballot comment to note if you support a proposed change to the EvidenceVariable Scope and Usage to delete "As an exception, the Population specification will NOT use the EvidenceVariable Resource" and "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.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EvidenceVariable | TU | DomainResource | 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 Interfaces Implemented: MetadataResource | |
  url | ΣC | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
 identifier | Σ | 0..* | Identifier | Additional identifier for the evidence variable |
| version | Σ | 0..1 | string | Business version of the evidence variable |
| name | ΣC | 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) |
| experimental | 0..1 | boolean | For testing purposes, not real usage | |
| date | Σ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 0..1 | string | Name of the publisher/steward (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 |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the resource was approved by publisher | |
| lastReviewDate | 0..1 | date | When the resource was last reviewed | |
| effectivePeriod | 0..1 | Period | When the resource is expected to be used | |
| 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. | |
| actual | 0..1 | boolean | Actual or conceptual | |
  characteristic | ΣC | 0..* | BackboneElement | A defining factor of the EvidenceVariable + Rule: In a characteristic, at most one of these seven elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionExpression or definitionId or definitionByTypeAndValue or definitionByCombination |
 linkId | 0..1 | id | Label for internal linking | |
| description | 0..1 | string | Natural language description of the characteristic | |
| note | 0..* | Annotation | Used for footnotes or explanatory notes | |
| exclude | 0..1 | boolean | Whether the characteristic is an inclusion criterion or exclusion criterion | |
 definitionReference | ΣC | 0..1 | Reference(EvidenceVariable | Group | Evidence) | Defines the characteristic (without using type and value) by a Reference |
| definitionCanonical | ΣC | 0..1 | canonical(EvidenceVariable | Evidence) | Defines the characteristic (without using type and value) by a Canonical |
| definitionCodeableConcept | ΣC | 0..1 | CodeableConcept | Defines the characteristic (without using type and value) by a CodeableConcept |
| definitionExpression | ΣC | 0..1 | Expression | Defines the characteristic (without using type and value) by a Expression |
| definitionId | ΣC | 0..1 | id | Defines the characteristic (without using type and value) by a id |
| definitionByTypeAndValue | ΣC | 0..1 | BackboneElement | Defines the characteristic using type and value |
| type | Σ | 1..1 | CodeableConcept | Expresses the type of characteristic UsageContextType (Example) |
| method | 0..* | CodeableConcept | Method for how the characteristic value was determined DefinitionMethod (Example) | |
| device | 0..1 | Reference(Device | DeviceMetric) | Device used for determining characteristic | |
 value[x] | Σ | 1..1 | Defines the characteristic when coupled with characteristic.type | |
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference() | |||
 valueId | id | |||
| offset | 0..1 | CodeableConcept | Reference point for valueQuantity CharacteristicOffset (Example) | |
| definitionByCombination | C | 0..1 | BackboneElement | Used to specify how two or more characteristics are combined |
| code | 1..1 | code | all-of | any-of | at-least | at-most | statistical | net-effect | dataset CharacteristicCombination (Required) | |
| threshold | 0..1 | positiveInt | Provides the value of "n" when "at-least" or "at-most" codes are used | |
 characteristic | 1..* | see characteristic | A defining factor of the characteristic | |
 timeFromEvent | 0..* | BackboneElement | Observation time from study specified event | |
 description | 0..1 | string | Human readable description | |
| note | 0..* | Annotation | Used for footnotes or explanatory notes | |
| event[x] | 0..1 | The event used as a base point (reference point) in time EvidenceVariableEvent (Example) | ||
| eventCodeableConcept | CodeableConcept | |||
| eventReference | Reference() | |||
| eventDateTime | dateTime | |||
| eventId | id | |||
| 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 | |
| handling | 0..1 | code | continuous | dichotomous | ordinal | polychotomous EvidenceVariableHandling (Required) | |
| category | 0..* | BackboneElement | A grouping for ordinal or polychotomous variables | |
| name | 0..1 | string | Description of the grouping | |
| value[x] | 0..1 | Definition of the grouping | ||
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| Documentation for this format | ||||
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<EvidenceVariable xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <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]"/><!-- I 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 --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (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> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <approvalDate value="[date]"/><!-- 0..1 When the resource was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the resource was last reviewed --> <effectivePeriod><!-- 0..1 Period When the resource is expected to be used --></effectivePeriod> <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> <actual value="[boolean]"/><!-- 0..1 Actual or conceptual --> <characteristic> <!-- 0..* A defining factor of the EvidenceVariable --> <linkId value="[id]"/><!-- 0..1 Label for internal linking --> <description value="[string]"/><!-- 0..1 Natural language description of the characteristic --> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion --> <definitionReference><!-- I 0..1 Reference(Evidence|EvidenceVariable|Group) Defines the characteristic (without using type and value) by a Reference --></definitionReference> <definitionCanonical><!-- I 0..1 canonical(Evidence|EvidenceVariable) Defines the characteristic (without using type and value) by a Canonical --></definitionCanonical> <definitionCodeableConcept><!-- I 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept --></definitionCodeableConcept> <definitionExpression><!-- I 0..1 Expression Defines the characteristic (without using type and value) by a Expression --></definitionExpression> <definitionId value="[id]"/><!-- I 0..1 Defines the characteristic (without using type and value) by a id --> <definitionByTypeAndValue> <!-- I 0..1 Defines the characteristic using type and value --> <type><!-- 1..1 CodeableConcept Expresses the type of characteristic --></type> <method><!-- 0..* CodeableConcept Method for how the characteristic value was determined --></method> <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device> <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference|id Defines the characteristic when coupled with characteristic.type --></value[x]> <offset><!-- 0..1 CodeableConcept Reference point for valueQuantity --></offset> </definitionByTypeAndValue> <definitionByCombination> <!-- I 0..1 Used to specify how two or more characteristics are combined --> <code value="[code]"/><!-- 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset --> <threshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used --> <characteristic><!-- 1..* Content as for EvidenceVariable.characteristic A defining factor of the characteristic --></characteristic> </definitionByCombination> <timeFromEvent> <!-- 0..* Observation time from study specified event --> <description value="[string]"/><!-- 0..1 Human readable description --> <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note> <event[x]><!-- 0..1 CodeableConcept|Reference|dateTime|id The event used as a base point (reference point) in time --></event[x]> <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> </timeFromEvent> </characteristic> <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous --> <category> <!-- 0..* A grouping for ordinal or polychotomous variables --> <name value="[string]"/><!-- 0..1 Description of the grouping --> <value[x]><!-- 0..1 CodeableConcept|Quantity|Range Definition of the grouping --></value[x]> </category> </EvidenceVariable>
JSON Template
{
"resourceType" : "EvidenceVariable",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"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>", // I 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
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher/steward (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
"copyright" : "<markdown>", // Use and/or publishing restrictions
"approvalDate" : "<date>", // When the resource was approved by publisher
"lastReviewDate" : "<date>", // When the resource was last reviewed
"effectivePeriod" : { Period }, // When the resource is expected to be used
"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.
"actual" : <boolean>, // Actual or conceptual
"characteristic" : [{ // A defining factor of the EvidenceVariable
"linkId" : "<id>", // Label for internal linking
"description" : "<string>", // Natural language description of the characteristic
"note" : [{ Annotation }], // Used for footnotes or explanatory notes
"exclude" : <boolean>, // Whether the characteristic is an inclusion criterion or exclusion criterion
"definitionReference" : { Reference(Evidence|EvidenceVariable|Group) }, // I Defines the characteristic (without using type and value) by a Reference
"definitionCanonical" : "<canonical(EvidenceVariable|Evidence)>", // I Defines the characteristic (without using type and value) by a Canonical
"definitionCodeableConcept" : { CodeableConcept }, // I Defines the characteristic (without using type and value) by a CodeableConcept
"definitionExpression" : { Expression }, // I Defines the characteristic (without using type and value) by a Expression
"definitionId" : "<id>", // I Defines the characteristic (without using type and value) by a id
"definitionByTypeAndValue" : { // I Defines the characteristic using type and value
"type" : { CodeableConcept }, // R! Expresses the type of characteristic
"method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
"device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
// value[x]: Defines the characteristic when coupled with characteristic.type. One of these 6:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueReference" : { Reference },
"valueId" : "<id>",
"offset" : { CodeableConcept } // Reference point for valueQuantity
},
"definitionByCombination" : { // I Used to specify how two or more characteristics are combined
"code" : "<code>", // R! all-of | any-of | at-least | at-most | statistical | net-effect | dataset
"threshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
"characteristic" : [{ Content as for EvidenceVariable.characteristic }] // R! A defining factor of the characteristic
},
"timeFromEvent" : [{ // Observation time from study specified event
"description" : "<string>", // Human readable description
"note" : [{ Annotation }], // Used for footnotes or explanatory notes
// event[x]: The event used as a base point (reference point) in time. One of these 4:
"eventCodeableConcept" : { CodeableConcept },
"eventReference" : { Reference },
"eventDateTime" : "<dateTime>",
"eventId" : "<id>",
"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
}]
}],
"handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
"category" : [{ // A grouping for ordinal or polychotomous variables
"name" : "<string>", // Description of the grouping
// value[x]: Definition of the grouping. One of these 3:
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
"valueRange" : { Range }
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R4
| EvidenceVariable | |
| EvidenceVariable.experimental |
|
| EvidenceVariable.actual |
|
| EvidenceVariable.characteristic |
|
| EvidenceVariable.characteristic.linkId |
|
| EvidenceVariable.characteristic.note |
|
| EvidenceVariable.characteristic.definitionReference |
|
| EvidenceVariable.characteristic.definitionCanonical |
|
| EvidenceVariable.characteristic.definitionCodeableConcept |
|
| EvidenceVariable.characteristic.definitionExpression |
|
| EvidenceVariable.characteristic.definitionId |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.type |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.method |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.device |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.value[x] |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.offset |
|
| EvidenceVariable.characteristic.definitionByCombination |
|
| EvidenceVariable.characteristic.definitionByCombination.code |
|
| EvidenceVariable.characteristic.definitionByCombination.threshold |
|
| EvidenceVariable.characteristic.definitionByCombination.characteristic |
|
| EvidenceVariable.characteristic.timeFromEvent |
|
| EvidenceVariable.characteristic.timeFromEvent.description |
|
| EvidenceVariable.characteristic.timeFromEvent.note |
|
| EvidenceVariable.characteristic.timeFromEvent.event[x] |
|
| EvidenceVariable.characteristic.timeFromEvent.quantity |
|
| EvidenceVariable.characteristic.timeFromEvent.range |
|
| EvidenceVariable.handling |
|
| EvidenceVariable.category |
|
| EvidenceVariable.category.name |
|
| EvidenceVariable.category.value[x] |
|
| EvidenceVariable.jurisdiction |
|
| EvidenceVariable.topic |
|
| EvidenceVariable.type |
|
| EvidenceVariable.characteristic.definition[x] |
|
| EvidenceVariable.characteristic.usageContext |
|
| EvidenceVariable.characteristic.participantEffective[x] |
|
| EvidenceVariable.characteristic.timeFromStart |
|
| EvidenceVariable.characteristic.groupMeasure |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EvidenceVariable | TU | DomainResource | 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 Interfaces Implemented: MetadataResource | |
| url | ΣC | 0..1 | uri | Canonical identifier for this evidence variable, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
| identifier | Σ | 0..* | Identifier | Additional identifier for the evidence variable |
| version | Σ | 0..1 | string | Business version of the evidence variable |
| name | ΣC | 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) |
| experimental | 0..1 | boolean | For testing purposes, not real usage | |
| date | Σ | 0..1 | dateTime | Date last changed |
| publisher | Σ | 0..1 | string | Name of the publisher/steward (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 |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| approvalDate | 0..1 | date | When the resource was approved by publisher | |
| lastReviewDate | 0..1 | date | When the resource was last reviewed | |
| effectivePeriod | 0..1 | Period | When the resource is expected to be used | |
| 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. | |
| actual | 0..1 | boolean | Actual or conceptual | |
| characteristic | ΣC | 0..* | BackboneElement | A defining factor of the EvidenceVariable + Rule: In a characteristic, at most one of these seven elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionExpression or definitionId or definitionByTypeAndValue or definitionByCombination |
| linkId | 0..1 | id | Label for internal linking | |
| description | 0..1 | string | Natural language description of the characteristic | |
| note | 0..* | Annotation | Used for footnotes or explanatory notes | |
| exclude | 0..1 | boolean | Whether the characteristic is an inclusion criterion or exclusion criterion | |
| definitionReference | ΣC | 0..1 | Reference(EvidenceVariable | Group | Evidence) | Defines the characteristic (without using type and value) by a Reference |
| definitionCanonical | ΣC | 0..1 | canonical(EvidenceVariable | Evidence) | Defines the characteristic (without using type and value) by a Canonical |
| definitionCodeableConcept | ΣC | 0..1 | CodeableConcept | Defines the characteristic (without using type and value) by a CodeableConcept |
| definitionExpression | ΣC | 0..1 | Expression | Defines the characteristic (without using type and value) by a Expression |
| definitionId | ΣC | 0..1 | id | Defines the characteristic (without using type and value) by a id |
| definitionByTypeAndValue | ΣC | 0..1 | BackboneElement | Defines the characteristic using type and value |
| type | Σ | 1..1 | CodeableConcept | Expresses the type of characteristic UsageContextType (Example) |
| method | 0..* | CodeableConcept | Method for how the characteristic value was determined DefinitionMethod (Example) | |
| device | 0..1 | Reference(Device | DeviceMetric) | Device used for determining characteristic | |
| value[x] | Σ | 1..1 | Defines the characteristic when coupled with characteristic.type | |
| valueCodeableConcept | CodeableConcept | |||
| valueBoolean | boolean | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference() | |||
| valueId | id | |||
| offset | 0..1 | CodeableConcept | Reference point for valueQuantity CharacteristicOffset (Example) | |
| definitionByCombination | C | 0..1 | BackboneElement | Used to specify how two or more characteristics are combined |
| code | 1..1 | code | all-of | any-of | at-least | at-most | statistical | net-effect | dataset CharacteristicCombination (Required) | |
| threshold | 0..1 | positiveInt | Provides the value of "n" when "at-least" or "at-most" codes are used | |
| characteristic | 1..* | see characteristic | A defining factor of the characteristic | |
| timeFromEvent | 0..* | BackboneElement | Observation time from study specified event | |
| description | 0..1 | string | Human readable description | |
| note | 0..* | Annotation | Used for footnotes or explanatory notes | |
| event[x] | 0..1 | The event used as a base point (reference point) in time EvidenceVariableEvent (Example) | ||
| eventCodeableConcept | CodeableConcept | |||
| eventReference | Reference() | |||
| eventDateTime | dateTime | |||
| eventId | id | |||
| 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 | |
| handling | 0..1 | code | continuous | dichotomous | ordinal | polychotomous EvidenceVariableHandling (Required) | |
| category | 0..* | BackboneElement | A grouping for ordinal or polychotomous variables | |
| name | 0..1 | string | Description of the grouping | |
| value[x] | 0..1 | Definition of the grouping | ||
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| Documentation for this format | ||||
See the Extensions for this resource
XML Template
<EvidenceVariable xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "EvidenceVariable",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"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>", // I 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
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher/steward (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
"copyright" : "<markdown>", // Use and/or publishing restrictions
"approvalDate" : "<date>", // When the resource was approved by publisher
"lastReviewDate" : "<date>", // When the resource was last reviewed
"effectivePeriod" : { Period }, // When the resource is expected to be used
"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.
"actual" : <boolean>, // Actual or conceptual
"characteristic" : [{ // A defining factor of the EvidenceVariable
"linkId" : "<id>", // Label for internal linking
"description" : "<string>", // Natural language description of the characteristic
"note" : [{ Annotation }], // Used for footnotes or explanatory notes
"exclude" : <boolean>, // Whether the characteristic is an inclusion criterion or exclusion criterion
"definitionReference" : { Reference(Evidence|EvidenceVariable|Group) }, // I Defines the characteristic (without using type and value) by a Reference
"definitionCanonical" : "<canonical(EvidenceVariable|Evidence)>", // I Defines the characteristic (without using type and value) by a Canonical
"definitionCodeableConcept" : { CodeableConcept }, // I Defines the characteristic (without using type and value) by a CodeableConcept
"definitionExpression" : { Expression }, // I Defines the characteristic (without using type and value) by a Expression
"definitionId" : "<id>", // I Defines the characteristic (without using type and value) by a id
"definitionByTypeAndValue" : { // I Defines the characteristic using type and value
"type" : { CodeableConcept }, // R! Expresses the type of characteristic
"method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
"device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
// value[x]: Defines the characteristic when coupled with characteristic.type. One of these 6:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valueReference" : { Reference },
"valueId" : "<id>",
"offset" : { CodeableConcept } // Reference point for valueQuantity
},
"definitionByCombination" : { // I Used to specify how two or more characteristics are combined
"code" : "<code>", // R! all-of | any-of | at-least | at-most | statistical | net-effect | dataset
"threshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
"characteristic" : [{ Content as for EvidenceVariable.characteristic }] // R! A defining factor of the characteristic
},
"timeFromEvent" : [{ // Observation time from study specified event
"description" : "<string>", // Human readable description
"note" : [{ Annotation }], // Used for footnotes or explanatory notes
// event[x]: The event used as a base point (reference point) in time. One of these 4:
"eventCodeableConcept" : { CodeableConcept },
"eventReference" : { Reference },
"eventDateTime" : "<dateTime>",
"eventId" : "<id>",
"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
}]
}],
"handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
"category" : [{ // A grouping for ordinal or polychotomous variables
"name" : "<string>", // Description of the grouping
// value[x]: Definition of the grouping. One of these 3:
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
"valueRange" : { Range }
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since Release 4
| EvidenceVariable | |
| EvidenceVariable.experimental |
|
| EvidenceVariable.actual |
|
| EvidenceVariable.characteristic |
|
| EvidenceVariable.characteristic.linkId |
|
| EvidenceVariable.characteristic.note |
|
| EvidenceVariable.characteristic.definitionReference |
|
| EvidenceVariable.characteristic.definitionCanonical |
|
| EvidenceVariable.characteristic.definitionCodeableConcept |
|
| EvidenceVariable.characteristic.definitionExpression |
|
| EvidenceVariable.characteristic.definitionId |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.type |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.method |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.device |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.value[x] |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.offset |
|
| EvidenceVariable.characteristic.definitionByCombination |
|
| EvidenceVariable.characteristic.definitionByCombination.code |
|
| EvidenceVariable.characteristic.definitionByCombination.threshold |
|
| EvidenceVariable.characteristic.definitionByCombination.characteristic |
|
| EvidenceVariable.characteristic.timeFromEvent |
|
| EvidenceVariable.characteristic.timeFromEvent.description |
|
| EvidenceVariable.characteristic.timeFromEvent.note |
|
| EvidenceVariable.characteristic.timeFromEvent.event[x] |
|
| EvidenceVariable.characteristic.timeFromEvent.quantity |
|
| EvidenceVariable.characteristic.timeFromEvent.range |
|
| EvidenceVariable.handling |
|
| EvidenceVariable.category |
|
| EvidenceVariable.category.name |
|
| EvidenceVariable.category.value[x] |
|
| EvidenceVariable.jurisdiction |
|
| EvidenceVariable.topic |
|
| EvidenceVariable.type |
|
| EvidenceVariable.characteristic.definition[x] |
|
| EvidenceVariable.characteristic.usageContext |
|
| EvidenceVariable.characteristic.participantEffective[x] |
|
| EvidenceVariable.characteristic.timeFromStart |
|
| EvidenceVariable.characteristic.groupMeasure |
|
See the Full Difference for further information
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| EvidenceVariable.status | The lifecycle status of an artifact. | Required | PublicationStatus |
| EvidenceVariable.characteristic.definitionByTypeAndValue.type | A code that specifies a type of context being specified by a usage context. | Example | UsageContextType |
| EvidenceVariable.characteristic.definitionByTypeAndValue.method | The method used to define, describe, or determine a characteristic value. | Example | DefinitionMethod |
| EvidenceVariable.characteristic.definitionByTypeAndValue.offset | Reference point for characteristic.valueQuantity. | Example | CharacteristicOffset |
| EvidenceVariable.characteristic.definitionByCombination.code | Logical grouping of characteristics. | Required | CharacteristicCombination |
| EvidenceVariable.characteristic.timeFromEvent.event[x] | The event used as a base point (reference point) in time. | Example | EvidenceVariableEvent |
| EvidenceVariable.handling | The handling of the variable in statistical analysis for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). | Required | EvidenceVariableHandling |
| UniqueKey | 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.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}') |
| cnl-1 | Warning | EvidenceVariable.url | URL should not contain | or # - these characters make processing canonical references problematic | url.matches('([^|#])*') |
| evv-1 | Rule | EvidenceVariable.characteristic | In a characteristic, at most one of these seven elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionExpression or definitionId or definitionByTypeAndValue or definitionByCombination | (definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionExpression.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count()) < 2 |
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.ofType(Quantity) | value.ofType(Range) | |
| context-type-value | composite | A use context type and value assigned to the evidence variable | On EvidenceVariable.useContext: context-type: code context: value.ofType(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 | |
| identifier | token | External identifier for the evidence variable | EvidenceVariable.identifier | |
| 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 | ||
| url N | uri | The uri that identifies the evidence variable | EvidenceVariable.url | |
| version N | token | The business version of the evidence variable | EvidenceVariable.version |
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 05:03+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change