This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot2:
Release
6
Ballot
(2nd
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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 : 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 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
EvidenceVariable.definition
element
has
greater
flexibility
than
a
CodeableReference
datatype
which
can
define
the
Group
Resource
for
Population
specification.
Please
submit
PICO
component
as
a
ballot
comment
concept
and/or
reference
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."
Resource.
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 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
|
string | |||
|
Coding | |||
|
Σ C | 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
|
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: 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 |
Why
this
EvidenceVariable
is
defined
|
|
|
0..1 | markdown |
Use
and/or
publishing
restrictions
|
|
|
T | 0..1 | string |
Copyright
holder
and
year(s)
|
|
0..1 | date |
When
the
resource
was
approved
by
publisher
|
|
|
0..1 | date |
When
the
resource
was
last
reviewed
by
the
publisher
|
|
|
0..1 | Period |
When
the
resource
is
expected
to
be
used
|
|
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
|
|
0..1 | boolean |
Actual
or
conceptual
|
|
|
Σ
|
0..1 |
|
Defines
the
Binding: Evidence Variable Definition |
|
|
0..1 |
|
Binding: |
|
|
|
BackboneElement |
|
|
|
|
|
|
|
|
|
||
|
|
|
|
|
|
|
Quantity |
|
|
|
|
|
|
|
|
|
|||
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 --> <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> <purpose value="[markdown]"/><!-- 0..1 Why this EvidenceVariable is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
<<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.<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><!-- 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 -->< < < <</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) Defines the variable with a concept and/or Reference --></definition> <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]><value[x]><!-- 0..1 CodeableConcept|Quantity|Range|Reference(Group) 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
// 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
"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
"purpose" : "<markdown>", // Why this EvidenceVariable is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"<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.
"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
"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
"
"
"
"
"
"
"
"
"
"
"
"
"
"
" },
">,
" },
" },
" },
">",
"
},
"
"
"
"
},
" },
" },
" },
" },
"
"
"
" },
" },
">",
">",
"
"
}]
}],
"definition" : { CodeableReference(Group) }, // Defines the variable with a concept and/or Reference
"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 4:
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
" }
"valueRange" : { Range },
"valueReference" : { Reference(Group) }
}]
}
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: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 2 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 contexts fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher 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 defined fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
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: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 used fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content 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:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc 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 Defines the variable with a concept and/or Reference fhir:handling [ code ] ; # 0..1 continuous | dichotomous | ordinal | polychotomous fhir:category ( [ # 0..* A grouping for ordinal or polychotomous 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) ] ] ... ) ; ]
Changes from both R4 and R4B
| EvidenceVariable | |
| EvidenceVariable.versionAlgorithm[x] |
|
| EvidenceVariable.experimental |
|
| EvidenceVariable.purpose |
|
| EvidenceVariable.copyrightLabel |
|
| EvidenceVariable.actual |
|
|
|
|
| EvidenceVariable.handling |
|
| EvidenceVariable.category |
|
| EvidenceVariable.category.name |
|
| EvidenceVariable.category.value[x] |
|
| EvidenceVariable.subtitle |
|
| EvidenceVariable.jurisdiction |
|
| EvidenceVariable.topic |
|
| EvidenceVariable.type |
|
|
|
|
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
|
|---|---|---|---|---|
|
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 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) |
|
|
string | |||
|
Coding | |||
|
Σ C | 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
|
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: 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 |
Why
this
EvidenceVariable
is
defined
|
|
|
0..1 | markdown |
Use
and/or
publishing
restrictions
|
|
|
T | 0..1 | string |
Copyright
holder
and
year(s)
|
|
0..1 | date |
When
the
resource
was
approved
by
publisher
|
|
|
0..1 | date |
When
the
resource
was
last
reviewed
by
the
publisher
|
|
|
0..1 | Period |
When
the
resource
is
expected
to
be
used
|
|
|
0..* | ContactDetail |
Who
authored
the
content
|
|
|
0..* | ContactDetail |
Who
edited
the
content
|
|
|
0..* | ContactDetail |
Who
reviewed
the
content
|
|
|
0..* | ContactDetail |
Who
endorsed
the
content
|
|
|
0..* | RelatedArtifact |
Additional
documentation,
citations,
etc
|
|
|
0..1 | boolean |
Actual
or
conceptual
|
|
|
Σ
|
0..1 |
|
Defines
the
Binding: Evidence Variable Definition |
|
0..1 |
|
Binding: |
|
|
|
|
BackboneElement |
|
|
|
|
|
|
|
|
|
||
|
|
|
||
|
|
Quantity |
|
|
|
|
|
|
|
|
|
|||
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 --> <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 --> <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> <purpose value="[markdown]"/><!-- 0..1 Why this EvidenceVariable is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
<<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.<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><!-- 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 -->< < < <</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) Defines the variable with a concept and/or Reference --></definition> <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]><value[x]><!-- 0..1 CodeableConcept|Quantity|Range|Reference(Group) 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
// 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
"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
"purpose" : "<markdown>", // Why this EvidenceVariable is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
"copyrightLabel" : "<string>", // Copyright holder and year(s)
"<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.
"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
"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
"
"
"
"
"
"
"
"
"
"
"
"
"
"
" },
">,
" },
" },
" },
">",
"
},
"
"
"
"
},
" },
" },
" },
" },
"
"
"
" },
" },
">",
">",
"
"
}]
}],
"definition" : { CodeableReference(Group) }, // Defines the variable with a concept and/or Reference
"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 4:
"valueCodeableConcept" : { CodeableConcept },
"valueQuantity" : { Quantity },
" }
"valueRange" : { Range },
"valueReference" : { Reference(Group) }
}]
}
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: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 2 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 contexts fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage fhir:date [ dateTime ] ; # 0..1 Date last changed fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual) fhir:contact ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher 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 defined fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
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: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 used fhir:author ( [ ContactDetail ] ... ) ; # 0..* Who authored the content 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:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc 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 Defines the variable with a concept and/or Reference fhir:handling [ code ] ; # 0..1 continuous | dichotomous | ordinal | polychotomous fhir:category ( [ # 0..* A grouping for ordinal or polychotomous 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) ] ] ... ) ; ]
Changes from both R4 and R4B
| EvidenceVariable | |
| EvidenceVariable.versionAlgorithm[x] |
|
| EvidenceVariable.experimental |
|
| EvidenceVariable.purpose |
|
| EvidenceVariable.copyrightLabel |
|
| EvidenceVariable.actual |
|
|
|
|
| EvidenceVariable.handling |
|
| EvidenceVariable.category |
|
| EvidenceVariable.category.name |
|
| EvidenceVariable.category.value[x] |
|
| EvidenceVariable.subtitle |
|
| EvidenceVariable.jurisdiction |
|
| EvidenceVariable.topic |
|
| EvidenceVariable.type |
|
|
|
|
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.definition |
|
Example |
|
| EvidenceVariable.handling | EvidenceVariableHandling | Required |
The handling of the variable in statistical analysis for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). |
| 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 |
| composed-of | reference | What resource is being referenced |
EvidenceVariable.relatedArtifact.where(type='composed-of').resource
(Any) |
6 Resources |
| context | token | A use context assigned to the evidence variable | (EvidenceVariable.useContext.value.ofType(CodeableConcept)) | 30 Resources |
| 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)) | 30 Resources |
| context-type | token | A type of use context assigned to the evidence variable | EvidenceVariable.useContext.code | 30 Resources |
| 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) |
30 Resources |
| 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) |
30 Resources |
| date | date | The evidence variable publication date | EvidenceVariable.date | 30 Resources |
| depends-on | reference | What resource is being referenced |
EvidenceVariable.relatedArtifact.where(type='depends-on').resource
(Any) |
6 Resources |
| derived-from | reference | What resource is being referenced |
EvidenceVariable.relatedArtifact.where(type='derived-from').resource
(Any) |
10 Resources |
| description | string | The description of the evidence variable | EvidenceVariable.description | 28 Resources |
| identifier | token | External identifier for the evidence variable | EvidenceVariable.identifier |
|
| name | string | Computationally friendly name of the evidence variable | EvidenceVariable.name |
|
| predecessor | reference | What resource is being referenced |
EvidenceVariable.relatedArtifact.where(type='predecessor').resource
(Any) |
10 Resources |
| publisher | string | Name of the publisher of the evidence variable | EvidenceVariable.publisher | 30 Resources |
| status | token | The current status of the evidence variable | EvidenceVariable.status |
|
| successor | reference | What resource is being referenced |
EvidenceVariable.relatedArtifact.where(type='successor').resource
(Any) |
6 Resources |
| title | string | The human-friendly name of the evidence variable | EvidenceVariable.title | 27 Resources |
| 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 |
|