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

This page is part of the Evidence Based Medicine on FHIR Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: VariableDefinition

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

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.

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 EvidenceVariable
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... definition 1..1CodeableReference(Group)Defines the variable with a concept and/or Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition
... characteristic 0..0
... category
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... valueReference 0..1Reference(Group)Defines the categorical value with a Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C0..*EvidenceVariableA definition of an exposure, outcome, or other variable
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EvidenceVariable.statusrequiredPublicationStatus
EvidenceVariable.handlingrequiredEvidenceVariableHandling

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 C0..*EvidenceVariableA definition of an exposure, outcome, or other variable
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... definition 1..1CodeableReference(Group)Defines the variable with a concept and/or Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this evidence variable, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the evidence variable
... version Σ0..1stringBusiness version of the evidence variable
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this evidence variable (computer friendly)
... title Σ0..1stringName for this evidence variable (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental 0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the evidence variable
... note 0..*AnnotationUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... purpose 0..1markdownWhy this EvidenceVariable is defined
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the resource was approved by publisher
... lastReviewDate 0..1dateWhen the resource was last reviewed by the publisher
... effectivePeriod 0..1PeriodWhen the resource is expected to be used
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... actual 0..1booleanActual or conceptual
... handling 1..1codecontinuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
... category 0..*BackboneElementA grouping for ordinal or polychotomous variables
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... valueReference 0..1Reference(Group)Defines the categorical value with a Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name 0..1stringDescription of the grouping
.... value[x] 0..1Definition of the grouping
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EvidenceVariable.languagerequiredAllLanguages
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
EvidenceVariable.statusrequiredPublicationStatus
EvidenceVariable.characteristic.definitionByTypeAndValue.typeexampleUsageContextType
EvidenceVariable.characteristic.definitionByTypeAndValue.methodexampleDefinitionMethod
EvidenceVariable.characteristic.definitionByTypeAndValue.offsetexampleCharacteristicOffset
EvidenceVariable.characteristic.definitionByCombination.coderequiredCharacteristicCombination
EvidenceVariable.characteristic.timeFromEvent.event[x]exampleEvidenceVariableEvent
EvidenceVariable.handlingrequiredEvidenceVariableHandling

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()

This structure is derived from EvidenceVariable

Differential View

This structure is derived from EvidenceVariable

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable EvidenceVariable
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... definition 1..1CodeableReference(Group)Defines the variable with a concept and/or Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition
... characteristic 0..0
... category
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... valueReference 0..1Reference(Group)Defines the categorical value with a Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable C0..*EvidenceVariableA definition of an exposure, outcome, or other variable
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EvidenceVariable.statusrequiredPublicationStatus
EvidenceVariable.handlingrequiredEvidenceVariableHandling

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 C0..*EvidenceVariableA definition of an exposure, outcome, or other variable
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... definition 1..1CodeableReference(Group)Defines the variable with a concept and/or Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-definition
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this evidence variable, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the evidence variable
... version Σ0..1stringBusiness version of the evidence variable
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this evidence variable (computer friendly)
... title Σ0..1stringName for this evidence variable (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental 0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the evidence variable
... note 0..*AnnotationUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... purpose 0..1markdownWhy this EvidenceVariable is defined
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen the resource was approved by publisher
... lastReviewDate 0..1dateWhen the resource was last reviewed by the publisher
... effectivePeriod 0..1PeriodWhen the resource is expected to be used
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc
... actual 0..1booleanActual or conceptual
... handling 1..1codecontinuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
... category 0..*BackboneElementA grouping for ordinal or polychotomous variables
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... valueReference 0..1Reference(Group)Defines the categorical value with a Reference
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-category-value-reference
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name 0..1stringDescription of the grouping
.... value[x] 0..1Definition of the grouping
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
EvidenceVariable.languagerequiredAllLanguages
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
EvidenceVariable.statusrequiredPublicationStatus
EvidenceVariable.characteristic.definitionByTypeAndValue.typeexampleUsageContextType
EvidenceVariable.characteristic.definitionByTypeAndValue.methodexampleDefinitionMethod
EvidenceVariable.characteristic.definitionByTypeAndValue.offsetexampleCharacteristicOffset
EvidenceVariable.characteristic.definitionByCombination.coderequiredCharacteristicCombination
EvidenceVariable.characteristic.timeFromEvent.event[x]exampleEvidenceVariableEvent
EvidenceVariable.handlingrequiredEvidenceVariableHandling

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()

This structure is derived from EvidenceVariable

 

Other representations of profile: CSV, Excel, Schematron