Evidence Based Medicine on FHIR Implementation Guide
1.0.0-ballot2 - STU 1 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 1.0.0-ballot2 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: ParticipantFlowEvidenceVariable

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/participant-flow-evidence-variable Version: 1.0.0-ballot2
Standards status: Trial-use Maturity Level: 1 Computable Name: ParticipantFlowEvidenceVariable
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.72

Profile of EvidenceVariable for Evidence Based Medicine IG. The ParticipantFlowEvidenceVariable Profile is used to describe outcome measures for completion and non-completion of participation in a research study.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:RelatesToWithQuotation 0..* (Complex) Related artifact with quoted portion
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/relates-to-with-quotation
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
.... extension:handlingDetail 0..* CodeableConcept How the variable is handled
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-handling-detail
Binding: EvidenceVariable Handling Extension Value Set (preferred)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for relatesTo 0..* BackboneElement Relationships to other Resources
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this EvidenceVariable
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other Resources
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... Slices for target[x] 1..1 The artifact that is related to this EvidenceVariable
Slice: Unordered, Open by type:$this
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
...... target[x]:targetReference 0..1 Reference(ParticipantFlowReasonEvidenceVariable) The artifact that is related to this EvidenceVariable
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Binding: EvidenceVariableHandling (required)
Required Pattern: boolean

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo.typerequiredArtifactRelationshipType
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo:supportedWith.typerequiredPattern Value: supported-with
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.handlingrequiredPattern Value: boolean
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot3
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()

This structure is derived from VariableDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable 0..* VariableDefinition A definition of an exposure, outcome, or other variable
... Slices for relatesTo 0..* BackboneElement Relationships to other Resources
Slice: Unordered, Open by value:type
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other Resources
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: supported-with
..... Slices for target[x] 1..1 uri, Attachment, canonical(Resource), Reference(Resource), markdown The artifact that is related to this EvidenceVariable
Slice: Unordered, Open by type:$this
...... target[x]:targetReference 0..1 Reference(ParticipantFlowReasonEvidenceVariable) The artifact that is related to this EvidenceVariable
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Required Pattern: boolean

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
Constraints: cnl-0
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RelatesToWithQuotation 0..* (Complex) Related artifact with quoted portion
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/relates-to-with-quotation
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
.... extension:handlingDetail 0..* CodeableConcept How the variable is handled
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-handling-detail
Binding: EvidenceVariable Handling Extension Value Set (preferred)
... 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)
Constraints: cnl-1
... 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
... citeAs 0..1 markdown Display of how to cite this EvidenceVariable
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental 0..1 boolean For testing only - never for real usage
... 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 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
... Slices for relatesTo 0..* BackboneElement Relationships to other Resources
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... 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
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this EvidenceVariable
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other Resources
..... 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
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... Slices for target[x] 1..1 The artifact that is related to this EvidenceVariable
Slice: Unordered, Open by type:$this
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
...... target[x]:targetReference 0..1 Reference(ParticipantFlowReasonEvidenceVariable) The artifact that is related to this EvidenceVariable
... actual 0..1 boolean Actual or conceptual
... definition Σ 0..1 CodeableReference(Group) The meaning of the evidence variable
Binding: EvidenceVariableDefinition (example)
... definitionModifier 0..* BackboneElement Further specification of the definition
.... 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
.... code 1..1 CodeableConcept Attribute of the definition
Binding: EvidenceVariableDefinitionModifierCode (example)
.... value[x] 1..1 Specification of the definition attribute
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valuePeriod Period
..... valueRelativeTime RelativeTime
..... valueReference Reference(Resource)
..... valueExpression Expression
..... valueUri uri
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Binding: EvidenceVariableHandling (required)
Required Pattern: boolean
... category 0..* BackboneElement A grouping for dichotomous, ordinal, or polychotomouos 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)
... conditional 0..1 Expression Condition determining whether the data will be collected
... classifier 0..* CodeableConcept Classification
Binding: EvidenceVariableClassifier (example)
... dataStorage 0..* BackboneElement How the data element (value of the variable) is found
.... 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
.... datatype 0..1 CodeableConcept Type of data used to express value of the variable
Binding: FHIRTypes (preferred): Either a resource or a data type, including logical model types.
.... path 0..1 string Where to find the data element in the dataset
.... delimiter 0..1 string Character(s) separating values in a string-based list
.... component 0..* See dataStorage (EvidenceVariable)
... timing 0..1 RelativeTime When the variable is observed
... period 0..1 Period Calendar-based timing when the variable is observed
... constraint 0..* BackboneElement Limit on acceptability of data value
.... 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
.... conditional 0..1 CodeableConcept Condition determining whether this constraint applies
Binding: AdministrativeGender (example)
.... minimumQuantity 0..1 Quantity The lowest permissible value of the variable
.... maximumQuantity 0..1 Quantity The highest permissible value of the variable
.... earliestDateTime 0..1 dateTime The earliest permissible value of the variable
.... latestDateTime 0..1 dateTime The latest permissible value of the variable
.... minimumStringLength 0..1 unsignedInt The lowest number of characters allowed for a value of the variable
.... maximumStringLength 0..1 positiveInt The highest number of characters allowed for a value of the variable
.... code 0..1 CodeableConcept Rule for acceptable data values
Binding: EvidenceVariableConstraint (example)
.... expression 0..1 Expression Rule for acceptable data values, as an Expression
.... expectedValueSet 0..1 Reference(ValueSet) List of anticipated values used to express value of the variable
.... expectedUnitsValueSet 0..1 Reference(ValueSet) List of anticipated values used to express units for the value of the variable
.... anyValueAllowed 0..1 boolean Permissibility of unanticipated value used to express value of the variable
... missingDataMeaning 0..* CodeableConcept How missing data can be interpreted
Binding: DataAbsentReason (example)
... unacceptableDataHandling 0..* CodeableConcept How erroneous data is processed
Binding: EvidenceVariableUnacceptableDataHandling (example)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo.typerequiredArtifactRelationshipType
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo:supportedWith.typerequiredPattern Value: supported-with
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.definitionexampleEvidenceVariableDefinition
http://hl7.org/fhir/ValueSet/evidence-variable-definition|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.definitionModifier.codeexampleEvidenceVariableDefinitionModifierCode
http://hl7.org/fhir/ValueSet/evidence-variable-definition-modifier-code|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.handlingrequiredPattern Value: boolean
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.classifierexampleEvidenceVariableClassifier
http://hl7.org/fhir/ValueSet/evidence-variable-classifier|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.dataStorage.datatypepreferredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.constraint.conditionalexampleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.constraint.codeexampleEvidenceVariableConstraint
http://hl7.org/fhir/ValueSet/evidence-variable-constraint|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.missingDataMeaningexampleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.unacceptableDataHandlingexampleEvidenceVariableUnacceptableDataHandling
http://hl7.org/fhir/ValueSet/evidence-variable-unacceptable-data-handling|6.0.0-ballot3
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()

This structure is derived from VariableDefinition

Summary

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EvidenceVariable.relatesTo
  • The element 1 is sliced based on the value of EvidenceVariable.relatesTo.target[x]

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension Content/Rules for all slices
.... extension:RelatesToWithQuotation 0..* (Complex) Related artifact with quoted portion
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/relates-to-with-quotation
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
.... extension:handlingDetail 0..* CodeableConcept How the variable is handled
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-handling-detail
Binding: EvidenceVariable Handling Extension Value Set (preferred)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... Slices for relatesTo 0..* BackboneElement Relationships to other Resources
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this EvidenceVariable
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other Resources
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... Slices for target[x] 1..1 The artifact that is related to this EvidenceVariable
Slice: Unordered, Open by type:$this
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
...... target[x]:targetReference 0..1 Reference(ParticipantFlowReasonEvidenceVariable) The artifact that is related to this EvidenceVariable
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Binding: EvidenceVariableHandling (required)
Required Pattern: boolean

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo.typerequiredArtifactRelationshipType
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo:supportedWith.typerequiredPattern Value: supported-with
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.handlingrequiredPattern Value: boolean
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot3
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()

Differential View

This structure is derived from VariableDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable 0..* VariableDefinition A definition of an exposure, outcome, or other variable
... Slices for relatesTo 0..* BackboneElement Relationships to other Resources
Slice: Unordered, Open by value:type
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other Resources
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Required Pattern: supported-with
..... Slices for target[x] 1..1 uri, Attachment, canonical(Resource), Reference(Resource), markdown The artifact that is related to this EvidenceVariable
Slice: Unordered, Open by type:$this
...... target[x]:targetReference 0..1 Reference(ParticipantFlowReasonEvidenceVariable) The artifact that is related to this EvidenceVariable
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Required Pattern: boolean

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
Constraints: cnl-0
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RelatesToWithQuotation 0..* (Complex) Related artifact with quoted portion
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/relates-to-with-quotation
.... extension:publicationStatus 0..1 CodeableConcept Publication status
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/artifact-publication-status
Binding: Cited Artifact Status Type (preferred)
.... extension:handlingDetail 0..* CodeableConcept How the variable is handled
URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/evidence-variable-handling-detail
Binding: EvidenceVariable Handling Extension Value Set (preferred)
... 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)
Constraints: cnl-1
... 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
... citeAs 0..1 markdown Display of how to cite this EvidenceVariable
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental 0..1 boolean For testing only - never for real usage
... 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 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
... Slices for relatesTo 0..* BackboneElement Relationships to other Resources
Slice: Unordered, Open by value:type
.... relatesTo:All Slices Content/Rules for all slices
..... 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
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
..... target[x] 1..1 The artifact that is related to this EvidenceVariable
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
.... relatesTo:supportedWith 0..* BackboneElement Relationships to other Resources
..... 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
..... type 1..1 code documentation | justification | 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 | specification-of | created-with | cite-as | summarizes
Binding: ArtifactRelationshipType (required): The type of relationship to the related artifact.
Required Pattern: supported-with
..... Slices for target[x] 1..1 The artifact that is related to this EvidenceVariable
Slice: Unordered, Open by type:$this
...... targetUri uri
...... targetAttachment Attachment
...... targetCanonical canonical(Resource)
...... targetReference Reference(Resource)
...... targetMarkdown markdown
...... target[x]:targetReference 0..1 Reference(ParticipantFlowReasonEvidenceVariable) The artifact that is related to this EvidenceVariable
... actual 0..1 boolean Actual or conceptual
... definition Σ 0..1 CodeableReference(Group) The meaning of the evidence variable
Binding: EvidenceVariableDefinition (example)
... definitionModifier 0..* BackboneElement Further specification of the definition
.... 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
.... code 1..1 CodeableConcept Attribute of the definition
Binding: EvidenceVariableDefinitionModifierCode (example)
.... value[x] 1..1 Specification of the definition attribute
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valuePeriod Period
..... valueRelativeTime RelativeTime
..... valueReference Reference(Resource)
..... valueExpression Expression
..... valueUri uri
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Binding: EvidenceVariableHandling (required)
Required Pattern: boolean
... category 0..* BackboneElement A grouping for dichotomous, ordinal, or polychotomouos 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)
... conditional 0..1 Expression Condition determining whether the data will be collected
... classifier 0..* CodeableConcept Classification
Binding: EvidenceVariableClassifier (example)
... dataStorage 0..* BackboneElement How the data element (value of the variable) is found
.... 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
.... datatype 0..1 CodeableConcept Type of data used to express value of the variable
Binding: FHIRTypes (preferred): Either a resource or a data type, including logical model types.
.... path 0..1 string Where to find the data element in the dataset
.... delimiter 0..1 string Character(s) separating values in a string-based list
.... component 0..* See dataStorage (EvidenceVariable)
... timing 0..1 RelativeTime When the variable is observed
... period 0..1 Period Calendar-based timing when the variable is observed
... constraint 0..* BackboneElement Limit on acceptability of data value
.... 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
.... conditional 0..1 CodeableConcept Condition determining whether this constraint applies
Binding: AdministrativeGender (example)
.... minimumQuantity 0..1 Quantity The lowest permissible value of the variable
.... maximumQuantity 0..1 Quantity The highest permissible value of the variable
.... earliestDateTime 0..1 dateTime The earliest permissible value of the variable
.... latestDateTime 0..1 dateTime The latest permissible value of the variable
.... minimumStringLength 0..1 unsignedInt The lowest number of characters allowed for a value of the variable
.... maximumStringLength 0..1 positiveInt The highest number of characters allowed for a value of the variable
.... code 0..1 CodeableConcept Rule for acceptable data values
Binding: EvidenceVariableConstraint (example)
.... expression 0..1 Expression Rule for acceptable data values, as an Expression
.... expectedValueSet 0..1 Reference(ValueSet) List of anticipated values used to express value of the variable
.... expectedUnitsValueSet 0..1 Reference(ValueSet) List of anticipated values used to express units for the value of the variable
.... anyValueAllowed 0..1 boolean Permissibility of unanticipated value used to express value of the variable
... missingDataMeaning 0..* CodeableConcept How missing data can be interpreted
Binding: DataAbsentReason (example)
... unacceptableDataHandling 0..* CodeableConcept How erroneous data is processed
Binding: EvidenceVariableUnacceptableDataHandling (example)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
EvidenceVariable.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo.typerequiredArtifactRelationshipType
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.relatesTo:supportedWith.typerequiredPattern Value: supported-with
http://hl7.org/fhir/ValueSet/artifact-relationship-type|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.definitionexampleEvidenceVariableDefinition
http://hl7.org/fhir/ValueSet/evidence-variable-definition|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.definitionModifier.codeexampleEvidenceVariableDefinitionModifierCode
http://hl7.org/fhir/ValueSet/evidence-variable-definition-modifier-code|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.handlingrequiredPattern Value: boolean
http://hl7.org/fhir/ValueSet/variable-handling|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.classifierexampleEvidenceVariableClassifier
http://hl7.org/fhir/ValueSet/evidence-variable-classifier|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.dataStorage.datatypepreferredFHIRTypes
http://hl7.org/fhir/ValueSet/fhir-types|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.constraint.conditionalexampleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.constraint.codeexampleEvidenceVariableConstraint
http://hl7.org/fhir/ValueSet/evidence-variable-constraint|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.missingDataMeaningexampleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason|6.0.0-ballot3
From the FHIR Standard
EvidenceVariable.unacceptableDataHandlingexampleEvidenceVariableUnacceptableDataHandling
http://hl7.org/fhir/ValueSet/evidence-variable-unacceptable-data-handling|6.0.0-ballot3
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()

This structure is derived from VariableDefinition

Summary

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of EvidenceVariable.relatesTo
  • The element 1 is sliced based on the value of EvidenceVariable.relatesTo.target[x]

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron