Requirements Federated Learning and mUlti-party computation Techniques for prostatE cancer
0.1.0 - ci-build
Funded by the European Union

Requirements Federated Learning and mUlti-party computation Techniques for prostatE cancer, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/flute-requirements/ and changes regularly. See the Directory of published versions

Resource Profile: PR-EvidenceVariable ( Experimental )

Official URL: https://flute.com/StructureDefinition/PR-EvidenceVariable Version: 0.1.0
Draft as of 2026-01-30 Computable Name: PR_EvidenceVariable

A profile for the use of the EvidenceVariable resource for inclusion/exclusion criteria and research variables for cohort and datamart management.

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..* EvidenceVariable 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cqf-library 1..1 canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... title Σ 1..1 string Name for this evidence variable (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description Σ 1..1 markdown Natural language description of the evidence variable
... characteristic ΣC 1..1 BackboneElement A defining factor of the EvidenceVariable
Constraints: evv-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... definitionByCombination SC 1..1 BackboneElement Used to specify how two or more characteristics are combined
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: CharacteristicCombination (required)
..... characteristic 1..* BackboneElement A defining factor of the characteristic
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... exclude S 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
...... definitionExpression SΣ 0..1 Expression Defines the characteristic (without using type and value) by an expression

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EvidenceVariable.status Base required PublicationStatus 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​code Base required Characteristic Combination 📍5.0.0 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())
evv-1 error EvidenceVariable.characteristic In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination (definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count()) < 2
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from EvidenceVariable

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable 0..* EvidenceVariable A definition of an exposure, outcome, or other variable
Interfaces Implemented: MetadataResource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cqf-library 1..1 canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... title 1..1 string Name for this evidence variable (human friendly)
... description 1..1 markdown Natural language description of the evidence variable
.... definitionByCombination S 1..1 BackboneElement Used to specify how two or more characteristics are combined
..... characteristic 1..* BackboneElement A defining factor of the characteristic
...... exclude S 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
...... definitionExpression S 0..1 Expression Defines the characteristic (without using type and value) by an expression

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* EvidenceVariable 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cqf-library 1..1 canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... 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 Σ 1..1 string Name for this evidence variable (human friendly)
... shortTitle Σ 0..1 string Title for use in informal contexts
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the evidence variable
... note 0..* Annotation Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this EvidenceVariable is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the resource was approved by publisher
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
... effectivePeriod 0..1 Period When the resource is expected to be used
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... actual 0..1 boolean Actual or conceptual
... characteristic ΣC 1..1 BackboneElement A defining factor of the EvidenceVariable
Constraints: evv-1
.... 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
.... linkId 0..1 id Label for internal linking
.... description 0..1 markdown Natural language description of the characteristic
.... note 0..* Annotation Used for footnotes or explanatory notes
.... exclude 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
.... definitionReference ΣC 0..1 Reference(EvidenceVariable | Group | Evidence) Defines the characteristic (without using type and value) by a Reference
.... definitionCanonical ΣC 0..1 canonical(EvidenceVariable | Evidence) Defines the characteristic (without using type and value) by a Canonical
.... definitionCodeableConcept ΣC 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept
.... definitionExpression Σ 0..1 Expression Defines the characteristic (without using type and value) by an expression
.... definitionId ΣC 0..1 id Defines the characteristic (without using type and value) by an id
.... definitionByTypeAndValue ΣC 0..1 BackboneElement Defines the characteristic using type and 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
..... type Σ 1..1 CodeableConcept Expresses the type of characteristic
Binding: UsageContextType (example)
..... method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: DefinitionMethod (example)
..... device 0..1 Reference(Device | DeviceMetric) Device used for determining characteristic
..... value[x] Σ 1..1 Defines the characteristic when coupled with characteristic.type
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
...... valueId id
..... offset 0..1 CodeableConcept Reference point for valueQuantity or valueRange
Binding: CharacteristicOffset (example)
.... definitionByCombination SC 1..1 BackboneElement Used to specify how two or more characteristics are combined
..... 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 code all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: CharacteristicCombination (required)
..... threshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
..... characteristic 1..* BackboneElement A defining factor of the characteristic
...... 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
...... linkId 0..1 id Label for internal linking
...... description 0..1 markdown Natural language description of the characteristic
...... note 0..* Annotation Used for footnotes or explanatory notes
...... exclude S 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
...... definitionReference ΣC 0..1 Reference(EvidenceVariable | Group | Evidence) Defines the characteristic (without using type and value) by a Reference
...... definitionCanonical ΣC 0..1 canonical(EvidenceVariable | Evidence) Defines the characteristic (without using type and value) by a Canonical
...... definitionCodeableConcept ΣC 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept
...... definitionExpression SΣ 0..1 Expression Defines the characteristic (without using type and value) by an expression
...... definitionId ΣC 0..1 id Defines the characteristic (without using type and value) by an id
...... definitionByTypeAndValue ΣC 0..1 BackboneElement Defines the characteristic using type and 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
....... type Σ 1..1 CodeableConcept Expresses the type of characteristic
Binding: UsageContextType (example)
....... method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: DefinitionMethod (example)
....... device 0..1 Reference(Device | DeviceMetric) Device used for determining characteristic
....... value[x] Σ 1..1 Defines the characteristic when coupled with characteristic.type
........ valueCodeableConcept CodeableConcept
........ valueBoolean boolean
........ valueQuantity Quantity
........ valueRange Range
........ valueReference Reference(Any)
........ valueId id
....... offset 0..1 CodeableConcept Reference point for valueQuantity or valueRange
Binding: CharacteristicOffset (example)
...... definitionByCombination C 0..1 BackboneElement Used to specify how two or more characteristics are combined
....... 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 code all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: CharacteristicCombination (required)
....... threshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
....... characteristic 1..* See characteristic (EvidenceVariable) A defining factor of the characteristic
...... instances[x] 0..1 Number of occurrences meeting the characteristic
....... instancesQuantity Quantity
....... instancesRange Range
...... duration[x] 0..1 Length of time in which the characteristic is met
....... durationQuantity Quantity
....... durationRange Range
...... timeFromEvent 0..* BackboneElement Timing in which the characteristic is determined
....... 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
....... description 0..1 markdown Human readable description
....... note 0..* Annotation Used for footnotes or explanatory notes
....... event[x] 0..1 The event used as a base point (reference point) in time
Binding: EvidenceVariableEvent (example)
........ eventCodeableConcept CodeableConcept
........ eventReference Reference(Any)
........ eventDateTime dateTime
........ eventId id
....... quantity 0..1 Quantity Used to express the observation at a defined amount of time before or after the event
....... range 0..1 Range Used to express the observation within a period before and/or after the event
.... instances[x] 0..1 Number of occurrences meeting the characteristic
..... instancesQuantity Quantity
..... instancesRange Range
.... duration[x] 0..1 Length of time in which the characteristic is met
..... durationQuantity Quantity
..... durationRange Range
.... timeFromEvent 0..* BackboneElement Timing in which the characteristic is determined
..... 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
..... description 0..1 markdown Human readable description
..... note 0..* Annotation Used for footnotes or explanatory notes
..... event[x] 0..1 The event used as a base point (reference point) in time
Binding: EvidenceVariableEvent (example)
...... eventCodeableConcept CodeableConcept
...... eventReference Reference(Any)
...... eventDateTime dateTime
...... eventId id
..... quantity 0..1 Quantity Used to express the observation at a defined amount of time before or after the event
..... range 0..1 Range Used to express the observation within a period before and/or after the event
... handling 0..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
... category 0..* BackboneElement A grouping for ordinal or polychotomous variables
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Description of the grouping
.... value[x] 0..1 Definition of the grouping
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EvidenceVariable.language Base required All Languages 📍5.0.0 FHIR Std.
EvidenceVariable.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
EvidenceVariable.status Base required PublicationStatus 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByTypeAndValue.​type Base example UsageContextType 📦1.0.1 THO v7.0
EvidenceVariable.characteristic.​definitionByTypeAndValue.​method Base example Definition Method 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByTypeAndValue.​offset Base example Characteristic Offset 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​code Base required Characteristic Combination 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByTypeAndValue.​type Base example UsageContextType 📦1.0.1 THO v7.0
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByTypeAndValue.​method Base example Definition Method 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByTypeAndValue.​offset Base example Characteristic Offset 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByCombination.​code Base required Characteristic Combination 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.timeFromEvent.​event[x] Base example Evidence Variable Event 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​timeFromEvent.event[x] Base example Evidence Variable Event 📍5.0.0 FHIR Std.
EvidenceVariable.handling Base required Evidence Variable Handling 📍5.0.0 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())
evv-1 error EvidenceVariable.characteristic In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination (definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count()) < 2
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from EvidenceVariable

Summary

Mandatory: 6 elements
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* EvidenceVariable 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cqf-library 1..1 canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... title Σ 1..1 string Name for this evidence variable (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description Σ 1..1 markdown Natural language description of the evidence variable
... characteristic ΣC 1..1 BackboneElement A defining factor of the EvidenceVariable
Constraints: evv-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... definitionByCombination SC 1..1 BackboneElement Used to specify how two or more characteristics are combined
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 code all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: CharacteristicCombination (required)
..... characteristic 1..* BackboneElement A defining factor of the characteristic
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... exclude S 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
...... definitionExpression SΣ 0..1 Expression Defines the characteristic (without using type and value) by an expression

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EvidenceVariable.status Base required PublicationStatus 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​code Base required Characteristic Combination 📍5.0.0 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())
evv-1 error EvidenceVariable.characteristic In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination (definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count()) < 2
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 EvidenceVariable

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable 0..* EvidenceVariable A definition of an exposure, outcome, or other variable
Interfaces Implemented: MetadataResource
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cqf-library 1..1 canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... title 1..1 string Name for this evidence variable (human friendly)
... description 1..1 markdown Natural language description of the evidence variable
.... definitionByCombination S 1..1 BackboneElement Used to specify how two or more characteristics are combined
..... characteristic 1..* BackboneElement A defining factor of the characteristic
...... exclude S 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
...... definitionExpression S 0..1 Expression Defines the characteristic (without using type and value) by an expression

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EvidenceVariable C 0..* EvidenceVariable 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:cqf-library 1..1 canonical(Library) A library containing logic used by the artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-library
... 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 Σ 1..1 string Name for this evidence variable (human friendly)
... shortTitle Σ 0..1 string Title for use in informal contexts
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 1..1 markdown Natural language description of the evidence variable
... note 0..* Annotation Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this EvidenceVariable is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the resource was approved by publisher
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
... effectivePeriod 0..1 Period When the resource is expected to be used
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... actual 0..1 boolean Actual or conceptual
... characteristic ΣC 1..1 BackboneElement A defining factor of the EvidenceVariable
Constraints: evv-1
.... 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
.... linkId 0..1 id Label for internal linking
.... description 0..1 markdown Natural language description of the characteristic
.... note 0..* Annotation Used for footnotes or explanatory notes
.... exclude 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
.... definitionReference ΣC 0..1 Reference(EvidenceVariable | Group | Evidence) Defines the characteristic (without using type and value) by a Reference
.... definitionCanonical ΣC 0..1 canonical(EvidenceVariable | Evidence) Defines the characteristic (without using type and value) by a Canonical
.... definitionCodeableConcept ΣC 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept
.... definitionExpression Σ 0..1 Expression Defines the characteristic (without using type and value) by an expression
.... definitionId ΣC 0..1 id Defines the characteristic (without using type and value) by an id
.... definitionByTypeAndValue ΣC 0..1 BackboneElement Defines the characteristic using type and 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
..... type Σ 1..1 CodeableConcept Expresses the type of characteristic
Binding: UsageContextType (example)
..... method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: DefinitionMethod (example)
..... device 0..1 Reference(Device | DeviceMetric) Device used for determining characteristic
..... value[x] Σ 1..1 Defines the characteristic when coupled with characteristic.type
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
...... valueId id
..... offset 0..1 CodeableConcept Reference point for valueQuantity or valueRange
Binding: CharacteristicOffset (example)
.... definitionByCombination SC 1..1 BackboneElement Used to specify how two or more characteristics are combined
..... 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 code all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: CharacteristicCombination (required)
..... threshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
..... characteristic 1..* BackboneElement A defining factor of the characteristic
...... 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
...... linkId 0..1 id Label for internal linking
...... description 0..1 markdown Natural language description of the characteristic
...... note 0..* Annotation Used for footnotes or explanatory notes
...... exclude S 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion
...... definitionReference ΣC 0..1 Reference(EvidenceVariable | Group | Evidence) Defines the characteristic (without using type and value) by a Reference
...... definitionCanonical ΣC 0..1 canonical(EvidenceVariable | Evidence) Defines the characteristic (without using type and value) by a Canonical
...... definitionCodeableConcept ΣC 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept
...... definitionExpression SΣ 0..1 Expression Defines the characteristic (without using type and value) by an expression
...... definitionId ΣC 0..1 id Defines the characteristic (without using type and value) by an id
...... definitionByTypeAndValue ΣC 0..1 BackboneElement Defines the characteristic using type and 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
....... type Σ 1..1 CodeableConcept Expresses the type of characteristic
Binding: UsageContextType (example)
....... method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: DefinitionMethod (example)
....... device 0..1 Reference(Device | DeviceMetric) Device used for determining characteristic
....... value[x] Σ 1..1 Defines the characteristic when coupled with characteristic.type
........ valueCodeableConcept CodeableConcept
........ valueBoolean boolean
........ valueQuantity Quantity
........ valueRange Range
........ valueReference Reference(Any)
........ valueId id
....... offset 0..1 CodeableConcept Reference point for valueQuantity or valueRange
Binding: CharacteristicOffset (example)
...... definitionByCombination C 0..1 BackboneElement Used to specify how two or more characteristics are combined
....... 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 code all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: CharacteristicCombination (required)
....... threshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
....... characteristic 1..* See characteristic (EvidenceVariable) A defining factor of the characteristic
...... instances[x] 0..1 Number of occurrences meeting the characteristic
....... instancesQuantity Quantity
....... instancesRange Range
...... duration[x] 0..1 Length of time in which the characteristic is met
....... durationQuantity Quantity
....... durationRange Range
...... timeFromEvent 0..* BackboneElement Timing in which the characteristic is determined
....... 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
....... description 0..1 markdown Human readable description
....... note 0..* Annotation Used for footnotes or explanatory notes
....... event[x] 0..1 The event used as a base point (reference point) in time
Binding: EvidenceVariableEvent (example)
........ eventCodeableConcept CodeableConcept
........ eventReference Reference(Any)
........ eventDateTime dateTime
........ eventId id
....... quantity 0..1 Quantity Used to express the observation at a defined amount of time before or after the event
....... range 0..1 Range Used to express the observation within a period before and/or after the event
.... instances[x] 0..1 Number of occurrences meeting the characteristic
..... instancesQuantity Quantity
..... instancesRange Range
.... duration[x] 0..1 Length of time in which the characteristic is met
..... durationQuantity Quantity
..... durationRange Range
.... timeFromEvent 0..* BackboneElement Timing in which the characteristic is determined
..... 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
..... description 0..1 markdown Human readable description
..... note 0..* Annotation Used for footnotes or explanatory notes
..... event[x] 0..1 The event used as a base point (reference point) in time
Binding: EvidenceVariableEvent (example)
...... eventCodeableConcept CodeableConcept
...... eventReference Reference(Any)
...... eventDateTime dateTime
...... eventId id
..... quantity 0..1 Quantity Used to express the observation at a defined amount of time before or after the event
..... range 0..1 Range Used to express the observation within a period before and/or after the event
... handling 0..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling (required)
... category 0..* BackboneElement A grouping for ordinal or polychotomous variables
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name 0..1 string Description of the grouping
.... value[x] 0..1 Definition of the grouping
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
EvidenceVariable.language Base required All Languages 📍5.0.0 FHIR Std.
EvidenceVariable.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
EvidenceVariable.status Base required PublicationStatus 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByTypeAndValue.​type Base example UsageContextType 📦1.0.1 THO v7.0
EvidenceVariable.characteristic.​definitionByTypeAndValue.​method Base example Definition Method 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByTypeAndValue.​offset Base example Characteristic Offset 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​code Base required Characteristic Combination 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByTypeAndValue.​type Base example UsageContextType 📦1.0.1 THO v7.0
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByTypeAndValue.​method Base example Definition Method 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByTypeAndValue.​offset Base example Characteristic Offset 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.definitionByCombination.​code Base required Characteristic Combination 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​definitionByCombination.​characteristic.timeFromEvent.​event[x] Base example Evidence Variable Event 📍5.0.0 FHIR Std.
EvidenceVariable.characteristic.​timeFromEvent.event[x] Base example Evidence Variable Event 📍5.0.0 FHIR Std.
EvidenceVariable.handling Base required Evidence Variable Handling 📍5.0.0 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())
evv-1 error EvidenceVariable.characteristic In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination (definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count()) < 2
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from EvidenceVariable

Summary

Mandatory: 6 elements
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron