Release 4

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

14.10 Resource EvidenceVariable - Content

Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

The EvidenceVariable resource describes a "PICO" element that knowledge (evidence, assertion, recommendation) is about.

14.10.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

The scope of the EvidenceVariable resource is to describe a "PICO" element that knowledge (evidence, assertion, recommendation) is about. PICO stands for: Population - the population within which exposures and outcomes are being considered Intervention - the conditional state or exposure state being described for which one is expressing the risk of or effect on an outcome Comparison - the alternative conditional state or alternative exposure state when one is comparing states for the effect on an outcome Outcome - the result or effect of an intervention or exposure in a population PICO (and its variants like PECO or PICOT) is a universal acronym used in evidence-based medicine communities to clearly express research questions and evidence findings. The EvidenceVariable resource allows expression of the components of a PICO question in codeable and reusable formats.

14.10.2 Boundaries and Relationships

Multiple resources describing evidence findings (Evidence, EffectEvidenceSynthesis, EffectEvidenceBit, RiskEvidenceSynthesis, RiskEvidenceBit) will reference EvidenceVariable to describe what the evidence findings are about.

This resource is referenced by EffectEvidenceSynthesis, Evidence and RiskEvidenceSynthesis

14.10.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable ITUDomainResourceA population, intervention, or exposure definition
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this evidence variable, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the evidence variable
... version Σ0..1stringBusiness version of the evidence variable
... name ΣI0..1stringName for this evidence variable (computer friendly)
... title Σ0..1stringName for this evidence variable (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the EvidenceVariable
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the evidence variable
... note 0..*AnnotationUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for evidence variable (if applicable)
Jurisdiction (Extensible)
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the evidence variable was approved by publisher
... lastReviewDate 0..1dateWhen the evidence variable was last reviewed
... effectivePeriod Σ0..1PeriodWhen the evidence variable is expected to be used
... topic 0..*CodeableConceptThe category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... type Σ0..1codedichotomous | continuous | descriptive
EvidenceVariableType (Required)
... characteristic Σ1..*BackboneElementWhat defines the members of the evidence element
.... description 0..1stringNatural language description of the characteristic
.... definition[x] Σ1..1What code or expression defines members?
..... definitionReferenceReference(Group)
..... definitionCanonicalcanonical(ActivityDefinition)
..... definitionCodeableConceptCodeableConcept
..... definitionExpressionExpression
..... definitionDataRequirementDataRequirement
..... definitionTriggerDefinitionTriggerDefinition
.... usageContext 0..*UsageContextWhat code/value pairs define members?
.... exclude 0..1booleanWhether the characteristic includes or excludes members
.... participantEffective[x] 0..1What time period do participants cover
..... participantEffectiveDateTimedateTime
..... participantEffectivePeriodPeriod
..... participantEffectiveDurationDuration
..... participantEffectiveTimingTiming
.... timeFromStart 0..1DurationObservation time from study start
.... groupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)

doco Documentation for this format

UML Diagram (Legend)

EvidenceVariable (DomainResource)An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the evidence variabletitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the EvidenceVariable giving additional information about its contentsubtitle : string [0..1]The status of this evidence variable. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changesdate : dateTime [0..1]The name of the organization or individual that published the evidence variablepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the evidence variable from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcenote : Annotation [0..*]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instancesuseContext : UsageContext [0..*]A legal or geographic region in which the evidence variable is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variablecopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the evidence variable content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]The type of evidence element, a population, an exposure, or an outcometype : code [0..1] « The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). (Strength=Required)EvidenceVariableType! »CharacteristicA short, natural language description of the characteristic that could be used to communicate the criteria to an end-userdescription : string [0..1]Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year)definition[x] : Type [1..1] « Reference(Group)|canonical( ActivityDefinition)|CodeableConcept|Expression|DataRequirement| TriggerDefinition »Use UsageContext to define the members of the population, such as Age Ranges, Genders, SettingsusageContext : UsageContext [0..*]When true, members with this characteristic are excluded from the elementexclude : boolean [0..1]Indicates what effective period the study coversparticipantEffective[x] : Type [0..1] « dateTime|Period|Duration| Timing »Indicates duration from the participant's study entrytimeFromStart : Duration [0..1]Indicates how elements are aggregated within the study effective periodgroupMeasure : code [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required)GroupMeasure! »A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semanticscharacteristic[1..*]

XML Template

<EvidenceVariable xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the evidence variable -->
 <name value="[string]"/><!-- ?? 0..1 Name for this evidence variable (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this evidence variable (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the evidence variable -->
 <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for evidence variable (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the evidence variable was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the evidence variable was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the evidence variable is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <type value="[code]"/><!-- 0..1 dichotomous | continuous | descriptive -->
 <characteristic>  <!-- 1..* What defines the members of the evidence element -->
  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <definition[x]><!-- 1..1 Reference(Group)|canonical(ActivityDefinition)|
    CodeableConcept|Expression|DataRequirement|TriggerDefinition What code or expression defines members? --></definition[x]>
  <usageContext><!-- 0..* UsageContext What code/value pairs define members? --></usageContext>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <participantEffective[x]><!-- 0..1 dateTime|Period|Duration|Timing What time period do participants cover --></participantEffective[x]>
  <timeFromStart><!-- 0..1 Duration Observation time from study start --></timeFromStart>
  <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
 </characteristic>
</EvidenceVariable>

JSON Template

{doco
  "resourceType" : "EvidenceVariable",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the evidence variable
  "version" : "<string>", // Business version of the evidence variable
  "name" : "<string>", // C? Name for this evidence variable (computer friendly)
  "title" : "<string>", // Name for this evidence variable (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the EvidenceVariable
  "status" : "<code>", // R!  draft | active | retired | unknown
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the evidence variable
  "note" : [{ Annotation }], // Used for footnotes or explanatory notes
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for evidence variable (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the evidence variable was approved by publisher
  "lastReviewDate" : "<date>", // When the evidence variable was last reviewed
  "effectivePeriod" : { Period }, // When the evidence variable is expected to be used
  "topic" : [{ CodeableConcept }], // The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "type" : "<code>", // dichotomous | continuous | descriptive
  "characteristic" : [{ // R!  What defines the members of the evidence element
    "description" : "<string>", // Natural language description of the characteristic
    // definition[x]: What code or expression defines members?. One of these 6:
    "definitionReference" : { Reference(Group) },
    "definitionCanonical" : { canonical(ActivityDefinition) },
    "definitionCodeableConcept" : { CodeableConcept },
    "definitionExpression" : { Expression },
    "definitionDataRequirement" : { DataRequirement },
    "definitionTriggerDefinition" : { TriggerDefinition },
    "usageContext" : [{ UsageContext }], // What code/value pairs define members?
    "exclude" : <boolean>, // Whether the characteristic includes or excludes members
    // participantEffective[x]: What time period do participants cover. One of these 4:
    "participantEffectiveDateTime" : "<dateTime>",
    "participantEffectivePeriod" : { Period },
    "participantEffectiveDuration" : { Duration },
    "participantEffectiveTiming" : { Timing },
    "timeFromStart" : { Duration }, // Observation time from study start
    "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:EvidenceVariable;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable
  fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable
  fhir:EvidenceVariable.name [ string ]; # 0..1 Name for this evidence variable (computer friendly)
  fhir:EvidenceVariable.title [ string ]; # 0..1 Name for this evidence variable (human friendly)
  fhir:EvidenceVariable.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:EvidenceVariable.subtitle [ string ]; # 0..1 Subordinate title of the EvidenceVariable
  fhir:EvidenceVariable.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed
  fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable
  fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EvidenceVariable.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for evidence variable (if applicable)
  fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the evidence variable was approved by publisher
  fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the evidence variable was last reviewed
  fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the evidence variable is expected to be used
  fhir:EvidenceVariable.topic [ CodeableConcept ], ... ; # 0..* The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.
  fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:EvidenceVariable.type [ code ]; # 0..1 dichotomous | continuous | descriptive
  fhir:EvidenceVariable.characteristic [ # 1..* What defines the members of the evidence element
    fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic
    # EvidenceVariable.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 6
      fhir:EvidenceVariable.characteristic.definitionReference [ Reference(Group) ]
      fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(ActivityDefinition) ]
      fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]
      fhir:EvidenceVariable.characteristic.definitionDataRequirement [ DataRequirement ]
      fhir:EvidenceVariable.characteristic.definitionTriggerDefinition [ TriggerDefinition ]
    fhir:EvidenceVariable.characteristic.usageContext [ UsageContext ], ... ; # 0..* What code/value pairs define members?
    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    # EvidenceVariable.characteristic.participantEffective[x] : 0..1 What time period do participants cover. One of these 4
      fhir:EvidenceVariable.characteristic.participantEffectiveDateTime [ dateTime ]
      fhir:EvidenceVariable.characteristic.participantEffectivePeriod [ Period ]
      fhir:EvidenceVariable.characteristic.participantEffectiveDuration [ Duration ]
      fhir:EvidenceVariable.characteristic.participantEffectiveTiming [ Timing ]
    fhir:EvidenceVariable.characteristic.timeFromStart [ Duration ]; # 0..1 Observation time from study start
    fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable ITUDomainResourceA population, intervention, or exposure definition
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this evidence variable, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the evidence variable
... version Σ0..1stringBusiness version of the evidence variable
... name ΣI0..1stringName for this evidence variable (computer friendly)
... title Σ0..1stringName for this evidence variable (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the EvidenceVariable
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the evidence variable
... note 0..*AnnotationUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for evidence variable (if applicable)
Jurisdiction (Extensible)
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the evidence variable was approved by publisher
... lastReviewDate 0..1dateWhen the evidence variable was last reviewed
... effectivePeriod Σ0..1PeriodWhen the evidence variable is expected to be used
... topic 0..*CodeableConceptThe category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... type Σ0..1codedichotomous | continuous | descriptive
EvidenceVariableType (Required)
... characteristic Σ1..*BackboneElementWhat defines the members of the evidence element
.... description 0..1stringNatural language description of the characteristic
.... definition[x] Σ1..1What code or expression defines members?
..... definitionReferenceReference(Group)
..... definitionCanonicalcanonical(ActivityDefinition)
..... definitionCodeableConceptCodeableConcept
..... definitionExpressionExpression
..... definitionDataRequirementDataRequirement
..... definitionTriggerDefinitionTriggerDefinition
.... usageContext 0..*UsageContextWhat code/value pairs define members?
.... exclude 0..1booleanWhether the characteristic includes or excludes members
.... participantEffective[x] 0..1What time period do participants cover
..... participantEffectiveDateTimedateTime
..... participantEffectivePeriodPeriod
..... participantEffectiveDurationDuration
..... participantEffectiveTimingTiming
.... timeFromStart 0..1DurationObservation time from study start
.... groupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)

doco Documentation for this format

UML Diagram (Legend)

EvidenceVariable (DomainResource)An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the evidence variabletitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the EvidenceVariable giving additional information about its contentsubtitle : string [0..1]The status of this evidence variable. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changesdate : dateTime [0..1]The name of the organization or individual that published the evidence variablepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the evidence variable from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcenote : Annotation [0..*]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instancesuseContext : UsageContext [0..*]A legal or geographic region in which the evidence variable is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variablecopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the evidence variable content was or is planned to be in active useeffectivePeriod : Period [0..1]Descriptive topics related to the content of the EvidenceVariable. Topics provide a high-level categorization grouping types of EvidenceVariables that can be useful for filtering and searchingtopic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example)DefinitionTopic?? »An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]The type of evidence element, a population, an exposure, or an outcometype : code [0..1] « The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). (Strength=Required)EvidenceVariableType! »CharacteristicA short, natural language description of the characteristic that could be used to communicate the criteria to an end-userdescription : string [0..1]Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year)definition[x] : Type [1..1] « Reference(Group)|canonical( ActivityDefinition)|CodeableConcept|Expression|DataRequirement| TriggerDefinition »Use UsageContext to define the members of the population, such as Age Ranges, Genders, SettingsusageContext : UsageContext [0..*]When true, members with this characteristic are excluded from the elementexclude : boolean [0..1]Indicates what effective period the study coversparticipantEffective[x] : Type [0..1] « dateTime|Period|Duration| Timing »Indicates duration from the participant's study entrytimeFromStart : Duration [0..1]Indicates how elements are aggregated within the study effective periodgroupMeasure : code [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required)GroupMeasure! »A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semanticscharacteristic[1..*]

XML Template

<EvidenceVariable xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the evidence variable -->
 <name value="[string]"/><!-- ?? 0..1 Name for this evidence variable (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this evidence variable (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the evidence variable -->
 <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for evidence variable (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the evidence variable was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the evidence variable was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the evidence variable is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <type value="[code]"/><!-- 0..1 dichotomous | continuous | descriptive -->
 <characteristic>  <!-- 1..* What defines the members of the evidence element -->
  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <definition[x]><!-- 1..1 Reference(Group)|canonical(ActivityDefinition)|
    CodeableConcept|Expression|DataRequirement|TriggerDefinition What code or expression defines members? --></definition[x]>
  <usageContext><!-- 0..* UsageContext What code/value pairs define members? --></usageContext>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <participantEffective[x]><!-- 0..1 dateTime|Period|Duration|Timing What time period do participants cover --></participantEffective[x]>
  <timeFromStart><!-- 0..1 Duration Observation time from study start --></timeFromStart>
  <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
 </characteristic>
</EvidenceVariable>

JSON Template

{doco
  "resourceType" : "EvidenceVariable",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the evidence variable
  "version" : "<string>", // Business version of the evidence variable
  "name" : "<string>", // C? Name for this evidence variable (computer friendly)
  "title" : "<string>", // Name for this evidence variable (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the EvidenceVariable
  "status" : "<code>", // R!  draft | active | retired | unknown
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the evidence variable
  "note" : [{ Annotation }], // Used for footnotes or explanatory notes
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for evidence variable (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the evidence variable was approved by publisher
  "lastReviewDate" : "<date>", // When the evidence variable was last reviewed
  "effectivePeriod" : { Period }, // When the evidence variable is expected to be used
  "topic" : [{ CodeableConcept }], // The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "type" : "<code>", // dichotomous | continuous | descriptive
  "characteristic" : [{ // R!  What defines the members of the evidence element
    "description" : "<string>", // Natural language description of the characteristic
    // definition[x]: What code or expression defines members?. One of these 6:
    "definitionReference" : { Reference(Group) },
    "definitionCanonical" : { canonical(ActivityDefinition) },
    "definitionCodeableConcept" : { CodeableConcept },
    "definitionExpression" : { Expression },
    "definitionDataRequirement" : { DataRequirement },
    "definitionTriggerDefinition" : { TriggerDefinition },
    "usageContext" : [{ UsageContext }], // What code/value pairs define members?
    "exclude" : <boolean>, // Whether the characteristic includes or excludes members
    // participantEffective[x]: What time period do participants cover. One of these 4:
    "participantEffectiveDateTime" : "<dateTime>",
    "participantEffectivePeriod" : { Period },
    "participantEffectiveDuration" : { Duration },
    "participantEffectiveTiming" : { Timing },
    "timeFromStart" : { Duration }, // Observation time from study start
    "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:EvidenceVariable;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable
  fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable
  fhir:EvidenceVariable.name [ string ]; # 0..1 Name for this evidence variable (computer friendly)
  fhir:EvidenceVariable.title [ string ]; # 0..1 Name for this evidence variable (human friendly)
  fhir:EvidenceVariable.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:EvidenceVariable.subtitle [ string ]; # 0..1 Subordinate title of the EvidenceVariable
  fhir:EvidenceVariable.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed
  fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable
  fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EvidenceVariable.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for evidence variable (if applicable)
  fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the evidence variable was approved by publisher
  fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the evidence variable was last reviewed
  fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the evidence variable is expected to be used
  fhir:EvidenceVariable.topic [ CodeableConcept ], ... ; # 0..* The category of the EvidenceVariable, such as Education, Treatment, Assessment, etc.
  fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:EvidenceVariable.type [ code ]; # 0..1 dichotomous | continuous | descriptive
  fhir:EvidenceVariable.characteristic [ # 1..* What defines the members of the evidence element
    fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic
    # EvidenceVariable.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 6
      fhir:EvidenceVariable.characteristic.definitionReference [ Reference(Group) ]
      fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(ActivityDefinition) ]
      fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]
      fhir:EvidenceVariable.characteristic.definitionDataRequirement [ DataRequirement ]
      fhir:EvidenceVariable.characteristic.definitionTriggerDefinition [ TriggerDefinition ]
    fhir:EvidenceVariable.characteristic.usageContext [ UsageContext ], ... ; # 0..* What code/value pairs define members?
    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    # EvidenceVariable.characteristic.participantEffective[x] : 0..1 What time period do participants cover. One of these 4
      fhir:EvidenceVariable.characteristic.participantEffectiveDateTime [ dateTime ]
      fhir:EvidenceVariable.characteristic.participantEffectivePeriod [ Period ]
      fhir:EvidenceVariable.characteristic.participantEffectiveDuration [ Duration ]
      fhir:EvidenceVariable.characteristic.participantEffectiveTiming [ Timing ]
    fhir:EvidenceVariable.characteristic.timeFromStart [ Duration ]; # 0..1 Observation time from study start
    fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

14.10.3.1 Terminology Bindings

PathDefinitionTypeReference
EvidenceVariable.status The lifecycle status of an artifact.RequiredPublicationStatus
EvidenceVariable.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
EvidenceVariable.topic High-level categorization of the definition, used for searching, sorting, and filtering.ExampleDefinitionTopic
EvidenceVariable.type The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive).RequiredEvidenceVariableType
EvidenceVariable.characteristic.groupMeasure Possible group measure aggregates (E.g. Mean, Median).RequiredGroupMeasure

14.10.3.2 Constraints

idLevelLocationDescriptionExpression
evv-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

14.10.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='composed-of').resource
(Any)
contexttokenA use context assigned to the evidence variable(EvidenceVariable.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the evidence variable(EvidenceVariable.useContext.value as Quantity) | (EvidenceVariable.useContext.value as Range)
context-typetokenA type of use context assigned to the evidence variableEvidenceVariable.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the evidence variableOn EvidenceVariable.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the evidence variableOn EvidenceVariable.useContext:
  context-type: code
  context: value.as(CodeableConcept)
datedateThe evidence variable publication dateEvidenceVariable.date
depends-onreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='depends-on').resource
(Any)
derived-fromreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='derived-from').resource
(Any)
descriptionstringThe description of the evidence variableEvidenceVariable.description
effectivedateThe time during which the evidence variable is intended to be in useEvidenceVariable.effectivePeriod
identifiertokenExternal identifier for the evidence variableEvidenceVariable.identifier
jurisdictiontokenIntended jurisdiction for the evidence variableEvidenceVariable.jurisdiction
namestringComputationally friendly name of the evidence variableEvidenceVariable.name
predecessorreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='predecessor').resource
(Any)
publisherstringName of the publisher of the evidence variableEvidenceVariable.publisher
statustokenThe current status of the evidence variableEvidenceVariable.status
successorreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='successor').resource
(Any)
titlestringThe human-friendly name of the evidence variableEvidenceVariable.title
topictokenTopics associated with the EvidenceVariableEvidenceVariable.topic
urluriThe uri that identifies the evidence variableEvidenceVariable.url
versiontokenThe business version of the evidence variableEvidenceVariable.version