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: GroupAssignment

Official URL: http://hl7.org/fhir/uv/ebm/StructureDefinition/group-assignment Version: 1.0.0-ballot2
Standards status: Trial-use Maturity Level: 1 Computable Name: GroupAssignment
Other Identifiers: OID:2.16.840.1.113883.4.642.40.44.42.52

Profile of EvidenceVariable for Evidence Based Medicine IG. The GroupAssignment Profile is used to classify an EvidenceVariable as an exposure managed as a categorical variable. The variable definitions are found in the category element instead of the definition element.

See Understanding the EvidenceVariable Resource for additional information.

​An example from the QUARTET USA trial will be described here and can be viewed at GroupAssignment: Quadpill vs. Candesartan.

The concepts needed to describe the group assignment for the QUARTET USA trial include:

  1. This is the actual variable that was measured for analysis.
  2. This variable is handled as having one of two categorical values.
  3. The two categorical values that are possible for this variable are the exposure group (Quadpill) and the comparator group (Candesartan).

To communicate this is the actual variable, the EvidenceVariable.actual element has a boolean value of true:

"actual" : true Because the definition of this variable is literally described in the EvidenceVariable.handling and EvidenceVariable.category elements, the EvidenceVariable.definition element is completed with a specific codeable concept value:

"definition" : { "concept" : { "coding" : [ { "system" : "https://fevir.net/resources/CodeSystem/179423", "code" : "defined-in-handling-and-category", "display" : "Defined in handling and category elements" } ] } }

The handling of a group assignment variable may be coded as dichotomous if there are 2 possible assignments or polychotomous if there are 3 or more possible assignments. In this example with 2 possible assignments, the EvidenceVariable.handling element looks like:

"handling": { "coding": [ { "system": "http://hl7.org/fhir/variable-handling", "code": "dichotomous", "display": "dichotomous variable" } ] }

In prior versions of FHIR, the EvidenceVariable.handling element used a code datatype instead of a CodeableConcept datatype so looked like:

"handling": "dichotomous"

Each possible group assignment is represented as an instance in the EvidenceVariable.category element, using EvidenceVariable.category.name for a label for the category and EvidenceVariable.category.valueReference to reference the Group Resource that defines the category. The 2 groups are shown as:

"category" : [ { "name" : "Quadpill once daily", "valueReference" : { "reference" : "Group/375175", "type" : "Group", "display" : "QUARTET USA Trial Quadpill group" } }, { "name" : "Candesartan 8 mg once daily", "valueReference" : { "reference" : "Group/375182", "type" : "Group", "display" : "QUARTET USA Trial Control Group" } } ]

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
Interfaces Implemented: MetadataResource
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.
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Binding: EvidenceVariableHandling (required)
... category 2..* BackboneElement A grouping for dichotomous, ordinal, or polychotomouos variables
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Description of the grouping

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EvidenceVariable.status Base required PublicationStatus 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.handling Base required Evidence Variable Handling 📍6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning EvidenceVariable 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}$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must 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
Interfaces Implemented: MetadataResource
... definition
.... concept
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-handling-and-category
...... display 1..1 string Representation defined by the system
Fixed Value: Defined in handling and category elements
... category 2..* BackboneElement A grouping for dichotomous, ordinal, or polychotomouos variables
.... name 1..1 string Description of the grouping

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
Interfaces Implemented: MetadataResource
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
... relatesTo 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.
.... target[x] 1..1 The artifact that is related to this EvidenceVariable
..... targetUri uri
..... targetAttachment Attachment
..... targetCanonical canonical(Resource)
..... targetReference Reference(Resource)
..... targetMarkdown markdown
... actual 0..1 boolean Actual or conceptual
... definition Σ 0..1 CodeableReference(Group) The meaning of the evidence variable
Binding: EvidenceVariableDefinition (example)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept 0..1 CodeableConcept Reference to a concept (by class)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-handling-and-category
...... display 1..1 string Representation defined by the system
Fixed Value: Defined in handling and category elements
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... reference 0..1 Reference() Reference to a resource (by instance)
... 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)
... category 2..* 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 1..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

Path Status Usage ValueSet Version Source
EvidenceVariable.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.status Base required PublicationStatus 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.relatesTo.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.definition Base example Evidence Variable Definition 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.definitionModifier.​code Base example Evidence Variable Definition Modifier Code 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.handling Base required Evidence Variable Handling 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.classifier Base example Evidence Variable Classifier 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.dataStorage.​datatype Base preferred All FHIR Types 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.constraint.​conditional Base example AdministrativeGender 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.constraint.​code Base example Evidence Variable Constraint 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.missingDataMeaning Base example Data Absent Reason 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.unacceptableDataHandling Base example Evidence Variable Unacceptable Data Handling 📍6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning EvidenceVariable 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('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from VariableDefinition

Summary

Mandatory: 1 element(1 nested mandatory element)

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* VariableDefinition A definition of an exposure, outcome, or other variable
Interfaces Implemented: MetadataResource
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.
... handling 1..1 code boolean | continuous | dichotomous | ordinal | polychotomous | extension
Binding: EvidenceVariableHandling (required)
... category 2..* BackboneElement A grouping for dichotomous, ordinal, or polychotomouos variables
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 1..1 string Description of the grouping

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EvidenceVariable.status Base required PublicationStatus 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.handling Base required Evidence Variable Handling 📍6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning EvidenceVariable 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}$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must 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
Interfaces Implemented: MetadataResource
... definition
.... concept
..... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-handling-and-category
...... display 1..1 string Representation defined by the system
Fixed Value: Defined in handling and category elements
... category 2..* BackboneElement A grouping for dichotomous, ordinal, or polychotomouos variables
.... name 1..1 string Description of the grouping

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
Interfaces Implemented: MetadataResource
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
... relatesTo 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.
.... target[x] 1..1 The artifact that is related to this EvidenceVariable
..... targetUri uri
..... targetAttachment Attachment
..... targetCanonical canonical(Resource)
..... targetReference Reference(Resource)
..... targetMarkdown markdown
... actual 0..1 boolean Actual or conceptual
... definition Σ 0..1 CodeableReference(Group) The meaning of the evidence variable
Binding: EvidenceVariableDefinition (example)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept 0..1 CodeableConcept Reference to a concept (by class)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fevir.net/resources/CodeSystem/179423
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: defined-in-handling-and-category
...... display 1..1 string Representation defined by the system
Fixed Value: Defined in handling and category elements
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
.... reference 0..1 Reference() Reference to a resource (by instance)
... 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)
... category 2..* 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 1..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

Path Status Usage ValueSet Version Source
EvidenceVariable.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.versionAlgorithm[x] Base extensible Version Algorithm 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.status Base required PublicationStatus 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.relatesTo.​type Base required Artifact Relationship Type 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.definition Base example Evidence Variable Definition 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.definitionModifier.​code Base example Evidence Variable Definition Modifier Code 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.handling Base required Evidence Variable Handling 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.classifier Base example Evidence Variable Classifier 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.dataStorage.​datatype Base preferred All FHIR Types 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.constraint.​conditional Base example AdministrativeGender 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.constraint.​code Base example Evidence Variable Constraint 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.missingDataMeaning Base example Data Absent Reason 📍6.0.0-ballot3 FHIR Std.
EvidenceVariable.unacceptableDataHandling Base example Evidence Variable Unacceptable Data Handling 📍6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning EvidenceVariable 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('^[^|# ]+$')
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from VariableDefinition

Summary

Mandatory: 1 element(1 nested mandatory element)

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron