Clinical Practice Guidelines (CPG) on EBMonFHIR
1.1.0 - qa-preview

This page is part of the CPG-on-EBMonFHIR Implementation Guide (1.1.0).

Resource Profile: PICO Evidence Variable

Defining URL:https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/pico-evidence-variable
Version:0.1.1
Name:PICOEvidenceVariable
Title:PICO Evidence Variable
Status:Draft as of 2022-05-15
Definition:

Description of the a PICO element that knowledge is about. This abstract resource is used as parent for all PICO (population, intervention, comparison, outcome) evidence variables.

Publisher:Netzwerk Universitätsmedizin (NUM),
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

https://www.netzwerk-universitaetsmedizin.de/fhir/cpg-on-ebm-on-fhir/StructureDefinition/pico-evidence-variable

Guidance

Abstract profile used as parent to describe the Recommendation Eligibility Criteria, Study Eligibility Criteria, Outcome Definition and Intervention Definition) of a specific Recommendation. This profile is not used directly, but serves as a collection of constraints common to said EvidenceVariable resources. See the specific EvidenceVariable definitions for more information.

This profile of a FHIR EvidenceVariable is derived from the EvidenceVariable FHIR resource.

Formal Views of Profile Content

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

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

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url ΣC 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ 0..* Identifier Additional identifier for the evidence variable
... version Σ 0..1 string Business version of the evidence variable
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣC 1..1 string Name for this evidence variable (computer friendly)
... title Σ 0..1 string Name for this evidence variable (human friendly)
... shortTitle Σ 0..1 string Title for use in informal contexts
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the evidence variable
... note 0..* Annotation Used for footnotes or explanatory notes
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this EvidenceVariable is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the resource was approved by publisher
... lastReviewDate 0..1 date When the resource was last reviewed by the publisher
... effectivePeriod 0..1 Period When the resource is expected to be used
... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
... actual 0..1 boolean Actual or conceptual
... characteristic SΣC 1..* BackboneElement A defining factor of the EvidenceVariable
evv-1: In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination
evidence-variable-unique-definition: For each characteristic, one and only one type of definition must exist
.... 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 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 SC 1..* See characteristic (EvidenceVariable) A defining factor of the characteristic
evidence-variable-unique-definition: For each characteristic, one and only one type of definition must exist
.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable 0..* EvidenceVariable This is an abstractprofile. Childprofiles: EligibilityCriteria, EvidenceDataSet, InterventionDefinition, OutcomeDefinition
A definition of an exposure, outcome, or other variable
... name ΣC 1..1 string Name for this evidence variable (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... characteristic ΣC 1..* BackboneElement A defining factor of the EvidenceVariable
evv-1: In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination
evidence-variable-unique-definition: For each characteristic, one and only one type of definition must exist
.... definitionByCombination C 0..1 BackboneElement Used to specify how two or more characteristics are combined
..... characteristic C 1..* See characteristic (EvidenceVariable) A defining factor of the characteristic
evidence-variable-unique-definition: For each characteristic, one and only one type of definition must exist

doco Documentation for this format

This structure is derived from EvidenceVariable

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable EvidenceVariable This is an abstractprofile. Childprofiles: EligibilityCriteria, EvidenceDataSet, InterventionDefinition, OutcomeDefinition
... name S 1..1 string Name for this evidence variable (computer friendly)
... status S 1..1 code draft | active | retired | unknown
... characteristic SC 1..* BackboneElement A defining factor of the EvidenceVariable
evidence-variable-unique-definition: For each characteristic, one and only one type of definition must exist
.... definitionByCombination
..... characteristic SC 1..* A defining factor of the characteristic
evidence-variable-unique-definition: For each characteristic, one and only one type of definition must exist

doco Documentation for this format

This structure is derived from EvidenceVariable

Summary

Mandatory: 2 elements
Must-Support: 4 elements

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
EvidenceVariable.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
EvidenceVariable.versionAlgorithm[x]extensibleVersionAlgorithm
http://hl7.org/fhir/ValueSet/version-algorithm
from the FHIR Standard
EvidenceVariable.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
from the FHIR Standard
EvidenceVariable.characteristic.definitionByTypeAndValue.typeexampleUsageContextType
http://terminology.hl7.org/ValueSet/usage-context-type
EvidenceVariable.characteristic.definitionByTypeAndValue.methodexampleDefinitionMethod
http://hl7.org/fhir/ValueSet/definition-method
from the FHIR Standard
EvidenceVariable.characteristic.definitionByTypeAndValue.offsetexampleCharacteristicOffset
http://hl7.org/fhir/ValueSet/characteristic-offset
from the FHIR Standard
EvidenceVariable.characteristic.definitionByCombination.coderequiredCharacteristicCombination
http://hl7.org/fhir/ValueSet/characteristic-combination|5.0.0
from the FHIR Standard
EvidenceVariable.characteristic.timeFromEvent.event[x]exampleEvidenceVariableEvent
http://hl7.org/fhir/ValueSet/evidence-variable-event
from the FHIR Standard
EvidenceVariable.handlingrequiredEvidenceVariableHandling
http://hl7.org/fhir/ValueSet/variable-handling|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
evidence-variable-unique-definitionerrorEvidenceVariable.characteristic, EvidenceVariable.characteristic.definitionByCombination.characteristicFor each characteristic, one and only one type of definition must exist
: ( definitionReference.exists().toInteger() + definitionCanonical.exists().toInteger() + definitionCodeableConcept.exists().toInteger() + definitionExpression.exists().toInteger() + definitionId.exists().toInteger() + definitionByTypeAndValue.exists().toInteger() + definitionByCombination.exists().toInteger() ) = 1