Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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.11 Resource EvidenceVariable - Content

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

The EvidenceVariable resource describes an element that knowledge (Evidence) is about.

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

The scope of the EvidenceVariable Resource is to describe an element that knowledge (evidence) is about. The EvidenceVariable Resources are expected to be used with Evidence Resources to facilitate searching and knowledge representation.

Evidence may be reported for different types of knowledge. One commonly used format for expression of what evidence is about is the "PICO" format. 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. As an exception, the Population specification will NOT use the EvidenceVariable Resource. The Population specification will use the Group Resource to facilitate interoperability in matching Evidence Resources to actual groups.

The Resource describing evidence findings (Evidence) will reference EvidenceVariable to describe what the evidence findings are about.

This resource is referenced by Evidence and itself.

This resource implements the Definition pattern.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable TUDomainResourceA definition of an exposure, outcome, or other variable
+ 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
... 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
... 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
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... 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.
... actual 0..1booleanActual or conceptual
... characteristicCombination 0..1codeintersection | union
CharacteristicCombination (Required)
... characteristic Σ0..*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 | EvidenceVariable)
..... definitionCanonicalcanonical(Any)
..... definitionCodeableConceptCodeableConcept
..... definitionExpressionExpression
.... method 0..1CodeableConceptMethod used for describing characteristic
CharacteristicMethod (Example)
.... device 0..1Reference(Device | DeviceMetric)Device used for determining characteristic
.... exclude 0..1booleanWhether the characteristic includes or excludes members
.... timeFromStart 0..1BackboneElementObservation time from study start
..... description 0..1stringHuman readable description
..... quantity 0..1QuantityUsed to express the observation at a defined amount of time after the study start
..... range 0..1RangeUsed to express the observation within a period after the study start
..... note 0..*AnnotationUsed for footnotes or explanatory notes
.... groupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)
... handling Σ0..1codecontinuous | dichotomous | ordinal | polychotomous
EvidenceVariableHandling (Required)
... category 0..*BackboneElementA grouping for ordinal or polychotomous variables
.... name 0..1stringDescription of the grouping
.... value[x] 0..1Definition of the grouping
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange

doco Documentation for this format

UML Diagram (Legend)

EvidenceVariable (DomainResource)📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025url : uri [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025identifier : Identifier [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025version : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025name : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025title : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025shortTitle : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025subtitle : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025status : code [1..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025PublicationStatus! »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025date : dateTime [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025description : markdown [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025note : Annotation [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025useContext : UsageContext [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025publisher : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025contact : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025author : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025editor : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025reviewer : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025endorser : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025relatedArtifact : RelatedArtifact [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025actual : boolean [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025characteristicCombination : code [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025CharacteristicCombination! »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025handling : code [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025EvidenceVariableHandling! »Characteristic📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025description : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025definition[x] : Element [1..1] « Reference(Group|EvidenceVariable)| canonical(Any)|CodeableConcept|Expression »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025method : CodeableConcept [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025CharacteristicMethod?? »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025device : Reference [0..1] « Device|DeviceMetric »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025exclude : boolean [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025groupMeasure : code [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025GroupMeasure! »TimeFromStart📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025description : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025quantity : Quantity [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025range : Range [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025note : Annotation [0..*]Category📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025name : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025value[x] : Element [0..1] « CodeableConcept|Quantity|Range »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025timeFromStart[0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025characteristic[0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025category[0..*]

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 -->
 <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>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <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>
 <actual value="[boolean]"/><!-- 0..1 Actual or conceptual -->
 <characteristicCombination value="[code]"/><!-- 0..1 intersection | union -->
 <characteristic>  <!-- 0..* What defines the members of the evidence element -->
  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <definition[x]><!-- 1..1 Reference(EvidenceVariable|Group)|canonical(Any)|
    CodeableConcept|Expression What code or expression defines members? --></definition[x]>
  <method><!-- 0..1 CodeableConcept Method used for describing characteristic --></method>
  <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <timeFromStart>  <!-- 0..1 Observation time from study start -->
   <description value="[string]"/><!-- 0..1 Human readable description -->
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range>
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  </timeFromStart>
  <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
 </characteristic>
 <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous -->
 <category>  <!-- 0..* A grouping for ordinal or polychotomous variables -->
  <name value="[string]"/><!-- 0..1 Description of the grouping -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range Definition of the grouping --></value[x]>
 </category>
</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
  "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
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "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.
  "actual" : <boolean>, // Actual or conceptual
  "characteristicCombination" : "<code>", // intersection | union
  "characteristic" : [{ // 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 4:
    "definitionReference" : { Reference(EvidenceVariable|Group) },
    "definitionCanonical" : { canonical(Any) },
    "definitionCodeableConcept" : { CodeableConcept },
    "definitionExpression" : { Expression },
    "method" : { CodeableConcept }, // Method used for describing characteristic
    "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
    "exclude" : <boolean>, // Whether the characteristic includes or excludes members
    "timeFromStart" : { // Observation time from study start
      "description" : "<string>", // Human readable description
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start
      "range" : { Range }, // Used to express the observation within a period after the study start
      "note" : [{ Annotation }] // Used for footnotes or explanatory notes
    },
    "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  }],
  "handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
  "category" : [{ // A grouping for ordinal or polychotomous variables
    "name" : "<string>", // Description of the grouping
    // value[x]: Definition of the grouping. One of these 3:
    "valueCodeableConcept" : { CodeableConcept }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }
  }]
}

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.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.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  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.actual [ boolean ]; # 0..1 Actual or conceptual
  fhir:EvidenceVariable.characteristicCombination [ code ]; # 0..1 intersection | union
  fhir:EvidenceVariable.characteristic [ # 0..* 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 4
      fhir:EvidenceVariable.characteristic.definitionReference [ Reference(EvidenceVariable|Group) ]
      fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Any) ]
      fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]
    fhir:EvidenceVariable.characteristic.method [ CodeableConcept ]; # 0..1 Method used for describing characteristic
    fhir:EvidenceVariable.characteristic.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic
    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    fhir:EvidenceVariable.characteristic.timeFromStart [ # 0..1 Observation time from study start
      fhir:EvidenceVariable.characteristic.timeFromStart.description [ string ]; # 0..1 Human readable description
      fhir:EvidenceVariable.characteristic.timeFromStart.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start
      fhir:EvidenceVariable.characteristic.timeFromStart.range [ Range ]; # 0..1 Used to express the observation within a period after the study start
      fhir:EvidenceVariable.characteristic.timeFromStart.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
    ];
    fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
  fhir:EvidenceVariable.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping
    # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.category.valueQuantity [ Quantity ]
      fhir:EvidenceVariable.category.valueRange [ Range ]
  ], ...;
]

Changes since R4

EvidenceVariable
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristicCombination
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.definition[x]
  • Remove Types DataRequirement, TriggerDefinition
EvidenceVariable.characteristic.method
  • Added Element
EvidenceVariable.characteristic.device
  • Added Element
EvidenceVariable.characteristic.timeFromStart
  • Type changed from Duration to BackboneElement
EvidenceVariable.characteristic.timeFromStart.description
  • Added Element
EvidenceVariable.characteristic.timeFromStart.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromStart.range
  • Added Element
EvidenceVariable.characteristic.timeFromStart.note
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.copyright
  • deleted
EvidenceVariable.approvalDate
  • deleted
EvidenceVariable.lastReviewDate
  • deleted
EvidenceVariable.effectivePeriod
  • deleted
EvidenceVariable.topic
  • deleted
EvidenceVariable.type
  • deleted
EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.characteristic.participantEffective[x]
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Conversions between R3 and R4

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceVariable TUDomainResourceA definition of an exposure, outcome, or other variable
+ 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
... 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
... 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
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... 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.
... actual 0..1booleanActual or conceptual
... characteristicCombination 0..1codeintersection | union
CharacteristicCombination (Required)
... characteristic Σ0..*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 | EvidenceVariable)
..... definitionCanonicalcanonical(Any)
..... definitionCodeableConceptCodeableConcept
..... definitionExpressionExpression
.... method 0..1CodeableConceptMethod used for describing characteristic
CharacteristicMethod (Example)
.... device 0..1Reference(Device | DeviceMetric)Device used for determining characteristic
.... exclude 0..1booleanWhether the characteristic includes or excludes members
.... timeFromStart 0..1BackboneElementObservation time from study start
..... description 0..1stringHuman readable description
..... quantity 0..1QuantityUsed to express the observation at a defined amount of time after the study start
..... range 0..1RangeUsed to express the observation within a period after the study start
..... note 0..*AnnotationUsed for footnotes or explanatory notes
.... groupMeasure 0..1codemean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure (Required)
... handling Σ0..1codecontinuous | dichotomous | ordinal | polychotomous
EvidenceVariableHandling (Required)
... category 0..*BackboneElementA grouping for ordinal or polychotomous variables
.... name 0..1stringDescription of the grouping
.... value[x] 0..1Definition of the grouping
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange

doco Documentation for this format

UML Diagram (Legend)

EvidenceVariable (DomainResource)📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025url : uri [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025identifier : Identifier [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025version : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025name : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025title : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025shortTitle : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025subtitle : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025status : code [1..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025PublicationStatus! »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025date : dateTime [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025description : markdown [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025note : Annotation [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025useContext : UsageContext [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025publisher : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025contact : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025author : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025editor : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025reviewer : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025endorser : ContactDetail [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025relatedArtifact : RelatedArtifact [0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025actual : boolean [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025characteristicCombination : code [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025CharacteristicCombination! »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025handling : code [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025EvidenceVariableHandling! »Characteristic📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025description : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025definition[x] : Element [1..1] « Reference(Group|EvidenceVariable)| canonical(Any)|CodeableConcept|Expression »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025method : CodeableConcept [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025CharacteristicMethod?? »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025device : Reference [0..1] « Device|DeviceMetric »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025exclude : boolean [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025groupMeasure : code [0..1] « 📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025GroupMeasure! »TimeFromStart📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025description : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025quantity : Quantity [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025range : Range [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025note : Annotation [0..*]Category📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025name : string [0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025value[x] : Element [0..1] « CodeableConcept|Quantity|Range »📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025timeFromStart[0..1]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025characteristic[0..*]📢 แจ้งเตือน: fhir/RB/evidencevariable.html - Kapook Update 2025category[0..*]

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 -->
 <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>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <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>
 <actual value="[boolean]"/><!-- 0..1 Actual or conceptual -->
 <characteristicCombination value="[code]"/><!-- 0..1 intersection | union -->
 <characteristic>  <!-- 0..* What defines the members of the evidence element -->
  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <definition[x]><!-- 1..1 Reference(EvidenceVariable|Group)|canonical(Any)|
    CodeableConcept|Expression What code or expression defines members? --></definition[x]>
  <method><!-- 0..1 CodeableConcept Method used for describing characteristic --></method>
  <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <timeFromStart>  <!-- 0..1 Observation time from study start -->
   <description value="[string]"/><!-- 0..1 Human readable description -->
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range>
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  </timeFromStart>
  <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->
 </characteristic>
 <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous -->
 <category>  <!-- 0..* A grouping for ordinal or polychotomous variables -->
  <name value="[string]"/><!-- 0..1 Description of the grouping -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range Definition of the grouping --></value[x]>
 </category>
</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
  "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
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "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.
  "actual" : <boolean>, // Actual or conceptual
  "characteristicCombination" : "<code>", // intersection | union
  "characteristic" : [{ // 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 4:
    "definitionReference" : { Reference(EvidenceVariable|Group) },
    "definitionCanonical" : { canonical(Any) },
    "definitionCodeableConcept" : { CodeableConcept },
    "definitionExpression" : { Expression },
    "method" : { CodeableConcept }, // Method used for describing characteristic
    "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
    "exclude" : <boolean>, // Whether the characteristic includes or excludes members
    "timeFromStart" : { // Observation time from study start
      "description" : "<string>", // Human readable description
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start
      "range" : { Range }, // Used to express the observation within a period after the study start
      "note" : [{ Annotation }] // Used for footnotes or explanatory notes
    },
    "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  }],
  "handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
  "category" : [{ // A grouping for ordinal or polychotomous variables
    "name" : "<string>", // Description of the grouping
    // value[x]: Definition of the grouping. One of these 3:
    "valueCodeableConcept" : { CodeableConcept }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }
  }]
}

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.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.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  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.actual [ boolean ]; # 0..1 Actual or conceptual
  fhir:EvidenceVariable.characteristicCombination [ code ]; # 0..1 intersection | union
  fhir:EvidenceVariable.characteristic [ # 0..* 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 4
      fhir:EvidenceVariable.characteristic.definitionReference [ Reference(EvidenceVariable|Group) ]
      fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Any) ]
      fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]
    fhir:EvidenceVariable.characteristic.method [ CodeableConcept ]; # 0..1 Method used for describing characteristic
    fhir:EvidenceVariable.characteristic.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic
    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    fhir:EvidenceVariable.characteristic.timeFromStart [ # 0..1 Observation time from study start
      fhir:EvidenceVariable.characteristic.timeFromStart.description [ string ]; # 0..1 Human readable description
      fhir:EvidenceVariable.characteristic.timeFromStart.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start
      fhir:EvidenceVariable.characteristic.timeFromStart.range [ Range ]; # 0..1 Used to express the observation within a period after the study start
      fhir:EvidenceVariable.characteristic.timeFromStart.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
    ];
    fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
  fhir:EvidenceVariable.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping
    # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.category.valueQuantity [ Quantity ]
      fhir:EvidenceVariable.category.valueRange [ Range ]
  ], ...;
]

Changes since Release 4

EvidenceVariable
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristicCombination
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.definition[x]
  • Remove Types DataRequirement, TriggerDefinition
EvidenceVariable.characteristic.method
  • Added Element
EvidenceVariable.characteristic.device
  • Added Element
EvidenceVariable.characteristic.timeFromStart
  • Type changed from Duration to BackboneElement
EvidenceVariable.characteristic.timeFromStart.description
  • Added Element
EvidenceVariable.characteristic.timeFromStart.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromStart.range
  • Added Element
EvidenceVariable.characteristic.timeFromStart.note
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.copyright
  • deleted
EvidenceVariable.approvalDate
  • deleted
EvidenceVariable.lastReviewDate
  • deleted
EvidenceVariable.effectivePeriod
  • deleted
EvidenceVariable.topic
  • deleted
EvidenceVariable.type
  • deleted
EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.characteristic.participantEffective[x]
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Conversions between R3 and R4

 

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

PathDefinitionTypeReference
EvidenceVariable.status RequiredPublicationStatus
EvidenceVariable.characteristicCombination RequiredCharacteristicCombination
EvidenceVariable.characteristic.method ExampleCharacteristicMethod
EvidenceVariable.characteristic.groupMeasure RequiredGroupMeasure
EvidenceVariable.handling RequiredEvidenceVariableHandling

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

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

NameTypeDescriptionExpressionIn Common
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)
date NdateThe evidence variable publication dateEvidenceVariable.date
description NstringThe description of the evidence variableEvidenceVariable.description
identifiertokenExternal identifier for the evidence variableEvidenceVariable.identifier
name NstringComputationally friendly name of the evidence variableEvidenceVariable.name
publisher NstringName of the publisher of the evidence variableEvidenceVariable.publisher
status NtokenThe current status of the evidence variableEvidenceVariable.status
title NstringThe human-friendly name of the evidence variableEvidenceVariable.title
url NuriThe uri that identifies the evidence variableEvidenceVariable.url
version NtokenThe business version of the evidence variableEvidenceVariable.version