Clinical
Reasoning
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
|
Responsible
Owner:
Clinical
Decision
Support
Work
Group
|
|
Security Category : Business | Compartments : No 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
using
E
for
Exposure
or
PICOT)
PICOT
adding
T
for
Timing)
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
EvidenceVariable.definition
element
has
a
CodeableReference
datatype
which
can
define
the
Group
Resource
to
facilitate
interoperability
in
matching
Evidence
Resources
PICO
component
as
a
concept
and/or
reference
to
actual
groups.
a
Group
Resource.
Ballot
question:
The
EvidenceVariable
Resource
has
been
modified
to
support
expressions
of
complex
eligibility
criteria
for
implementer
communities
seeking
alternatives
is
also
used
within
ResearchStudy
to
Group
Resource
for
eligibility
criteria
for
clinical
trials.
With
these
changes,
the
current
EvidenceVariable
Resource
has
greater
flexibility
than
describe
the
Group
Resource
endpoint
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."
outcome
measure.
The Resource describing evidence findings ( Evidence ) will reference EvidenceVariable to describe what the evidence findings are about.
The Resource describing a research study protocol ( ResearchStudy ) will reference EvidenceVariable to describe the endpoint for an outcome measure.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
EvidenceVariable
|
|
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
|
versionAlgorithm[x]
|
Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
versionAlgorithmString
|
string | |||
versionAlgorithmCoding
|
Coding | |||
|
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
|
|
citeAs
| 0..1 | markdown |
Display
of
how
to
cite
this
EvidenceVariable
| |
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
experimental
|
0..1 | boolean |
For
testing
|
|
|
date
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
author
| 0..* | ContactDetail |
Who
authored
the
content
| |
|
publisher
|
Σ | 0..1 | string |
Name
of
the
publisher/steward
(organization
or
individual)
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
recorder
| 0..* | ContactDetail |
Who
entered
the
data
for
the
evidence
variable
| |
|
editor
| 0..* | ContactDetail |
Who
edited
the
content
| |
|
reviewer
| 0..* | ContactDetail |
Who
reviewed
the
content
| |
|
endorser
| 0..* | ContactDetail |
Who
endorsed
the
content
| |
|
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
|
|
purpose
|
0..1 | markdown |
Why
this
EvidenceVariable
is
defined
|
|
|
copyright
|
0..1 | markdown |
Intellectual
property
ownership,
may
include
restrictions
on
use
|
|
|
copyrightLabel
|
T | 0..1 | string |
Copyright
holder
and
year(s)
|
|
approvalDate
|
0..1 | date |
When
the
resource
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
When
the
resource
was
last
reviewed
by
the
publisher
|
|
|
effectivePeriod
|
0..1 | Period |
When
the
resource
is
expected
to
be
used
|
|
relatesTo
|
0..* |
|
Relationships
to
other
Resources
|
|
|
|
|
1..1 |
|
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
|
reprint
|
reprint-of
|
summarizes
Binding: Artifact Relationship Type
(
Extensible
)
|
target[x]
|
1..1 |
|
The
artifact
that
is
related
to
this
EvidenceVariable
|
|
targetUri
|
|
uri | ||
|
targetAttachment
|
Attachment
|
|||
targetCanonical
|
|
canonical ( Any ) | ||
|
targetReference
| Reference ( Any ) |
|
||
|
targetMarkdown
|
|
markdown | ||
|
actual
|
0..1 | boolean |
Actual
or
conceptual
|
|
|
definition
|
Σ
|
0..1 | CodeableReference ( Group ) |
The
meaning
of
the
evidence
variable
Binding: Evidence Variable Definition ( Example ) |
|
definitionModifier
|
0..* | BackboneElement |
Further
specification
of
the
|
|
|
code
|
|
1..1 |
|
Attribute
of
the
definition
Binding: Evidence Variable Definition Modifier Code ( Example ) |
|
value[x]
|
|
1..1 |
|
Specification
of
the
|
|
|
|
|
||
|
|
|
boolean | ||
|
valueQuantity
|
|
|
||
|
valueRange
|
|
|
||
|
|
|
|
||
|
|
|
|
||
|
valueReference
| Reference ( Any ) | |||
|
valueExpression
|
|
|
||
|
valueUri
|
|
|
||
|
handling
|
0..1 | CodeableConcept |
boolean
|
continuous
|
dichotomous
|
ordinal
|
polychotomous
|
time-to-event
|
not-specified
Binding: |
|
|
category
|
0..* |
|
A
grouping
for
|
|
|
name
|
0..1 |
|
Description
of
the
grouping
|
|
|
value[x]
|
0..1 |
Definition
of
the
|
||
|
valueCodeableConcept
|
CodeableConcept | |||
|
valueQuantity
|
Quantity | |||
|
valueRange
|
Range | |||
|
valueReference
|
Reference
|
|||
|
conditional
|
0..1 |
|
Condition
determining
whether
the
data
will
be
collected
|
|
|
|
|
0..* | CodeableConcept |
Classification
Binding: |
|
|
0..* | BackboneElement |
How
the
data
element
(value
of
the
variable)
is
found
|
|
|
datatype
|
|
0..1 |
|
Type
of
data
used
to
express
value
of
the
variable
Binding: |
|
|
0..1 |
|
Where
to
find
the
|
|
|
delimiter
|
|
0..1 |
|
Character(s)
separating
values
in
a
string-based
list
|
component
|
|
0..* | see dataStorage |
|
|
|
0..1 | RelativeTime |
When
the
|
|
|
|
0..1 |
|
Calendar-based
timing
when
the
variable
is
observed
|
|
|
constraint
|
0..* | BackboneElement |
Limit
on
acceptability
of
data
value
|
|
|
conditional
|
0..1 |
|
Condition
determining
whether
this
constraint
applies
Binding: AdministrativeGender ( Example ) |
|
|
minimumQuantity
|
|
0..1 |
|
The
lowest
permissible
value
of
the
variable
|
|
maximumQuantity
|
0..1 | Quantity |
The
|
|
|
earliestDateTime
|
|
0..1 |
|
The
earliest
permissible
value
of
the
variable
|
|
|
0..1 |
|
The
latest
permissible
value
of
the
variable
|
|
|
minimumStringLength
|
0..1 |
|
The
lowest
number
of
characters
allowed
for
a
|
|
|
maximumStringLength
|
0..1 |
|
The
highest
number
of
characters
allowed
for
a
|
|
|
code
|
0..1 |
|
Rule
for
acceptable
data
values
Binding: Evidence Variable |
|
|
expression
|
|
0..1 |
|
Rule
for
|
|
expectedValueSet
|
0..1 |
|
List
of
anticipated
values
used
to
express
value
of
the
|
|
|
expectedUnitsValueSet
|
0..1 | Reference ( ValueSet ) |
List
of
anticipated
values
used
to
express
units
for
the
value
of
the
|
|
|
anyValueAllowed
|
0..1 |
|
Permissibility
of
unanticipated
value
used
to
express
value
of
the
variable
|
|
|
missingDataMeaning
|
0..* |
|
How
missing
data
can
be
interpreted
Binding: Data Absent Reason ( Example ) |
|
|
unacceptableDataHandling
|
0..* |
|
How
erroneous
data
is
processed
Binding: Evidence Variable Unacceptable Data Handling ( Example ) |
|
|
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 --> <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]> <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 -->
< <<citeAs value="[markdown]"/><!-- 0..1 Display of how to cite this EvidenceVariable --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <author><!-- 0..* ContactDetail Who authored the content --></author> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact><<recorder><!-- 0..* ContactDetail Who entered the data for the evidence variable --></recorder> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <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> <purpose value="[markdown]"/><!-- 0..1 Why this EvidenceVariable is defined -->< < <<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.<copyright value="[markdown]"/><!-- 0..1 Intellectual property ownership, may include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the resource was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the resource was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the resource is expected to be used --></effectivePeriod><</author> <</editor> <</reviewer> <</endorser> <</relatedArtifact><relatesTo> <!-- 0..* Relationships to other Resources --> <type><!-- 1..1 CodeableConcept documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes< < < <</note> < <</definitionReference> <</definitionCanonical> <</definitionCodeableConcept> <</definitionExpression> < < <</type> <</method> <</device> <</value[x]> <</offset> </definitionByTypeAndValue> < < < <</characteristic> </definitionByCombination> <</instances[x]> <</duration[x]> < < <</note> <</event[x]> <</quantity> <</range> </timeFromEvent> </characteristic> < <<definition><!-- 0..1 CodeableReference(Group) The meaning of the evidence variable --></definition> <definitionModifier> <!-- 0..* Further specification of the definition --> <code><!-- 1..1 CodeableConcept Attribute of the definition --></code> <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Period|RelativeTime| Reference(Any)|Expression|uri Specification of the definition attribute --></value[x]> </definitionModifier> <handling><!-- 0..1 CodeableConcept boolean | continuous | dichotomous | ordinal | polychotomous | time-to-event | not-specified --></handling> <category> <!-- 0..* A grouping for dichotomous, ordinal, or polychotomouos variables --> <name value="[string]"/><!-- 0..1 Description of the grouping --><</value[x]><value[x]><!-- 0..1 CodeableConcept|Quantity|Range|Reference(Group) Definition of the grouping --></value[x]> </category> <conditional><!-- 0..1 Expression Condition determining whether the data will be collected --></conditional> <classifier><!-- 0..* CodeableConcept Classification --></classifier> <dataStorage> <!-- 0..* How the data element (value of the variable) is found --> <datatype><!-- 0..1 CodeableConcept Type of data used to express value of the variable --></datatype> <path value="[string]"/><!-- 0..1 Where to find the data element in the dataset --> <delimiter value="[string]"/><!-- 0..1 Character(s) separating values in a string-based list --> <component><!-- 0..* Content as for EvidenceVariable.dataStorage --></component> </dataStorage> <timing><!-- 0..1 RelativeTime When the variable is observed --></timing> <period><!-- 0..1 Period Calendar-based timing when the variable is observed --></period> <constraint> <!-- 0..* Limit on acceptability of data value --> <conditional><!-- 0..1 CodeableConcept Condition determining whether this constraint applies --></conditional> <minimumQuantity><!-- 0..1 Quantity The lowest permissible value of the variable --></minimumQuantity> <maximumQuantity><!-- 0..1 Quantity The highest permissible value of the variable --></maximumQuantity> <earliestDateTime value="[dateTime]"/><!-- 0..1 The earliest permissible value of the variable --> <latestDateTime value="[dateTime]"/><!-- 0..1 The latest permissible value of the variable --> <minimumStringLength value="[unsignedInt]"/><!-- 0..1 The lowest number of characters allowed for a value of the variable --> <maximumStringLength value="[positiveInt]"/><!-- 0..1 The highest number of characters allowed for a value of the variable --> <code><!-- 0..1 CodeableConcept Rule for acceptable data values --></code> <expression><!-- 0..1 Expression Rule for acceptable data values, as an Expression --></expression> <expectedValueSet><!-- 0..1 Reference(ValueSet) List of anticipated values used to express value of the variable --></expectedValueSet> <expectedUnitsValueSet><!-- 0..1 Reference(ValueSet) List of anticipated values used to express units for the value of the variable --></expectedUnitsValueSet> <anyValueAllowed value="[boolean]"/><!-- 0..1 Permissibility of unanticipated value used to express value of the variable --> </constraint> <missingDataMeaning><!-- 0..* CodeableConcept How missing data can be interpreted --></missingDataMeaning> <unacceptableDataHandling><!-- 0..* CodeableConcept How erroneous data is processed --></unacceptableDataHandling> </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
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"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
"
"
"citeAs" : "<markdown>", // Display of how to cite this EvidenceVariable
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing only - never for real usage
"date" : "<dateTime>", // Date last changed
"author" : [{ ContactDetail }], // Who authored the content
"publisher" : "<string>", // Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"
"recorder" : [{ ContactDetail }], // Who entered the data for the evidence variable
"editor" : [{ ContactDetail }], // Who edited the content
"reviewer" : [{ ContactDetail }], // Who reviewed the content
"endorser" : [{ ContactDetail }], // Who endorsed the content
"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
"purpose" : "<markdown>", // Why this EvidenceVariable is defined
"
"
"<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
"copyright" : "<markdown>", // Intellectual property ownership, may include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When the resource was approved by publisher
"lastReviewDate" : "<date>", // When the resource was last reviewed by the publisher
"effectivePeriod" : { Period }, // When the resource is expected to be used
"
"
"
"
"
"relatesTo" : [{ // Relationships to other Resources
"type" : { CodeableConcept }, // R! documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
// target[x]: The artifact that is related to this EvidenceVariable. One of these 5:
"targetUri" : "<uri>",
"targetAttachment" : { Attachment },
"targetCanonical" : "<canonical(Any)>",
"targetReference" : { Reference(Any) },
"targetMarkdown" : "<markdown>"
}],
"actual" : <boolean>, // Actual or conceptual
"
"
"
"
"
"
"
"
"
"
"
"
"
"
" },
">,
" },
" },
" },
">",
"
},
"
"
"
"
},
" },
" },
" },
" },
"
"
"
" },
" },
">",
">",
"
"
}]
"definition" : { CodeableReference(Group) }, // The meaning of the evidence variable
"definitionModifier" : [{ // Further specification of the definition
"code" : { CodeableConcept }, // R! Attribute of the definition
// value[x]: Specification of the definition attribute. One of these 9:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valuePeriod" : { Period },
"valueRelativeTime" : { RelativeTime },
"valueReference" : { Reference(Any) },
"valueExpression" : { Expression },
"valueUri" : "<uri>"
}],
"
"
"handling" : { CodeableConcept }, // boolean | continuous | dichotomous | ordinal | polychotomous | time-to-event | not-specified
"category" : [{ // A grouping for dichotomous, ordinal, or polychotomouos variables
"name" : "<string>", // Description of the grouping
// value[x]: Definition of the grouping. One of these 4:
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
" }
}]
"valueRange" : { Range },
"valueReference" : { Reference(Group) }
}],
"conditional" : { Expression }, // Condition determining whether the data will be collected
"classifier" : [{ CodeableConcept }], // Classification
"dataStorage" : [{ // How the data element (value of the variable) is found
"datatype" : { CodeableConcept }, // Type of data used to express value of the variable
"path" : "<string>", // Where to find the data element in the dataset
"delimiter" : "<string>", // Character(s) separating values in a string-based list
"component" : [{ Content as for EvidenceVariable.dataStorage }] //
}],
"timing" : { RelativeTime }, // When the variable is observed
"period" : { Period }, // Calendar-based timing when the variable is observed
"constraint" : [{ // Limit on acceptability of data value
"conditional" : { CodeableConcept }, // Condition determining whether this constraint applies
"minimumQuantity" : { Quantity }, // The lowest permissible value of the variable
"maximumQuantity" : { Quantity }, // The highest permissible value of the variable
"earliestDateTime" : "<dateTime>", // The earliest permissible value of the variable
"latestDateTime" : "<dateTime>", // The latest permissible value of the variable
"minimumStringLength" : "<unsignedInt>", // The lowest number of characters allowed for a value of the variable
"maximumStringLength" : "<positiveInt>", // The highest number of characters allowed for a value of the variable
"code" : { CodeableConcept }, // Rule for acceptable data values
"expression" : { Expression }, // Rule for acceptable data values, as an Expression
"expectedValueSet" : { Reference(ValueSet) }, // List of anticipated values used to express value of the variable
"expectedUnitsValueSet" : { Reference(ValueSet) }, // List of anticipated values used to express units for the value of the variable
"anyValueAllowed" : <boolean> // Permissibility of unanticipated value used to express value of the variable
}],
"missingDataMeaning" : [{ CodeableConcept }], // How missing data can be interpreted
"unacceptableDataHandling" : [{ CodeableConcept }] // How erroneous data is processed
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the evidence variable fhir:version [ string ] ; # 0..1 Business version of the evidence variable # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2fhir: ]fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this evidence variable (computer friendly) fhir:title [ string ] ; # 0..1 Name for this evidence variable (human friendly) fhir:shortTitle [ string ] ; # 0..1 Title for use in informal contextsfhir: fhir:fhir:citeAs [ markdown ] ; # 0..1 Display of how to cite this EvidenceVariable fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisherfhir:fhir:recorder ( [ ContactDetail ] ... ) ; # 0..* Who entered the data for the evidence variable fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the content fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content fhir:description [ markdown ] ; # 0..1 Natural language description of the evidence variable fhir:note ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:purpose [ markdown ] ; # 0..1 Why this EvidenceVariable is definedfhir: fhir: fhir:<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.fhir:copyright [ markdown ] ; # 0..1 Intellectual property ownership, may include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the resource was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the resource was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the resource is expected to be usedfhir: fhir: fhir: fhir: fhir:fhir:relatesTo ( [ # 0..* Relationships to other Resources fhir:type [ CodeableConcept ] ; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes # target[x] : 1..1 The artifact that is related to this EvidenceVariable. One of these 5 fhir:target [ a fhir:Uri ; uri ] fhir:target [ a fhir:Attachment ; Attachment ] fhir:target [ a fhir:Canonical ; canonical(Any) ] fhir:target [ a fhir:Reference ; Reference(Any) ] fhir:target [ a fhir:Markdown ; markdown ] ] ... ) ; fhir:actual [ boolean ] ; # 0..1 Actual or conceptualfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 6 fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] ; fhir: fhir: fhir: fhir: ] ; # . One of these 2 fhir: ] fhir: ] # . One of these 2 fhir: ] fhir: ] fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] fhir: fhir: ] ... ) ;fhir:definition [ CodeableReference(Group) ] ; # 0..1 The meaning of the evidence variable fhir:definitionModifier ( [ # 0..* Further specification of the definition fhir:code [ CodeableConcept ] ; # 1..1 Attribute of the definition # value[x] : 1..1 Specification of the definition attribute. One of these 9 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:RelativeTime ; RelativeTime ] fhir:value [ a fhir:Reference ; Reference(Any) ] fhir:value [ a fhir:Expression ; Expression ] fhir:value [ a fhir:Uri ; uri ] ] ... ) ;fhir: fhir:fhir:handling [ CodeableConcept ] ; # 0..1 boolean | continuous | dichotomous | ordinal | polychotomous | time-to-event | not-specified fhir:category ( [ # 0..* A grouping for dichotomous, ordinal, or polychotomouos variables fhir:name [ string ] ; # 0..1 Description of the grouping# . One of these 3# value[x] : 0..1 Definition of the grouping. One of these 4 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Reference ; Reference(Group) ] ] ... ) ; fhir:conditional [ Expression ] ; # 0..1 Condition determining whether the data will be collected fhir:classifier ( [ CodeableConcept ] ... ) ; # 0..* Classification fhir:dataStorage ( [ # 0..* How the data element (value of the variable) is found fhir:datatype [ CodeableConcept ] ; # 0..1 Type of data used to express value of the variable fhir:path [ string ] ; # 0..1 Where to find the data element in the dataset fhir:delimiter [ string ] ; # 0..1 Character(s) separating values in a string-based list fhir:component ( [ See EvidenceVariable.dataStorage ] ... ) ; # 0..* ] ... ) ; fhir:timing [ RelativeTime ] ; # 0..1 When the variable is observed fhir:period [ Period ] ; # 0..1 Calendar-based timing when the variable is observed fhir:constraint ( [ # 0..* Limit on acceptability of data value fhir:conditional [ CodeableConcept ] ; # 0..1 Condition determining whether this constraint applies fhir:minimumQuantity [ Quantity ] ; # 0..1 The lowest permissible value of the variable fhir:maximumQuantity [ Quantity ] ; # 0..1 The highest permissible value of the variable fhir:earliestDateTime [ dateTime ] ; # 0..1 The earliest permissible value of the variable fhir:latestDateTime [ dateTime ] ; # 0..1 The latest permissible value of the variable fhir:minimumStringLength [ unsignedInt ] ; # 0..1 The lowest number of characters allowed for a value of the variable fhir:maximumStringLength [ positiveInt ] ; # 0..1 The highest number of characters allowed for a value of the variable fhir:code [ CodeableConcept ] ; # 0..1 Rule for acceptable data values fhir:expression [ Expression ] ; # 0..1 Rule for acceptable data values, as an Expression fhir:expectedValueSet [ Reference(ValueSet) ] ; # 0..1 List of anticipated values used to express value of the variable fhir:expectedUnitsValueSet [ Reference(ValueSet) ] ; # 0..1 List of anticipated values used to express units for the value of the variable fhir:anyValueAllowed [ boolean ] ; # 0..1 Permissibility of unanticipated value used to express value of the variable ] ... ) ; fhir:missingDataMeaning ( [ CodeableConcept ] ... ) ; # 0..* How missing data can be interpreted fhir:unacceptableDataHandling ( [ CodeableConcept ] ... ) ; # 0..* How erroneous data is processed ]
Changes from both R4 and R4B
| EvidenceVariable | |
| EvidenceVariable.versionAlgorithm[x] |
|
| EvidenceVariable.citeAs |
|
| EvidenceVariable.experimental |
|
| EvidenceVariable.recorder |
|
| EvidenceVariable.purpose |
|
| EvidenceVariable.copyrightLabel |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| EvidenceVariable.unacceptableDataHandling |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
EvidenceVariable
|
|
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
|
|
versionAlgorithm[x]
|
Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
|
versionAlgorithmString
|
string | |||
|
versionAlgorithmCoding
|
Coding | |||
|
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
|
|
citeAs
| 0..1 | markdown |
Display
of
how
to
cite
this
EvidenceVariable
| |
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
experimental
|
0..1 | boolean |
For
testing
|
|
|
date
|
Σ | 0..1 | dateTime |
Date
last
changed
|
|
author
| 0..* | ContactDetail |
Who
authored
the
content
| |
|
publisher
|
Σ | 0..1 | string |
Name
of
the
publisher/steward
(organization
or
individual)
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
recorder
| 0..* | ContactDetail |
Who
entered
the
data
for
the
evidence
variable
| |
|
editor
| 0..* | ContactDetail |
Who
edited
the
content
| |
|
reviewer
| 0..* | ContactDetail |
Who
reviewed
the
content
| |
|
endorser
| 0..* | ContactDetail |
Who
endorsed
the
content
| |
|
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
|
|
purpose
|
0..1 | markdown |
Why
this
EvidenceVariable
is
defined
|
|
|
copyright
|
0..1 | markdown |
Intellectual
property
ownership,
may
include
restrictions
on
use
|
|
|
copyrightLabel
|
T | 0..1 | string |
Copyright
holder
and
year(s)
|
|
approvalDate
|
0..1 | date |
When
the
resource
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
When
the
resource
was
last
reviewed
by
the
publisher
|
|
|
effectivePeriod
|
0..1 | Period |
When
the
resource
is
expected
to
be
used
|
|
|
relatesTo
|
0..* |
|
Relationships
to
other
Resources
|
|
|
|
|
1..1 |
|
documentation
|
justification
|
citation
|
predecessor
|
successor
|
derived-from
|
depends-on
|
composed-of
|
part-of
|
amends
|
amended-with
|
appends
|
appended-with
|
cites
|
cited-by
|
comments-on
|
comment-in
|
contains
|
contained-in
|
corrects
|
correction-in
|
replaces
|
replaced-with
|
retracts
|
retracted-by
|
signs
|
similar-to
|
supports
|
supported-with
|
transforms
|
transformed-into
|
transformed-with
|
documents
|
specification-of
|
created-with
|
cite-as
|
reprint
|
reprint-of
|
summarizes
Binding: Artifact Relationship Type
(
Extensible
)
|
|
target[x]
|
1..1 |
|
The
artifact
that
is
related
to
this
EvidenceVariable
|
|
|
targetUri
|
|
uri | ||
|
targetAttachment
|
Attachment
|
|||
|
targetCanonical
|
|
canonical ( Any ) | ||
|
targetReference
| Reference ( Any ) |
|
||
|
targetMarkdown
|
|
markdown | ||
|
actual
|
0..1 | boolean |
Actual
or
conceptual
|
|
|
definition
|
Σ
|
0..1 | CodeableReference ( Group ) |
The
meaning
of
the
evidence
variable
Binding: Evidence Variable Definition ( Example ) |
|
definitionModifier
|
0..* | BackboneElement |
Further
specification
of
the
|
|
|
code
|
|
1..1 |
|
Attribute
of
the
definition
Binding: Evidence Variable Definition Modifier Code ( Example ) |
|
value[x]
|
|
1..1 |
|
Specification
of
the
|
|
|
|
|
||
|
|
|
boolean | ||
|
valueQuantity
|
|
|
||
|
valueRange
|
|
|
||
|
|
|
|
||
|
|
|
|
||
|
valueReference
| Reference ( Any ) | |||
|
valueExpression
|
|
|
||
|
valueUri
|
|
|
||
|
handling
|
0..1 | CodeableConcept |
boolean
|
continuous
|
dichotomous
|
ordinal
|
polychotomous
|
time-to-event
|
not-specified
Binding: |
|
|
category
|
0..* |
|
A
grouping
for
|
|
|
name
|
0..1 |
|
Description
of
the
grouping
|
|
|
value[x]
|
0..1 |
Definition
of
the
|
||
|
valueCodeableConcept
|
CodeableConcept | |||
|
valueQuantity
|
Quantity | |||
|
valueRange
|
Range | |||
|
valueReference
|
Reference
|
|||
|
conditional
|
0..1 |
|
Condition
determining
whether
the
data
will
be
collected
|
|
|
|
|
0..* | CodeableConcept |
Classification
Binding: |
|
|
0..* | BackboneElement |
How
the
data
element
(value
of
the
variable)
is
found
|
|
|
datatype
|
|
0..1 |
|
Type
of
data
used
to
express
value
of
the
variable
Binding: |
|
|
0..1 |
|
Where
to
find
the
|
|
|
delimiter
|
|
0..1 |
|
Character(s)
separating
values
in
a
string-based
list
|
|
component
|
|
0..* | see dataStorage |
|
|
|
0..1 | RelativeTime |
When
the
|
|
|
|
0..1 |
|
Calendar-based
timing
when
the
variable
is
observed
|
|
|
constraint
|
0..* | BackboneElement |
Limit
on
acceptability
of
data
value
|
|
|
conditional
|
0..1 |
|
Condition
determining
whether
this
constraint
applies
Binding: AdministrativeGender ( Example ) |
|
|
minimumQuantity
|
|
0..1 |
|
The
lowest
permissible
value
of
the
variable
|
|
maximumQuantity
|
0..1 | Quantity |
The
|
|
|
earliestDateTime
|
|
0..1 |
|
The
earliest
permissible
value
of
the
variable
|
|
|
0..1 |
|
The
latest
permissible
value
of
the
variable
|
|
|
minimumStringLength
|
0..1 |
|
The
lowest
number
of
characters
allowed
for
a
|
|
|
maximumStringLength
|
0..1 |
|
The
highest
number
of
characters
allowed
for
a
|
|
|
code
|
0..1 |
|
Rule
for
acceptable
data
values
Binding: Evidence Variable |
|
|
expression
|
|
0..1 |
|
Rule
for
|
|
expectedValueSet
|
0..1 |
|
List
of
anticipated
values
used
to
express
value
of
the
|
|
|
expectedUnitsValueSet
|
0..1 | Reference ( ValueSet ) |
List
of
anticipated
values
used
to
express
units
for
the
|
|
|
anyValueAllowed
|
0..1 |
|
Permissibility
of
unanticipated
value
used
to
express
value
of
the
variable
|
|
|
missingDataMeaning
|
0..* |
|
How
missing
data
can
be
interpreted
Binding: Data Absent Reason ( Example ) |
|
|
unacceptableDataHandling
|
0..* |
|
How
erroneous
data
is
processed
Binding: Evidence Variable Unacceptable Data Handling ( Example ) |
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<EvidenceVariable xmlns="http://hl7.org/fhir">< <<citeAs value="[markdown]"/><!-- 0..1 Display of how to cite this EvidenceVariable --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing only - never for real usage --> <date value="[dateTime]"/><!-- 0..1 Date last changed --> <author><!-- 0..* ContactDetail Who authored the content --></author> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact><<recorder><!-- 0..* ContactDetail Who entered the data for the evidence variable --></recorder> <editor><!-- 0..* ContactDetail Who edited the content --></editor> <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer> <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser> <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> <purpose value="[markdown]"/><!-- 0..1 Why this EvidenceVariable is defined -->< < <<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.<copyright value="[markdown]"/><!-- 0..1 Intellectual property ownership, may include restrictions on use --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) --> <approvalDate value="[date]"/><!-- 0..1 When the resource was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the resource was last reviewed by the publisher --> <effectivePeriod><!-- 0..1 Period When the resource is expected to be used --></effectivePeriod><</author> <</editor> <</reviewer> <</endorser> <</relatedArtifact><relatesTo> <!-- 0..* Relationships to other Resources --> <type><!-- 1..1 CodeableConcept documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes< < < <</note> < <</definitionReference> <</definitionCanonical> <</definitionCodeableConcept> <</definitionExpression> < < <</type> <</method> <</device> <</value[x]> <</offset> </definitionByTypeAndValue> < < < <</characteristic> </definitionByCombination> <</instances[x]> <</duration[x]> < < <</note> <</event[x]> <</quantity> <</range> </timeFromEvent> </characteristic> < <<definition><!-- 0..1 CodeableReference(Group) The meaning of the evidence variable --></definition> <definitionModifier> <!-- 0..* Further specification of the definition --> <code><!-- 1..1 CodeableConcept Attribute of the definition --></code> <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Period|RelativeTime| Reference(Any)|Expression|uri Specification of the definition attribute --></value[x]> </definitionModifier> <handling><!-- 0..1 CodeableConcept boolean | continuous | dichotomous | ordinal | polychotomous | time-to-event | not-specified --></handling> <category> <!-- 0..* A grouping for dichotomous, ordinal, or polychotomouos variables --> <name value="[string]"/><!-- 0..1 Description of the grouping --><</value[x]><value[x]><!-- 0..1 CodeableConcept|Quantity|Range|Reference(Group) Definition of the grouping --></value[x]> </category> <conditional><!-- 0..1 Expression Condition determining whether the data will be collected --></conditional> <classifier><!-- 0..* CodeableConcept Classification --></classifier> <dataStorage> <!-- 0..* How the data element (value of the variable) is found --> <datatype><!-- 0..1 CodeableConcept Type of data used to express value of the variable --></datatype> <path value="[string]"/><!-- 0..1 Where to find the data element in the dataset --> <delimiter value="[string]"/><!-- 0..1 Character(s) separating values in a string-based list --> <component><!-- 0..* Content as for EvidenceVariable.dataStorage --></component> </dataStorage> <timing><!-- 0..1 RelativeTime When the variable is observed --></timing> <period><!-- 0..1 Period Calendar-based timing when the variable is observed --></period> <constraint> <!-- 0..* Limit on acceptability of data value --> <conditional><!-- 0..1 CodeableConcept Condition determining whether this constraint applies --></conditional> <minimumQuantity><!-- 0..1 Quantity The lowest permissible value of the variable --></minimumQuantity> <maximumQuantity><!-- 0..1 Quantity The highest permissible value of the variable --></maximumQuantity> <earliestDateTime value="[dateTime]"/><!-- 0..1 The earliest permissible value of the variable --> <latestDateTime value="[dateTime]"/><!-- 0..1 The latest permissible value of the variable --> <minimumStringLength value="[unsignedInt]"/><!-- 0..1 The lowest number of characters allowed for a value of the variable --> <maximumStringLength value="[positiveInt]"/><!-- 0..1 The highest number of characters allowed for a value of the variable --> <code><!-- 0..1 CodeableConcept Rule for acceptable data values --></code> <expression><!-- 0..1 Expression Rule for acceptable data values, as an Expression --></expression> <expectedValueSet><!-- 0..1 Reference(ValueSet) List of anticipated values used to express value of the variable --></expectedValueSet> <expectedUnitsValueSet><!-- 0..1 Reference(ValueSet) List of anticipated values used to express units for the value of the variable --></expectedUnitsValueSet> <anyValueAllowed value="[boolean]"/><!-- 0..1 Permissibility of unanticipated value used to express value of the variable --> </constraint> <missingDataMeaning><!-- 0..* CodeableConcept How missing data can be interpreted --></missingDataMeaning> <unacceptableDataHandling><!-- 0..* CodeableConcept How erroneous data is processed --></unacceptableDataHandling> </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
// versionAlgorithm[x]: How to compare versions. One of these 2:
"versionAlgorithmString" : "<string>",
"versionAlgorithmCoding" : { Coding },
"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
"
"
"citeAs" : "<markdown>", // Display of how to cite this EvidenceVariable
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing only - never for real usage
"date" : "<dateTime>", // Date last changed
"author" : [{ ContactDetail }], // Who authored the content
"publisher" : "<string>", // Name of the publisher/steward (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"
"recorder" : [{ ContactDetail }], // Who entered the data for the evidence variable
"editor" : [{ ContactDetail }], // Who edited the content
"reviewer" : [{ ContactDetail }], // Who reviewed the content
"endorser" : [{ ContactDetail }], // Who endorsed the content
"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
"purpose" : "<markdown>", // Why this EvidenceVariable is defined
"
"
"<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
"copyright" : "<markdown>", // Intellectual property ownership, may include restrictions on use
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"approvalDate" : "<date>", // When the resource was approved by publisher
"lastReviewDate" : "<date>", // When the resource was last reviewed by the publisher
"effectivePeriod" : { Period }, // When the resource is expected to be used
"
"
"
"
"
"relatesTo" : [{ // Relationships to other Resources
"type" : { CodeableConcept }, // R! documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
// target[x]: The artifact that is related to this EvidenceVariable. One of these 5:
"targetUri" : "<uri>",
"targetAttachment" : { Attachment },
"targetCanonical" : "<canonical(Any)>",
"targetReference" : { Reference(Any) },
"targetMarkdown" : "<markdown>"
}],
"actual" : <boolean>, // Actual or conceptual
"
"
"
"
"
"
"
"
"
"
"
"
"
"
" },
">,
" },
" },
" },
">",
"
},
"
"
"
"
},
" },
" },
" },
" },
"
"
"
" },
" },
">",
">",
"
"
}]
"definition" : { CodeableReference(Group) }, // The meaning of the evidence variable
"definitionModifier" : [{ // Further specification of the definition
"code" : { CodeableConcept }, // R! Attribute of the definition
// value[x]: Specification of the definition attribute. One of these 9:
"valueCodeableConcept" : { CodeableConcept },
"valueBoolean" : <boolean>,
"valueQuantity" : { Quantity },
"valueRange" : { Range },
"valuePeriod" : { Period },
"valueRelativeTime" : { RelativeTime },
"valueReference" : { Reference(Any) },
"valueExpression" : { Expression },
"valueUri" : "<uri>"
}],
"
"
"handling" : { CodeableConcept }, // boolean | continuous | dichotomous | ordinal | polychotomous | time-to-event | not-specified
"category" : [{ // A grouping for dichotomous, ordinal, or polychotomouos variables
"name" : "<string>", // Description of the grouping
// value[x]: Definition of the grouping. One of these 4:
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
" }
}]
"valueRange" : { Range },
"valueReference" : { Reference(Group) }
}],
"conditional" : { Expression }, // Condition determining whether the data will be collected
"classifier" : [{ CodeableConcept }], // Classification
"dataStorage" : [{ // How the data element (value of the variable) is found
"datatype" : { CodeableConcept }, // Type of data used to express value of the variable
"path" : "<string>", // Where to find the data element in the dataset
"delimiter" : "<string>", // Character(s) separating values in a string-based list
"component" : [{ Content as for EvidenceVariable.dataStorage }] //
}],
"timing" : { RelativeTime }, // When the variable is observed
"period" : { Period }, // Calendar-based timing when the variable is observed
"constraint" : [{ // Limit on acceptability of data value
"conditional" : { CodeableConcept }, // Condition determining whether this constraint applies
"minimumQuantity" : { Quantity }, // The lowest permissible value of the variable
"maximumQuantity" : { Quantity }, // The highest permissible value of the variable
"earliestDateTime" : "<dateTime>", // The earliest permissible value of the variable
"latestDateTime" : "<dateTime>", // The latest permissible value of the variable
"minimumStringLength" : "<unsignedInt>", // The lowest number of characters allowed for a value of the variable
"maximumStringLength" : "<positiveInt>", // The highest number of characters allowed for a value of the variable
"code" : { CodeableConcept }, // Rule for acceptable data values
"expression" : { Expression }, // Rule for acceptable data values, as an Expression
"expectedValueSet" : { Reference(ValueSet) }, // List of anticipated values used to express value of the variable
"expectedUnitsValueSet" : { Reference(ValueSet) }, // List of anticipated values used to express units for the value of the variable
"anyValueAllowed" : <boolean> // Permissibility of unanticipated value used to express value of the variable
}],
"missingDataMeaning" : [{ CodeableConcept }], // How missing data can be interpreted
"unacceptableDataHandling" : [{ CodeableConcept }] // How erroneous data is processed
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .# from # from# from Resource: fhir:id, fhir:meta, fhir:implicitRules, and fhir:language # from DomainResource: fhir:text, fhir:contained, fhir:extension, and fhir:modifierExtension fhir:url [ uri ] ; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) fhir:identifier ( [ Identifier ] ... ) ; # 0..* Additional identifier for the evidence variable fhir:version [ string ] ; # 0..1 Business version of the evidence variable # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2fhir: ]fhir:versionAlgorithm [ a fhir:String ; string ] fhir:versionAlgorithm [ a fhir:Coding ; Coding ] fhir:name [ string ] ; # 0..1 I Name for this evidence variable (computer friendly) fhir:title [ string ] ; # 0..1 Name for this evidence variable (human friendly) fhir:shortTitle [ string ] ; # 0..1 Title for use in informal contextsfhir: fhir:fhir:citeAs [ markdown ] ; # 0..1 Display of how to cite this EvidenceVariable fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing only - never for real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisherfhir:fhir:recorder ( [ ContactDetail ] ... ) ; # 0..* Who entered the data for the evidence variable fhir:editor ( [ ContactDetail ] ... ) ; # 0..* Who edited the content fhir:reviewer ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content fhir:endorser ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content fhir:description [ markdown ] ; # 0..1 Natural language description of the evidence variable fhir:note ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes fhir:useContext ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support fhir:purpose [ markdown ] ; # 0..1 Why this EvidenceVariable is definedfhir: fhir: fhir:<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.fhir:copyright [ markdown ] ; # 0..1 Intellectual property ownership, may include restrictions on use fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s) fhir:approvalDate [ date ] ; # 0..1 When the resource was approved by publisher fhir:lastReviewDate [ date ] ; # 0..1 When the resource was last reviewed by the publisher fhir:effectivePeriod [ Period ] ; # 0..1 When the resource is expected to be usedfhir: fhir: fhir: fhir: fhir:fhir:relatesTo ( [ # 0..* Relationships to other Resources fhir:type [ CodeableConcept ] ; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes # target[x] : 1..1 The artifact that is related to this EvidenceVariable. One of these 5 fhir:target [ a fhir:Uri ; uri ] fhir:target [ a fhir:Attachment ; Attachment ] fhir:target [ a fhir:Canonical ; canonical(Any) ] fhir:target [ a fhir:Reference ; Reference(Any) ] fhir:target [ a fhir:Markdown ; markdown ] ] ... ) ; fhir:actual [ boolean ] ; # 0..1 Actual or conceptualfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 6 fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] fhir: ] ; fhir: fhir: fhir: fhir: ] ; # . One of these 2 fhir: ] fhir: ] # . One of these 2 fhir: ] fhir: ] fhir: fhir: fhir: # . One of these 4 fhir: ] fhir: ] fhir: ] fhir: ] fhir: fhir: ] ... ) ;fhir:definition [ CodeableReference(Group) ] ; # 0..1 The meaning of the evidence variable fhir:definitionModifier ( [ # 0..* Further specification of the definition fhir:code [ CodeableConcept ] ; # 1..1 Attribute of the definition # value[x] : 1..1 Specification of the definition attribute. One of these 9 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:RelativeTime ; RelativeTime ] fhir:value [ a fhir:Reference ; Reference(Any) ] fhir:value [ a fhir:Expression ; Expression ] fhir:value [ a fhir:Uri ; uri ] ] ... ) ;fhir: fhir:fhir:handling [ CodeableConcept ] ; # 0..1 boolean | continuous | dichotomous | ordinal | polychotomous | time-to-event | not-specified fhir:category ( [ # 0..* A grouping for dichotomous, ordinal, or polychotomouos variables fhir:name [ string ] ; # 0..1 Description of the grouping# . One of these 3# value[x] : 0..1 Definition of the grouping. One of these 4 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Reference ; Reference(Group) ] ] ... ) ; fhir:conditional [ Expression ] ; # 0..1 Condition determining whether the data will be collected fhir:classifier ( [ CodeableConcept ] ... ) ; # 0..* Classification fhir:dataStorage ( [ # 0..* How the data element (value of the variable) is found fhir:datatype [ CodeableConcept ] ; # 0..1 Type of data used to express value of the variable fhir:path [ string ] ; # 0..1 Where to find the data element in the dataset fhir:delimiter [ string ] ; # 0..1 Character(s) separating values in a string-based list fhir:component ( [ See EvidenceVariable.dataStorage ] ... ) ; # 0..* ] ... ) ; fhir:timing [ RelativeTime ] ; # 0..1 When the variable is observed fhir:period [ Period ] ; # 0..1 Calendar-based timing when the variable is observed fhir:constraint ( [ # 0..* Limit on acceptability of data value fhir:conditional [ CodeableConcept ] ; # 0..1 Condition determining whether this constraint applies fhir:minimumQuantity [ Quantity ] ; # 0..1 The lowest permissible value of the variable fhir:maximumQuantity [ Quantity ] ; # 0..1 The highest permissible value of the variable fhir:earliestDateTime [ dateTime ] ; # 0..1 The earliest permissible value of the variable fhir:latestDateTime [ dateTime ] ; # 0..1 The latest permissible value of the variable fhir:minimumStringLength [ unsignedInt ] ; # 0..1 The lowest number of characters allowed for a value of the variable fhir:maximumStringLength [ positiveInt ] ; # 0..1 The highest number of characters allowed for a value of the variable fhir:code [ CodeableConcept ] ; # 0..1 Rule for acceptable data values fhir:expression [ Expression ] ; # 0..1 Rule for acceptable data values, as an Expression fhir:expectedValueSet [ Reference(ValueSet) ] ; # 0..1 List of anticipated values used to express value of the variable fhir:expectedUnitsValueSet [ Reference(ValueSet) ] ; # 0..1 List of anticipated values used to express units for the value of the variable fhir:anyValueAllowed [ boolean ] ; # 0..1 Permissibility of unanticipated value used to express value of the variable ] ... ) ; fhir:missingDataMeaning ( [ CodeableConcept ] ... ) ; # 0..* How missing data can be interpreted fhir:unacceptableDataHandling ( [ CodeableConcept ] ... ) ; # 0..* How erroneous data is processed ]
Changes from both R4 and R4B
| EvidenceVariable | |
| EvidenceVariable.versionAlgorithm[x] |
|
| EvidenceVariable.citeAs |
|
| EvidenceVariable.experimental |
|
| EvidenceVariable.recorder |
|
| EvidenceVariable.purpose |
|
| EvidenceVariable.copyrightLabel |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| EvidenceVariable.unacceptableDataHandling |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .
Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) , the spreadsheet version & the dependency analysis
| Path | ValueSet | Type | Documentation |
|---|---|---|---|
| EvidenceVariable.versionAlgorithm[x] | VersionAlgorithm | Extensible |
Indicates the mechanism used to compare versions to determine which is more current. |
| EvidenceVariable.status | PublicationStatus | Required |
The lifecycle status of an artifact. |
| EvidenceVariable.relatesTo.type |
|
Extensible |
Type of relationship to the related artifact. |
| EvidenceVariable.definition | EvidenceVariableDefinition | Example |
|
| EvidenceVariable.definitionModifier.code |
|
Example |
Examples of terms that represent an evidence variable definition modifier code. |
| EvidenceVariable.handling | EvidenceVariableHandlingExample | Example |
The
|
| EvidenceVariable.classifier |
|
Example |
|
| EvidenceVariable.dataStorage.datatype |
|
|
|
| EvidenceVariable.constraint.conditional |
|
Example |
The
|
| EvidenceVariable.constraint.code | EvidenceVariableConstraint | Example |
A
rule,
such
as
a
|
| EvidenceVariable.missingDataMeaning |
|
|
|
| EvidenceVariable.unacceptableDataHandling | EvidenceVariableUnacceptableDataHandling | Example |
A
method
or
|
| 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 | exists() implies matches('^[^|# ]+$') |
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to 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 |
| context | token | A use context assigned to the evidence variable | (EvidenceVariable.useContext.value.ofType(CodeableConcept)) |
|
| context-quantity | quantity | A quantity- or range-valued use context assigned to the evidence variable | (EvidenceVariable.useContext.value.ofType(Quantity)) | (EvidenceVariable.useContext.value.ofType(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 | date | The evidence variable publication date | EvidenceVariable.date |
|
|
|
|
|
|
|
|
|
|
|
|
|
| identifier | token | External identifier for the evidence variable | EvidenceVariable.identifier |
|
| name | string | Computationally friendly name of the evidence variable | EvidenceVariable.name |
|
| publisher | string | Name of the publisher of the evidence variable | EvidenceVariable.publisher |
|
| status | token | The current status of the evidence variable | EvidenceVariable.status |
|
| title | string | The human-friendly name of the evidence variable | EvidenceVariable.title |
|
| topic | token | Topics associated with the EvidenceVariable | 10 Resources | |
| url | uri | The uri that identifies the evidence variable | EvidenceVariable.url |
|
| version | token | The business version of the evidence variable | EvidenceVariable.version |
|
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Sun,
Mar
26,
2023
15:24+1100.
Fri,
Nov
14,
2025
05:54+0000.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change