Evidence Based Medicine on FHIR Implementation Guide
2.0.0-ballot - ballot International flag

Evidence Based Medicine on FHIR Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ebm/ and changes regularly. See the Directory of published versions

Resource Profile: VariableDefinition

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/variable-definition Version: 2.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: VariableDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.111

Profile of EvidenceVariable for Evidence Based Medicine IG. The VariableDefinition Profile uses a CodeableReference Datatype to provide a concept (e.g. coding in a code system) and/or a reference to a Group Resource for structured data to define the variable.

See Understanding the EvidenceVariable Resource for additional information.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from EvidenceVariable

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* EvidenceVariable A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... classifier 0..* CodeableConcept Classification
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-classifier
.... conditional 0..1 Expression When the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-conditional
.... dataStorage 0..* (Complex) How and where the data element (value of the variable) is found
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-storage
.... timing 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... period 0..1 Period Date(s) and time(s) when the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-period
.... constraint 0..* (Complex) Limit on acceptability of data value
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-constraint
.... missingDataMeaning 0..1 CodeableConcept How missing data is interpreted
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-missing-data
.... unacceptableDataHandling 0..* CodeableConcept How erroneous data is processed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-cleaning
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
EvidenceVariable.handlingrequiredEvidenceVariableHandling
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot2
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* EvidenceVariable A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... classifier 0..* CodeableConcept Classification
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-classifier
.... conditional 0..1 Expression When the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-conditional
.... dataStorage 0..* (Complex) How and where the data element (value of the variable) is found
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-storage
.... timing 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... period 0..1 Period Date(s) and time(s) when the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-period
.... constraint 0..* (Complex) Limit on acceptability of data value
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-constraint
.... missingDataMeaning 0..1 CodeableConcept How missing data is interpreted
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-missing-data
.... unacceptableDataHandling 0..* CodeableConcept How erroneous data is processed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-cleaning
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
cnl-1: 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: VersionAlgorithm (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
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the evidence variable
... note 0..* Annotation Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this EvidenceVariable is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 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
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... actual 0..1 boolean Actual or conceptual
... definition Σ 0..1 CodeableReference(Group) Defines the variable with a concept and/or Reference
Binding: EvidenceVariableDefinition (example)
... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
... category 0..* BackboneElement A grouping for ordinal or polychotomous variables
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Description of the grouping
.... value[x] 0..1 Definition of the grouping
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Group)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EvidenceVariable.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2
from the FHIR Standard
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
EvidenceVariable.definitionexampleEvidenceVariableDefinition
http://hl7.org/fhir/ValueSet/evidence-variable-definition
from the FHIR Standard
EvidenceVariable.handlingrequiredEvidenceVariableHandling
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot2
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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-1warningEvidenceVariable.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from EvidenceVariable

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* EvidenceVariable A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... classifier 0..* CodeableConcept Classification
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-classifier
.... conditional 0..1 Expression When the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-conditional
.... dataStorage 0..* (Complex) How and where the data element (value of the variable) is found
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-storage
.... timing 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... period 0..1 Period Date(s) and time(s) when the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-period
.... constraint 0..* (Complex) Limit on acceptability of data value
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-constraint
.... missingDataMeaning 0..1 CodeableConcept How missing data is interpreted
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-missing-data
.... unacceptableDataHandling 0..* CodeableConcept How erroneous data is processed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-cleaning
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
EvidenceVariable.handlingrequiredEvidenceVariableHandling
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot2
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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}$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C 0..* EvidenceVariable A definition of an exposure, outcome, or other variable
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... classifier 0..* CodeableConcept Classification
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-classifier
.... conditional 0..1 Expression When the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-conditional
.... dataStorage 0..* (Complex) How and where the data element (value of the variable) is found
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-storage
.... timing 0..1 (Complex) Timing in which the characteristic is determined or action is taken
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/characteristic-timing
.... period 0..1 Period Date(s) and time(s) when the variable is observed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-period
.... constraint 0..* (Complex) Limit on acceptability of data value
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-constraint
.... missingDataMeaning 0..1 CodeableConcept How missing data is interpreted
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-missing-data
.... unacceptableDataHandling 0..* CodeableConcept How erroneous data is processed
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-data-cleaning
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
cnl-1: 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: VersionAlgorithm (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
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the evidence variable
... note 0..* Annotation Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this EvidenceVariable is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 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
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... actual 0..1 boolean Actual or conceptual
... definition Σ 0..1 CodeableReference(Group) Defines the variable with a concept and/or Reference
Binding: EvidenceVariableDefinition (example)
... handling 1..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
... category 0..* BackboneElement A grouping for ordinal or polychotomous variables
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Description of the grouping
.... value[x] 0..1 Definition of the grouping
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Group)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EvidenceVariable.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2
from the FHIR Standard
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot2
from the FHIR Standard
EvidenceVariable.definitionexampleEvidenceVariableDefinition
http://hl7.org/fhir/ValueSet/evidence-variable-definition
from the FHIR Standard
EvidenceVariable.handlingrequiredEvidenceVariableHandling
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot2
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningEvidenceVariableName 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-1warningEvidenceVariable.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron