This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
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
|
|---|---|---|---|---|
|
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 |
|
|
Σ 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 |
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
evidence
variable
|
|
Σ | 0..1 | string |
Business
version
of
the
evidence
variable
|
|
Σ
|
0..1 | string |
Name
for
this
evidence
variable
(computer
friendly)
|
|
Σ | 0..1 | string |
Name
for
this
evidence
variable
(human
friendly)
|
|
Σ | 0..1 | string |
Title
for
use
in
informal
contexts
|
|
0..1 | string |
Subordinate
title
of
the
EvidenceVariable
|
|
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
| 0..1 | boolean |
For
testing
purposes,
not
real
usage
| |
![]() ![]() |
Σ | 0..1 | dateTime |
Date
last
changed
|
| Σ | 0..1 | string |
Name
of
the
publisher/steward
(organization
or
individual)
|
| Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() |
Σ | 0..1 | markdown |
Natural
language
description
of
the
evidence
variable
|
|
0..* | Annotation |
Used
for
footnotes
or
explanatory
notes
|
|
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
| 0..1 | markdown |
Use
and/or
publishing
restrictions
| |
|
|
0..1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
0..* | ContactDetail |
Who
|
|
|
0..* | ContactDetail |
Who
|
|
|
0..* | ContactDetail |
Who
|
|
|
0..* |
|
|
|
|
|
|
|
|
|
0..1 |
|
|
|
|
Σ C | 0..* | BackboneElement |
+ 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 |
|
0..1 | id |
Label
for
internal
linking
| |
![]() ![]() ![]() | 0..1 | string |
Natural
language
description
of
the
characteristic
|
|
|
|
0..* | Annotation |
Used
for
footnotes
or
explanatory
notes
|
![]() ![]() ![]() |
|
0..1 | boolean |
|
|
Σ C | 0..1 |
Reference
(
EvidenceVariable
|
Group
|
|
Defines
the
characteristic
(without
using
type
and
value)
by
a
Reference
|
|
Σ C | 0..1 |
canonical
(
|
Defines
the
characteristic
(without
using
type
and
value)
by
a
Canonical
|
|
Σ C | 0..1 | CodeableConcept |
Defines
the
characteristic
(without
using
type
and
value)
by
a
CodeableConcept
|
|
Σ C | 0..1 | Expression |
Defines
the
characteristic
(without
using
type
and
value)
by
a
Expression
|
|
Σ C | 0..1 | id |
Defines
the
characteristic
(without
using
type
and
value)
by
a
id
|
![]() ![]() ![]() | Σ C | 0..1 | BackboneElement |
Defines
the
characteristic
using
type
and
value
|
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept |
Expresses
the
type
of
characteristic
UsageContextType ( Example ) |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept |
Method
|
|
|
0..1 | Reference ( Device | DeviceMetric ) |
Device
used
for
determining
characteristic
|
|
|
Σ | 1..1 |
Defines
the
characteristic
when
coupled
with
characteristic.type
| |
![]() ![]() ![]() ![]() ![]() |
|
CodeableConcept | ||
![]() ![]() ![]() ![]() ![]() | boolean | |||
|
|
Quantity | ||
| Range | |||
![]() ![]() ![]() ![]() ![]() | Reference () | |||
![]() ![]() ![]() ![]() ![]() | id | |||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
Reference
point
for
valueQuantity
CharacteristicOffset ( Example ) | |
|
C | 0..1 | BackboneElement |
|
|
|
|
CharacteristicCombination ( Required ) |
|
|
0..1 |
|
| |
![]() ![]() ![]() ![]() | 1..* | see characteristic |
A
defining
factor
of
|
|
| 0..* | BackboneElement |
Observation
time
from
study
specified
event
| |
|
0..1 |
|
|
|
|
0..* | Annotation |
Used
for
footnotes
or
explanatory
notes
|
|
|
0..1 |
|
|
|
| CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() | Reference () | |||
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | id | |||
![]() ![]() ![]() ![]() | 0..1 | Quantity |
Used
to
express
the
observation
at
a
defined
amount
of
time
after
the
study
start
| |
![]() ![]() ![]() ![]() | 0..1 | Range |
Used
to
express
the
observation
within
a
period
after
the
study
start
| |
|
|
0..1 | code |
continuous
|
dichotomous
|
ordinal
|
polychotomous
EvidenceVariableHandling ( Required ) |
|
0..* | BackboneElement |
A
grouping
for
ordinal
or
polychotomous
variables
|
|
|
0..1 | string |
Description
of
the
grouping
|
|
|
0..1 |
Definition
of
the
grouping
|
||
|
CodeableConcept | |||
|
Quantity | |||
|
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>< <</contact><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 --><)| </definition[x]> <</method> <</device> < < < <</quantity> <</range> <</note> </timeFromStart> <<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>< < < <</value[x]><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/> .[ a fhir:EvidenceVariable; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir: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 variablefhir:fhir:EvidenceVariable.name [ string ]; # 0..1 I 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.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher/steward (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 supportfhir: fhir:fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the resource was approved by publisher fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the resource was last reviewed fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the resource is expected to be used 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.actual [ boolean ]; # 0..1 Actual or conceptualfhir: fhir:fhir:EvidenceVariable.characteristic [ # 0..* A defining factor of the EvidenceVariable fhir:EvidenceVariable.characteristic.linkId [ id ]; # 0..1 Label for internal linking fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic# . One of these 4 fhir:) ] fhir:) ] fhir: ] fhir: ] fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:EvidenceVariable.characteristic.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion fhir:EvidenceVariable.characteristic.definitionReference [ Reference(Evidence|EvidenceVariable|Group) ]; # 0..1 I Defines the characteristic (without using type and value) by a Reference fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Evidence|EvidenceVariable) ]; # 0..1 I Defines the characteristic (without using type and value) by a Canonical fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]; # 0..1 I Defines the characteristic (without using type and value) by a CodeableConcept fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]; # 0..1 I Defines the characteristic (without using type and value) by a Expression fhir:EvidenceVariable.characteristic.definitionId [ id ]; # 0..1 I Defines the characteristic (without using type and value) by a id fhir:EvidenceVariable.characteristic.definitionByTypeAndValue [ # 0..1 I Defines the characteristic using type and value fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.type [ CodeableConcept ]; # 1..1 Expresses the type of characteristic fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.method [ CodeableConcept ], ... ; # 0..* Method for how the characteristic value was determined fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic # EvidenceVariable.characteristic.definitionByTypeAndValue.value[x] : 1..1 Defines the characteristic when coupled with characteristic.type. One of these 6 fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueBoolean [ boolean ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueQuantity [ Quantity ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueRange [ Range ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueReference [ Reference ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueId [ id ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.offset [ CodeableConcept ]; # 0..1 Reference point for valueQuantity ];fhir:fhir:EvidenceVariable.characteristic.definitionByCombination [ # 0..1 I Used to specify how two or more characteristics are combined fhir:EvidenceVariable.characteristic.definitionByCombination.code [ code ]; # 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset fhir:EvidenceVariable.characteristic.definitionByCombination.threshold [ positiveInt ]; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used fhir:EvidenceVariable.characteristic.definitionByCombination.characteristic [ See EvidenceVariable.characteristic ], ... ; # 1..* A defining factor of the characteristic ]; fhir:EvidenceVariable.characteristic.timeFromEvent [ # 0..* Observation time from study specified event fhir:EvidenceVariable.characteristic.timeFromEvent.description [ string ]; # 0..1 Human readable description fhir:EvidenceVariable.characteristic.timeFromEvent.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes # EvidenceVariable.characteristic.timeFromEvent.event[x] : 0..1 The event used as a base point (reference point) in time. One of these 4 fhir:EvidenceVariable.characteristic.timeFromEvent.eventCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.characteristic.timeFromEvent.eventReference [ Reference ] fhir:EvidenceVariable.characteristic.timeFromEvent.eventDateTime [ dateTime ] fhir:EvidenceVariable.characteristic.timeFromEvent.eventId [ id ] fhir:EvidenceVariable.characteristic.timeFromEvent.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start fhir:EvidenceVariable.characteristic.timeFromEvent.range [ Range ]; # 0..1 Used to express the observation within a period after the study start ], ...; ], ...;fhir: fhir: fhir: # . One of these 3 fhir: ] fhir: ] fhir: ]fhir:EvidenceVariable.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3 fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.category.valueQuantity [ Quantity ] fhir:EvidenceVariable.category.valueRange [ Range ] ], ...; ]
Changes since R4
| EvidenceVariable | |
|
|
|
|
|
|
| EvidenceVariable.characteristic |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 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] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
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 |
|
|
Σ 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 |
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
evidence
variable
|
|
Σ | 0..1 | string |
Business
version
of
the
evidence
variable
|
|
Σ
|
0..1 | string |
Name
for
this
evidence
variable
(computer
friendly)
|
|
Σ | 0..1 | string |
Name
for
this
evidence
variable
(human
friendly)
|
|
Σ | 0..1 | string |
Title
for
use
in
informal
contexts
|
|
0..1 | string |
Subordinate
title
of
the
EvidenceVariable
|
|
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
| 0..1 | boolean |
For
testing
purposes,
not
real
usage
| |
![]() ![]() |
Σ | 0..1 | dateTime |
Date
last
changed
|
| Σ | 0..1 | string |
Name
of
the
publisher/steward
(organization
or
individual)
|
| Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() |
Σ | 0..1 | markdown |
Natural
language
description
of
the
evidence
variable
|
|
0..* | Annotation |
Used
for
footnotes
or
explanatory
notes
|
|
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
| 0..1 | markdown |
Use
and/or
publishing
restrictions
| |
|
|
0..1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
0..* | ContactDetail |
Who
|
|
|
0..* | ContactDetail |
Who
|
|
|
0..* | ContactDetail |
Who
|
|
|
0..* |
|
|
|
|
|
|
|
|
|
0..1 |
|
|
|
|
Σ C | 0..* | BackboneElement |
+ 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 |
|
0..1 | id |
Label
for
internal
linking
| |
![]() ![]() ![]() | 0..1 | string |
Natural
language
description
of
the
characteristic
|
|
|
|
0..* | Annotation |
Used
for
footnotes
or
explanatory
notes
|
![]() ![]() ![]() |
|
0..1 | boolean |
|
|
Σ C | 0..1 |
Reference
(
EvidenceVariable
|
Group
|
|
Defines
the
characteristic
(without
using
type
and
value)
by
a
Reference
|
|
Σ C | 0..1 |
canonical
(
|
Defines
the
characteristic
(without
using
type
and
value)
by
a
Canonical
|
|
Σ C | 0..1 | CodeableConcept |
Defines
the
characteristic
(without
using
type
and
value)
by
a
CodeableConcept
|
|
Σ C | 0..1 | Expression |
Defines
the
characteristic
(without
using
type
and
value)
by
a
Expression
|
|
Σ C | 0..1 | id |
Defines
the
characteristic
(without
using
type
and
value)
by
a
id
|
![]() ![]() ![]() | Σ C | 0..1 | BackboneElement |
Defines
the
characteristic
using
type
and
value
|
![]() ![]() ![]() ![]() | Σ | 1..1 | CodeableConcept |
Expresses
the
type
of
characteristic
UsageContextType ( Example ) |
![]() ![]() ![]() ![]() | 0..* | CodeableConcept |
Method
|
|
|
0..1 | Reference ( Device | DeviceMetric ) |
Device
used
for
determining
characteristic
|
|
|
Σ | 1..1 |
Defines
the
characteristic
when
coupled
with
characteristic.type
| |
![]() ![]() ![]() ![]() ![]() |
|
CodeableConcept | ||
![]() ![]() ![]() ![]() ![]() | boolean | |||
| Quantity |
|
||
| Range | |||
![]() ![]() ![]() ![]() ![]() | Reference () | |||
![]() ![]() ![]() ![]() ![]() | id | |||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept |
Reference
point
for
valueQuantity
CharacteristicOffset ( Example ) | |
|
C | 0..1 | BackboneElement |
|
|
|
|
CharacteristicCombination ( Required ) |
|
|
0..1 |
|
| |
![]() ![]() ![]() ![]() | 1..* | see characteristic |
A
defining
factor
of
|
|
| 0..* | BackboneElement |
Observation
time
from
study
specified
event
| |
|
0..1 |
|
|
|
|
0..* | Annotation |
Used
for
footnotes
or
explanatory
notes
|
|
|
0..1 |
|
|
|
| CodeableConcept | |||
![]() ![]() ![]() ![]() ![]() | Reference () | |||
![]() ![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() ![]() | id | |||
![]() ![]() ![]() ![]() | 0..1 | Quantity |
Used
to
express
the
observation
at
a
defined
amount
of
time
after
the
study
start
| |
![]() ![]() ![]() ![]() | 0..1 | Range |
Used
to
express
the
observation
within
a
period
after
the
study
start
| |
|
|
0..1 | code |
continuous
|
dichotomous
|
ordinal
|
polychotomous
EvidenceVariableHandling ( Required ) |
|
0..* | BackboneElement |
A
grouping
for
ordinal
or
polychotomous
variables
|
|
|
0..1 | string |
Description
of
the
grouping
|
|
|
0..1 |
Definition
of
the
grouping
|
||
|
CodeableConcept | |||
|
Quantity | |||
|
Range | |||
Documentation
for
this
format
|
||||
See the Extensions for this resource
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>< <</contact><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 --><)| </definition[x]> <</method> <</device> < < < <</quantity> <</range> <</note> </timeFromStart> <<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>< < < <</value[x]><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/> .[ a fhir:EvidenceVariable; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension
fhir: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 variablefhir:fhir:EvidenceVariable.name [ string ]; # 0..1 I 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.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher/steward (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 supportfhir: fhir:fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the resource was approved by publisher fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the resource was last reviewed fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the resource is expected to be used 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.actual [ boolean ]; # 0..1 Actual or conceptualfhir: fhir:fhir:EvidenceVariable.characteristic [ # 0..* A defining factor of the EvidenceVariable fhir:EvidenceVariable.characteristic.linkId [ id ]; # 0..1 Label for internal linking fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic# . One of these 4 fhir:) ] fhir:) ] fhir: ] fhir: ] fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir:fhir:EvidenceVariable.characteristic.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion fhir:EvidenceVariable.characteristic.definitionReference [ Reference(Evidence|EvidenceVariable|Group) ]; # 0..1 I Defines the characteristic (without using type and value) by a Reference fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Evidence|EvidenceVariable) ]; # 0..1 I Defines the characteristic (without using type and value) by a Canonical fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]; # 0..1 I Defines the characteristic (without using type and value) by a CodeableConcept fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]; # 0..1 I Defines the characteristic (without using type and value) by a Expression fhir:EvidenceVariable.characteristic.definitionId [ id ]; # 0..1 I Defines the characteristic (without using type and value) by a id fhir:EvidenceVariable.characteristic.definitionByTypeAndValue [ # 0..1 I Defines the characteristic using type and value fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.type [ CodeableConcept ]; # 1..1 Expresses the type of characteristic fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.method [ CodeableConcept ], ... ; # 0..* Method for how the characteristic value was determined fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic # EvidenceVariable.characteristic.definitionByTypeAndValue.value[x] : 1..1 Defines the characteristic when coupled with characteristic.type. One of these 6 fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueBoolean [ boolean ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueQuantity [ Quantity ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueRange [ Range ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueReference [ Reference ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueId [ id ] fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.offset [ CodeableConcept ]; # 0..1 Reference point for valueQuantity ];fhir:fhir:EvidenceVariable.characteristic.definitionByCombination [ # 0..1 I Used to specify how two or more characteristics are combined fhir:EvidenceVariable.characteristic.definitionByCombination.code [ code ]; # 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset fhir:EvidenceVariable.characteristic.definitionByCombination.threshold [ positiveInt ]; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used fhir:EvidenceVariable.characteristic.definitionByCombination.characteristic [ See EvidenceVariable.characteristic ], ... ; # 1..* A defining factor of the characteristic ]; fhir:EvidenceVariable.characteristic.timeFromEvent [ # 0..* Observation time from study specified event fhir:EvidenceVariable.characteristic.timeFromEvent.description [ string ]; # 0..1 Human readable description fhir:EvidenceVariable.characteristic.timeFromEvent.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes # EvidenceVariable.characteristic.timeFromEvent.event[x] : 0..1 The event used as a base point (reference point) in time. One of these 4 fhir:EvidenceVariable.characteristic.timeFromEvent.eventCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.characteristic.timeFromEvent.eventReference [ Reference ] fhir:EvidenceVariable.characteristic.timeFromEvent.eventDateTime [ dateTime ] fhir:EvidenceVariable.characteristic.timeFromEvent.eventId [ id ] fhir:EvidenceVariable.characteristic.timeFromEvent.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start fhir:EvidenceVariable.characteristic.timeFromEvent.range [ Range ]; # 0..1 Used to express the observation within a period after the study start ], ...; ], ...;fhir: fhir: fhir: # . One of these 3 fhir: ] fhir: ] fhir: ]fhir:EvidenceVariable.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3 fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ] fhir:EvidenceVariable.category.valueQuantity [ Quantity ] fhir:EvidenceVariable.category.valueRange [ Range ] ], ...; ]
Changes since Release 4
| EvidenceVariable | |
|
|
|
|
|
|
| EvidenceVariable.characteristic |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.offset |
|
|
|
|
| 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] |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
,
the
extensions
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. |
|
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.method |
The method used to define, describe, or determine a characteristic value. |
Example |
|
| EvidenceVariable.characteristic.definitionByTypeAndValue.offset | Reference point for characteristic.valueQuantity. | Example | CharacteristicOffset |
| EvidenceVariable.characteristic.definitionByCombination.code |
Logical grouping of characteristics. |
Required |
|
| 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 |
|
|
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
|
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: |
|
| context-type-value | composite | A use context type and value assigned to the evidence variable |
On
EvidenceVariable.useContext:
context-type: code context: |
|
| 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 |