Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU see ballot notes ). 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 14.14 Resource EvidenceVariable - Content

Clinical Decision Support icon Work Group Maturity Level : 1   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

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

14.11.1 14.14.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 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.

Ballot question: The EvidenceVariable Resource has been modified to support expressions of complex eligibility criteria for implementer communities seeking alternatives to Group Resource for eligibility criteria for clinical trials. With these changes, the current EvidenceVariable Resource has greater flexibility than the Group Resource for Population specification. Please submit a ballot comment to note if you support a proposed change to the EvidenceVariable Scope and Usage to delete "As an exception, the Population specification will NOT use the EvidenceVariable Resource" and "The Population specification will use the Group Resource to facilitate interoperability in matching Evidence Resources to actual groups."

14.11.2 14.14.2 Boundaries and Relationships

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

14.11.3 14.14.3 References to this Resource

This resource is referenced by

14.11.4 14.14.4 Resource Content

Structure

Σ Name of the publisher (organization or individual) Used to express the observation within a period after Σ
Name Flags Card. Type Description & Constraints doco
. . EvidenceVariable TU DomainResource A 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
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . . identifier Σ 0..* Identifier Additional identifier for the evidence variable

. . . version Σ 0..1 string Business version of the evidence variable
. . name . versionAlgorithm[x] Σ I 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
.... versionAlgorithmString string
. . . . versionAlgorithmCoding Name for this evidence variable (computer friendly) Coding
. . . title name Σ C 0..1 string Name for this evidence variable (human (computer friendly)
. . . shortTitle title Σ 0..1 string Title Name for use in informal contexts this evidence variable (human friendly)
. . . subtitle shortTitle Σ 0..1 string Subordinate title of the EvidenceVariable Title for use in informal contexts
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . date experimental 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
. . . publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
. . description . contact Σ 0..1 0..* ContactDetail Contact details for the publisher

... description Σ 0..1 markdown Natural language description of the evidence variable
. . . note 0..* Annotation Used for footnotes or explanatory notes

. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . purpose 0..1 markdown Why this EvidenceVariable is defined
. . . publisher copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
. . contact . approvalDate Σ 0..1 date When the resource was approved by publisher
... lastReviewDate 0..* 0..1 ContactDetail date Contact details for When the resource was last reviewed by the publisher
. . . author effectivePeriod 0..* 0..1 ContactDetail Period Who authored When the content resource is expected to be used
. . . editor author 0..* ContactDetail Who edited authored the content

. . . reviewer editor 0..* ContactDetail Who reviewed edited the content

. . . endorser reviewer 0..* ContactDetail Who endorsed reviewed the content

. . . relatedArtifact endorser 0..* RelatedArtifact ContactDetail Additional documentation, citations, etc. Who endorsed the content

. . actual . relatedArtifact 0..1 0..* boolean RelatedArtifact Actual or conceptual Additional documentation, citations, etc

. . . characteristicCombination actual 0..1 code boolean intersection | union Actual or conceptual
CharacteristicCombination ( Required )
. . . characteristic Σ C 0..* BackboneElement What defines the members A defining factor of the evidence element EvidenceVariable
+ Rule: In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination

. . . . description linkId 0..1 id Label for internal linking
.... description 0..1 string markdown Natural language description of the characteristic
. . . definition[x] . note Σ 0..* Annotation Used for footnotes or explanatory notes

.... exclude 1..1 0..1 boolean What code Whether the characteristic is an inclusion criterion or expression defines members? exclusion criterion
. . . . definitionReference Σ C 0..1 Reference ( EvidenceVariable | Group | EvidenceVariable Evidence ) Defines the characteristic (without using type and value) by a Reference
. . . . definitionCanonical Σ C 0..1 canonical ( Any EvidenceVariable | Evidence ) Defines the characteristic (without using type and value) by a Canonical
. . . . definitionCodeableConcept Σ C 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept
. . . . definitionExpression Σ C 0..1 Expression Defines the characteristic (without using type and value) by an expression
+ Warning: When another element provides a definition of the characteristic, the definitionExpression content SHALL match the definition (only adding technical concepts necessary for implementation) without changing the meaning.
. . . method . definitionId Σ C 0..1 id Defines the characteristic (without using type and value) by an id
.... definitionByTypeAndValue Σ C 0..1 BackboneElement Defines the characteristic using type and value
..... type Σ 1..1 CodeableConcept Method used for describing Expresses the type of characteristic
CharacteristicMethod Binding: UsageContextType ( Example )
. . . . device . method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: Definition Method ( Example )

..... device 0..1 Reference ( Device | DeviceMetric ) Device used for determining characteristic
. . . . . value[x] Σ 1..1 Defines the characteristic when coupled with characteristic.type
.... . exclude . valueCodeableConcept CodeableConcept
. . . . . . valueBoolean boolean
. . . . . . valueQuantity Quantity
...... valueRange Range
...... valueReference Reference ()
...... valueId id
..... offset 0..1 boolean CodeableConcept Whether the characteristic includes Reference point for valueQuantity or excludes members valueRange
Binding: Characteristic Offset ( Example )
. . . . timeFromStart definitionByCombination C 0..1 BackboneElement Observation time from study start Used to specify how two or more characteristics are combined
. . . . . description code 0..1 1..1 string code Human readable description all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: Characteristic Combination ( Required )
. . . . quantity . threshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
..... characteristic 1..* see characteristic A defining factor of the characteristic

.... instances[x] 0..1 Number of occurrences meeting the characteristic
..... instancesQuantity Quantity
. . . . . instancesRange Used to express the observation at a defined amount Range
.... duration[x] 0..1 Length of time after in which the study start characteristic is met
. . . . range . durationQuantity Quantity
. . . . . durationRange 0..1 Range
. . . . timeFromEvent 0..* BackboneElement Timing in which the study start characteristic is determined

. . . . . description 0..1 markdown Human readable description
. . . . . note 0..* Annotation Used for footnotes or explanatory notes

. . . groupMeasure . . event[x] 0..1 code mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median The event used as a base point (reference point) in time
GroupMeasure Binding: Evidence Variable Event ( Required Example )
. . . . . . eventCodeableConcept CodeableConcept
...... eventReference Reference ()
.... . . handling eventDateTime dateTime
. . . . . . eventId id
..... quantity 0..1 Quantity Used to express the observation at a defined amount of time before or after the event
..... range 0..1 Range Used to express the observation within a period before and/or after the event
... handling 0..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling Evidence Variable Handling ( Required )
. . . category 0..* BackboneElement A grouping for ordinal or polychotomous variables

. . . . name 0..1 string Description of the grouping
. . . . value[x] 0..1 Definition of the grouping
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueQuantity Quantity
. . . . . valueRange Range

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

EvidenceVariable ( DomainResource ) + MetadataResource 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 servers url : 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 instance identifier : 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 artifacts version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » 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 generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the evidence variable title : string [0..1] The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary shortTitle : string [0..1] An explanatory or alternate title for the EvidenceVariable giving additional information about its content subtitle : 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] « null (Strength=Required) PublicationStatus ! » A Boolean value to indicate that this resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage experimental : boolean [0..1] The date (and optionally time) when the evidence variable was published. last significantly changed. 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 changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variable publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the evidence variable from a consumer's perspective description : markdown [0..1] A human-readable string to clarify or explain concepts about the resource note : 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 instances useContext : UsageContext [0..*] The name Explanation of why this EvidenceVariable is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the organization or individual resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resource copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that published identifies the evidence variable copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved') publisher copyrightLabel : string [0..1] Contact details The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : 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 date lastReviewDate : date [0..1] The period during which the resource content was or is planned to assist a user be in finding and communicating with the publisher active use contact effectivePeriod : ContactDetail Period [0..*] [0..1] An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] True if the actual variable measured, false if a conceptual representation of the intended variable actual : boolean [0..1] Used to specify if two or more characteristics are combined with OR or AND The method of handling in statistical analysis characteristicCombination handling : code [0..1] « null (Strength=Required) CharacteristicCombination EvidenceVariableHandling ! » Characteristic Used Label used for an outcome when a characteristic refers to classify another characteristic handling linkId : code id [0..1] « null (Strength=Required) EvidenceVariableHandling ! » Characteristic A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user description : markdown [0..1] A human-readable string to clarify or explain concepts about the characteristic note : Annotation [0..*] When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterion exclude : boolean [0..1] Define members of Defines the evidence element characteristic using Codes (such as condition, medication, a Reference definitionReference : Reference [0..1] « EvidenceVariable | Group | Evidence » « This element has or observation), Expressions ( is affected by some invariants C » Defines the characteristic using an expression language such as FHIRPath Canonical definitionCanonical : canonical [0..1] « EvidenceVariable | Evidence » « This element has or CQL) is affected by some invariants C » Defines the characteristic using CodeableConcept definitionCodeableConcept : CodeableConcept [0..1] « This element has or DataRequirements (such as Diabetes diagnosis onset in is affected by some invariants C » Defines the last year) characteristic using Expression definition[x] definitionExpression : Element Expression [1..1] [0..1] Defines the characteristic using id definitionId : id [0..1] « Reference This element has or is affected by some invariants C ( Group » Number of occurrences meeting the characteristic instances[x] : DataType [0..1] « Quantity | EvidenceVariable Range )| » canonical Length of time in which the characteristic is met duration[x] ( Any : DataType )| CodeableConcept [0..1] « Quantity | Expression Range » DefinitionByTypeAndValue Used to express the type of characteristic type : CodeableConcept [1..1] « null (Strength=Example) UsageContextType ?? » Method used for describing how the characteristic value was determined method : CodeableConcept [0..1] [0..*] « null (Strength=Example) CharacteristicMethod DefinitionMethod ?? » Device used for determining characteristic device : Reference [0..1] « Device | DeviceMetric » When true, members with this characteristic are excluded from Defines the element characteristic when paired with characteristic.type exclude value[x] : DataType [1..1] « CodeableConcept | boolean | Quantity | Range | Reference | id » Defines the reference point for comparison when valueQuantity or valueRange is not compared to zero offset : CodeableConcept [0..1] « null (Strength=Example) CharacteristicOffset ?? » DefinitionByCombination Indicates how elements Used to specify if two or more characteristics are aggregated within the study effective period combined with OR or AND groupMeasure code : code [0..1] [1..1] « null (Strength=Required) GroupMeasure CharacteristicCombination ! » Provides the value of "n" when "at-least" or "at-most" codes are used threshold : positiveInt [0..1] TimeFromStart TimeFromEvent A short, natural language Human readable description description : markdown [0..1] A human-readable string to clarify or explain concepts about the timeFromEvent note : Annotation [0..*] The event used as a base point (reference point) in time event[x] : DataType [0..1] « CodeableConcept | Reference | dateTime | id ; null (Strength=Example) EvidenceVariableEvent ?? » Used to express the observation at a defined amount of time before or after the study start event quantity : Quantity [0..1] Used to express the observation within a period before and/or after the study start event range : Range [0..1] A human-readable string to clarify or explain concepts about the resource note : Annotation [0..*] Category A human-readable title or representation Description of the grouping name : string [0..1] Value or set Definition of values that define the grouping value[x] : Element DataType [0..1] « CodeableConcept | Quantity | Range » Defines the characteristic using both a type and value[x] elements definitionByTypeAndValue [0..1] Indicates duration, period, or point A defining factor of observation from the participant's study entry characteristic timeFromStart characteristic [1..*] Defines the characteristic as a combination of two or more characteristics definitionByCombination [0..1] Timing in which the characteristic is determined timeFromEvent [0..*] A characteristic that defines the members defining factor of the evidence element. EvidenceVariable. Multiple characteristics are applied with "and" semantics characteristic [0..*] A grouping (or set of values) described along with other groupings to specify the set of groupings allowed for the variable ordinal or polychotomous variables category [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 -->
 <

 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 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 -->
 <

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <

 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (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>
 <
 <</contact>

 <purpose value="[markdown]"/><!-- 0..1 Why this EvidenceVariable is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the resource was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the resource was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the resource is expected to be used --></effectivePeriod>

 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <</reviewer>
 <</endorser>
 <</relatedArtifact>

 <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 -->
 <
 <
  <
  <)|
    </definition[x]>
  <</method>
  <</device>
  <
  <
   <
   <</quantity>
   <</range>
   <</note>
  </timeFromStart>
  <

 <characteristic>  <!-- 0..* A defining factor of the EvidenceVariable -->
  <linkId value="[id]"/><!-- 0..1 Label for internal linking -->
  <description value="[markdown]"/><!-- 0..1 Natural language description of the characteristic -->
  <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion -->
  <definitionReference><!-- I 0..1 Reference(Evidence|EvidenceVariable|Group) Defines the characteristic (without using type and value) by a Reference --></definitionReference>
  <definitionCanonical><!-- I 0..1 canonical(Evidence|EvidenceVariable) Defines the characteristic (without using type and value) by a Canonical --></definitionCanonical>
  <definitionCodeableConcept><!-- I 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept --></definitionCodeableConcept>
  <definitionExpression><!-- 0..1 Expression Defines the characteristic (without using type and value) by an expression --></definitionExpression>
  <definitionId value="[id]"/><!-- I 0..1 Defines the characteristic (without using type and value) by an id -->
  <definitionByTypeAndValue>  <!-- I 0..1 Defines the characteristic using type and value -->
   <type><!-- 1..1 CodeableConcept Expresses the type of characteristic --></type>
   <method><!-- 0..* CodeableConcept Method for how the characteristic value was determined --></method>
   <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>
   <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference|id Defines the characteristic when coupled with characteristic.type --></value[x]>
   <offset><!-- 0..1 CodeableConcept Reference point for valueQuantity or valueRange --></offset>
  </definitionByTypeAndValue>
  <definitionByCombination>  <!-- I 0..1 Used to specify how two or more characteristics are combined -->
   <code value="[code]"/><!-- 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset -->
   <threshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->
   <characteristic><!-- 1..* Content as for EvidenceVariable.characteristic A defining factor of the characteristic --></characteristic>
  </definitionByCombination>
  <instances[x]><!-- 0..1 Quantity|Range Number of occurrences meeting the characteristic --></instances[x]>
  <duration[x]><!-- 0..1 Quantity|Range Length of time in which the characteristic is met --></duration[x]>
  <timeFromEvent>  <!-- 0..* Timing in which the characteristic is determined -->
   <description value="[markdown]"/><!-- 0..1 Human readable description -->
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
   <event[x]><!-- 0..1 CodeableConcept|Reference|dateTime|id The event used as a base point (reference point) in time --></event[x]>
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time before or after the event --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period before and/or after the event --></range>
  </timeFromEvent>

 </characteristic>
 <
 <
  <
  <</value[x]>

 <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
  "

  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this evidence variable (computer friendly)

  "title" : "<string>", // Name for this evidence variable (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "

  "status" : "<code>", // R!  draft | active | retired | unknown
  "

  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (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
  "
  "

  "purpose" : "<markdown>", // Why this EvidenceVariable is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the resource was approved by publisher
  "lastReviewDate" : "<date>", // When the resource was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the resource is expected to be used

  "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
  "
  "
    "
    
    " },
    " },
    " },
    " },
    "
    "
    "
    "
      "
      "
      "
      "

  "characteristic" : [{ // A defining factor of the EvidenceVariable
    "linkId" : "<id>", // Label for internal linking
    "description" : "<markdown>", // Natural language description of the characteristic
    "note" : [{ Annotation }], // Used for footnotes or explanatory notes
    "exclude" : <boolean>, // Whether the characteristic is an inclusion criterion or exclusion criterion
    "definitionReference" : { Reference(Evidence|EvidenceVariable|Group) }, // I Defines the characteristic (without using type and value) by a Reference
    "definitionCanonical" : "<canonical(EvidenceVariable|Evidence)>", // I Defines the characteristic (without using type and value) by a Canonical
    "definitionCodeableConcept" : { CodeableConcept }, // I Defines the characteristic (without using type and value) by a CodeableConcept
    "definitionExpression" : { Expression }, // Defines the characteristic (without using type and value) by an expression
    "definitionId" : "<id>", // I Defines the characteristic (without using type and value) by an id
    "definitionByTypeAndValue" : { // I Defines the characteristic using type and value
      "type" : { CodeableConcept }, // R!  Expresses the type of characteristic
      "method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
      "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
      // value[x]: Defines the characteristic when coupled with characteristic.type. One of these 6:

      "valueCodeableConcept" : { CodeableConcept },
      "valueBoolean" : <boolean>,
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valueReference" : { Reference },
      "valueId" : "<id>",
      "offset" : { CodeableConcept } // Reference point for valueQuantity or valueRange

    },
    "

    "definitionByCombination" : { // I Used to specify how two or more characteristics are combined
      "code" : "<code>", // R!  all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      "threshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
      "characteristic" : [{ Content as for EvidenceVariable.characteristic }] // R!  A defining factor of the characteristic
    },
    // instances[x]: Number of occurrences meeting the characteristic. One of these 2:

    "instancesQuantity" : { Quantity },
    "instancesRange" : { Range },
    // duration[x]: Length of time in which the characteristic is met. One of these 2:

    "durationQuantity" : { Quantity },
    "durationRange" : { Range },
    "timeFromEvent" : [{ // Timing in which the characteristic is determined
      "description" : "<markdown>", // Human readable description
      "note" : [{ Annotation }], // Used for footnotes or explanatory notes
      // event[x]: The event used as a base point (reference point) in time. One of these 4:

      "eventCodeableConcept" : { CodeableConcept },
      "eventReference" : { Reference },
      "eventDateTime" : "<dateTime>",
      "eventId" : "<id>",
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time before or after the event
      "range" : { Range } // Used to express the observation within a period before and/or after the event
    }]

  }],
  "
  "
    "

  "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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    # . One of these 4
      fhir:) ]
      fhir:) ]
      fhir: ]
      fhir: ]
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ];
    fhir:
  ], ...;
  fhir:
  fhir:
    fhir:
    # . One of these 3
      fhir: ]
      fhir: ]
      fhir: ]
  ], ...;

  fhir:url [ uri ] ; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the evidence variable
  fhir:version [ string ] ; # 0..1 Business version of the evidence variable
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this evidence variable (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this evidence variable (human friendly)
  fhir:shortTitle [ string ] ; # 0..1 Title for use in informal contexts
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the evidence variable
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:purpose [ markdown ] ; # 0..1 Why this EvidenceVariable is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When the resource was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the resource was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the resource is expected to be used
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the content
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the content
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc
  fhir:actual [ boolean ] ; # 0..1 Actual or conceptual
  fhir:characteristic ( [ # 0..* A defining factor of the EvidenceVariable
    fhir:linkId [ id ] ; # 0..1 Label for internal linking
    fhir:description [ markdown ] ; # 0..1 Natural language description of the characteristic
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes
    fhir:exclude [ boolean ] ; # 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion
    fhir:definitionReference [ Reference(Evidence|EvidenceVariable|Group) ] ; # 0..1 I Defines the characteristic (without using type and value) by a Reference
    fhir:definitionCanonical [ canonical(Evidence|EvidenceVariable) ] ; # 0..1 I Defines the characteristic (without using type and value) by a Canonical
    fhir:definitionCodeableConcept [ CodeableConcept ] ; # 0..1 I Defines the characteristic (without using type and value) by a CodeableConcept
    fhir:definitionExpression [ Expression ] ; # 0..1 Defines the characteristic (without using type and value) by an expression
    fhir:definitionId [ id ] ; # 0..1 I Defines the characteristic (without using type and value) by an id
    fhir:definitionByTypeAndValue [ # 0..1 I Defines the characteristic using type and value
      fhir:type [ CodeableConcept ] ; # 1..1 Expresses the type of characteristic
      fhir:method  ( [ CodeableConcept ] ... ) ; # 0..* Method for how the characteristic value was determined
      fhir:device [ Reference(Device|DeviceMetric) ] ; # 0..1 Device used for determining characteristic
      # value[x] : 1..1 Defines the characteristic when coupled with characteristic.type. One of these 6
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:value [  a fhir:boolean ; boolean ]
        fhir:value [  a fhir:Quantity ; Quantity ]
        fhir:value [  a fhir:Range ; Range ]
        fhir:value [  a fhir:Reference ; Reference ]
        fhir:value [  a fhir:id ; id ]
      fhir:offset [ CodeableConcept ] ; # 0..1 Reference point for valueQuantity or valueRange
    ] ;
    fhir:definitionByCombination [ # 0..1 I Used to specify how two or more characteristics are combined
      fhir:code [ code ] ; # 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      fhir:threshold [ positiveInt ] ; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used
      fhir:characteristic  ( [ See EvidenceVariable.characteristic ] ... ) ; # 1..* A defining factor of the characteristic
    ] ;
    # instances[x] : 0..1 Number of occurrences meeting the characteristic. One of these 2
      fhir:instances [  a fhir:Quantity ; Quantity ]
      fhir:instances [  a fhir:Range ; Range ]
    # duration[x] : 0..1 Length of time in which the characteristic is met. One of these 2
      fhir:duration [  a fhir:Quantity ; Quantity ]
      fhir:duration [  a fhir:Range ; Range ]
    fhir:timeFromEvent ( [ # 0..* Timing in which the characteristic is determined
      fhir:description [ markdown ] ; # 0..1 Human readable description
      fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes
      # event[x] : 0..1 The event used as a base point (reference point) in time. One of these 4
        fhir:event [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:event [  a fhir:Reference ; Reference ]
        fhir:event [  a fhir:dateTime ; dateTime ]
        fhir:event [  a fhir:id ; id ]
      fhir:quantity [ Quantity ] ; # 0..1 Used to express the observation at a defined amount of time before or after the event
      fhir:range [ Range ] ; # 0..1 Used to express the observation within a period before and/or after the event
    ] ... ) ;
  ] ... ) ;
  fhir:handling [ code ] ; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:category ( [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:name [ string ] ; # 0..1 Description of the grouping
    # value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
  ] ... ) ;

]

Changes since R4

EvidenceVariable
EvidenceVariable.versionAlgorithm[x]
  • Added Element
EvidenceVariable.actual EvidenceVariable.experimental
  • Added Element
EvidenceVariable.characteristicCombination EvidenceVariable.purpose
  • Added Element
EvidenceVariable.copyrightLabel
  • Added Element
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.linkId
  • Added Element
EvidenceVariable.characteristic.definition[x] EvidenceVariable.characteristic.description
  • Remove Types DataRequirement, TriggerDefinition Type changed from string to markdown
EvidenceVariable.characteristic.method EvidenceVariable.characteristic.note
  • Added Element
EvidenceVariable.characteristic.device EvidenceVariable.characteristic.definitionReference
  • Added Element
EvidenceVariable.characteristic.timeFromStart EvidenceVariable.characteristic.definitionCanonical
  • Type changed from Duration to BackboneElement Added Element
EvidenceVariable.characteristic.timeFromStart.description EvidenceVariable.characteristic.definitionCodeableConcept
  • Added Element
EvidenceVariable.characteristic.timeFromStart.quantity EvidenceVariable.characteristic.definitionExpression
  • Added Element
EvidenceVariable.characteristic.timeFromStart.range EvidenceVariable.characteristic.definitionId
  • Added Element
EvidenceVariable.characteristic.timeFromStart.note EvidenceVariable.characteristic.definitionByTypeAndValue
  • Added Element
EvidenceVariable.characteristic.definitionByTypeAndValue.type
  • Added Mandatory Element
EvidenceVariable.characteristic.definitionByTypeAndValue.method
  • Added Element
EvidenceVariable.characteristic.definitionByTypeAndValue.device
  • Added Element
EvidenceVariable.characteristic.definitionByTypeAndValue.value[x]
  • Added Mandatory Element
EvidenceVariable.characteristic.definitionByTypeAndValue.offset
  • Added Element
EvidenceVariable.characteristic.definitionByCombination
  • Added Element
EvidenceVariable.characteristic.definitionByCombination.code
  • Added Mandatory Element
EvidenceVariable.characteristic.definitionByCombination.threshold
  • Added Element
EvidenceVariable.characteristic.definitionByCombination.characteristic
  • Added Mandatory Element
EvidenceVariable.characteristic.instances[x]
  • Added Element
EvidenceVariable.characteristic.duration[x]
  • Added Element
EvidenceVariable.characteristic.timeFromEvent
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.description
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.note
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.event[x]
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.range
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction EvidenceVariable.subtitle
  • deleted
EvidenceVariable.copyright EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.approvalDate EvidenceVariable.topic
  • deleted
EvidenceVariable.lastReviewDate EvidenceVariable.type
  • deleted
EvidenceVariable.effectivePeriod EvidenceVariable.characteristic.definition[x]
  • deleted
EvidenceVariable.topic EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.type EvidenceVariable.characteristic.participantEffective[x]
  • deleted
EvidenceVariable.characteristic.usageContext EvidenceVariable.characteristic.timeFromStart
  • deleted
EvidenceVariable.characteristic.participantEffective[x] EvidenceVariable.characteristic.groupMeasure
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

Structure

Σ Name of the publisher (organization or individual) Used to express the observation within a period after Σ
Name Flags Card. Type Description & Constraints doco
. . EvidenceVariable TU DomainResource A 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
Interfaces Implemented: MetadataResource
. . . url Σ C 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . . identifier Σ 0..* Identifier Additional identifier for the evidence variable

. . . version Σ 0..1 string Business version of the evidence variable
. . name . versionAlgorithm[x] Σ I 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
.... versionAlgorithmString string
. . . . versionAlgorithmCoding Name for this evidence variable (computer friendly) Coding
. . . title name Σ C 0..1 string Name for this evidence variable (human (computer friendly)
. . . shortTitle title Σ 0..1 string Title Name for use in informal contexts this evidence variable (human friendly)
. . . subtitle shortTitle Σ 0..1 string Subordinate title of the EvidenceVariable Title for use in informal contexts
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . date experimental 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
. . . publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
. . description . contact Σ 0..1 0..* ContactDetail Contact details for the publisher

... description Σ 0..1 markdown Natural language description of the evidence variable
. . . note 0..* Annotation Used for footnotes or explanatory notes

. . . useContext Σ 0..* UsageContext The context that the content is intended to support

. . . purpose 0..1 markdown Why this EvidenceVariable is defined
. . . publisher copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T 0..1 string Copyright holder and year(s)
. . contact . approvalDate Σ 0..1 date When the resource was approved by publisher
... lastReviewDate 0..* 0..1 ContactDetail date Contact details for When the resource was last reviewed by the publisher
. . . author effectivePeriod 0..* 0..1 ContactDetail Period Who authored When the content resource is expected to be used
. . . editor author 0..* ContactDetail Who edited authored the content

. . . reviewer editor 0..* ContactDetail Who reviewed edited the content

. . . endorser reviewer 0..* ContactDetail Who endorsed reviewed the content

. . . relatedArtifact endorser 0..* RelatedArtifact ContactDetail Additional documentation, citations, etc. Who endorsed the content

. . actual . relatedArtifact 0..1 0..* boolean RelatedArtifact Actual or conceptual Additional documentation, citations, etc

. . . characteristicCombination actual 0..1 code boolean intersection | union Actual or conceptual
CharacteristicCombination ( Required )
. . . characteristic Σ C 0..* BackboneElement What defines the members A defining factor of the evidence element EvidenceVariable
+ Rule: In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination

. . . . description linkId 0..1 id Label for internal linking
.... description 0..1 string markdown Natural language description of the characteristic
. . . definition[x] . note Σ 0..* Annotation Used for footnotes or explanatory notes

.... exclude 1..1 0..1 boolean What code Whether the characteristic is an inclusion criterion or expression defines members? exclusion criterion
. . . . definitionReference Σ C 0..1 Reference ( EvidenceVariable | Group | EvidenceVariable Evidence ) Defines the characteristic (without using type and value) by a Reference
. . . . definitionCanonical Σ C 0..1 canonical ( Any EvidenceVariable | Evidence ) Defines the characteristic (without using type and value) by a Canonical
. . . . definitionCodeableConcept Σ C 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept
. . . . definitionExpression Σ C 0..1 Expression Defines the characteristic (without using type and value) by an expression
+ Warning: When another element provides a definition of the characteristic, the definitionExpression content SHALL match the definition (only adding technical concepts necessary for implementation) without changing the meaning.
. . . method . definitionId Σ C 0..1 id Defines the characteristic (without using type and value) by an id
.... definitionByTypeAndValue Σ C 0..1 BackboneElement Defines the characteristic using type and value
..... type Σ 1..1 CodeableConcept Method used for describing Expresses the type of characteristic
CharacteristicMethod Binding: UsageContextType ( Example )
. . . . device . method 0..* CodeableConcept Method for how the characteristic value was determined
Binding: Definition Method ( Example )

..... device 0..1 Reference ( Device | DeviceMetric ) Device used for determining characteristic
. . . . . value[x] Σ 1..1 Defines the characteristic when coupled with characteristic.type
. . . . . exclude . valueCodeableConcept CodeableConcept
. . . . . . valueBoolean boolean
. . . . . . valueQuantity Quantity
...... valueRange Range
...... valueReference Reference ()
...... valueId id
..... offset 0..1 boolean CodeableConcept Whether the characteristic includes Reference point for valueQuantity or excludes members valueRange
Binding: Characteristic Offset ( Example )
. . . . timeFromStart definitionByCombination C 0..1 BackboneElement Observation time from study start Used to specify how two or more characteristics are combined
. . . . . description code 0..1 1..1 string code Human readable description all-of | any-of | at-least | at-most | statistical | net-effect | dataset
Binding: Characteristic Combination ( Required )
. . . . quantity . threshold 0..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used
..... characteristic 1..* see characteristic A defining factor of the characteristic

.... instances[x] 0..1 Number of occurrences meeting the characteristic
..... instancesQuantity Quantity
. . . . . instancesRange Used to express the observation at a defined amount Range
.... duration[x] 0..1 Length of time after in which the study start characteristic is met
. . . . range . durationQuantity Quantity
. . . . . durationRange 0..1 Range
. . . . timeFromEvent 0..* BackboneElement Timing in which the study start characteristic is determined

. . . . . description 0..1 markdown Human readable description
. . . . . note 0..* Annotation Used for footnotes or explanatory notes

. . . groupMeasure . . event[x] 0..1 code mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median The event used as a base point (reference point) in time
GroupMeasure Binding: Evidence Variable Event ( Required Example )
. . . . . . eventCodeableConcept CodeableConcept
...... eventReference Reference ()
.... . . handling eventDateTime dateTime
. . . . . . eventId id
..... quantity 0..1 Quantity Used to express the observation at a defined amount of time before or after the event
..... range 0..1 Range Used to express the observation within a period before and/or after the event
... handling 0..1 code continuous | dichotomous | ordinal | polychotomous
Binding: EvidenceVariableHandling Evidence Variable Handling ( Required )
. . . category 0..* BackboneElement A grouping for ordinal or polychotomous variables

. . . . name 0..1 string Description of the grouping
. . . . value[x] 0..1 Definition of the grouping
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueQuantity Quantity
. . . . . valueRange Range

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

EvidenceVariable ( DomainResource ) + MetadataResource 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 servers url : 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 instance identifier : 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 artifacts version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » 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 generation name : string [0..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the evidence variable title : string [0..1] The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary shortTitle : string [0..1] An explanatory or alternate title for the EvidenceVariable giving additional information about its content subtitle : 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] « null (Strength=Required) PublicationStatus ! » A Boolean value to indicate that this resource is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage experimental : boolean [0..1] The date (and optionally time) when the evidence variable was published. last significantly changed. 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 changes date : dateTime [0..1] The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variable publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the evidence variable from a consumer's perspective description : markdown [0..1] A human-readable string to clarify or explain concepts about the resource note : 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 instances useContext : UsageContext [0..*] The name Explanation of why this EvidenceVariable is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the organization or individual resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resource copyright : markdown [0..1] A short string (<50 characters), suitable for inclusion in a page footer that published identifies the evidence variable copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved') publisher copyrightLabel : string [0..1] Contact details The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : 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 date lastReviewDate : date [0..1] The period during which the resource content was or is planned to assist a user be in finding and communicating with the publisher active use contact effectivePeriod : ContactDetail Period [0..*] [0..1] An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization asserted by the publisher to be responsible for officially endorsing the content for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] True if the actual variable measured, false if a conceptual representation of the intended variable actual : boolean [0..1] Used to specify if two or more characteristics are combined with OR or AND The method of handling in statistical analysis characteristicCombination handling : code [0..1] « null (Strength=Required) CharacteristicCombination EvidenceVariableHandling ! » Characteristic Used Label used for an outcome when a characteristic refers to classify another characteristic handling linkId : code id [0..1] « null (Strength=Required) EvidenceVariableHandling ! » Characteristic A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user description : markdown [0..1] A human-readable string to clarify or explain concepts about the characteristic note : Annotation [0..*] When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterion exclude : boolean [0..1] Define members of Defines the evidence element characteristic using Codes (such as condition, medication, a Reference definitionReference : Reference [0..1] « EvidenceVariable | Group | Evidence » « This element has or observation), Expressions ( is affected by some invariants C » Defines the characteristic using an expression language such as FHIRPath Canonical definitionCanonical : canonical [0..1] « EvidenceVariable | Evidence » « This element has or CQL) is affected by some invariants C » Defines the characteristic using CodeableConcept definitionCodeableConcept : CodeableConcept [0..1] « This element has or DataRequirements (such as Diabetes diagnosis onset in is affected by some invariants C » Defines the last year) characteristic using Expression definition[x] definitionExpression : Element Expression [1..1] [0..1] Defines the characteristic using id definitionId : id [0..1] « Reference This element has or is affected by some invariants C ( Group » Number of occurrences meeting the characteristic instances[x] : DataType [0..1] « Quantity | EvidenceVariable Range )| » canonical Length of time in which the characteristic is met duration[x] ( Any : DataType )| CodeableConcept [0..1] « Quantity | Expression Range » DefinitionByTypeAndValue Used to express the type of characteristic type : CodeableConcept [1..1] « null (Strength=Example) UsageContextType ?? » Method used for describing how the characteristic value was determined method : CodeableConcept [0..1] [0..*] « null (Strength=Example) CharacteristicMethod DefinitionMethod ?? » Device used for determining characteristic device : Reference [0..1] « Device | DeviceMetric » When true, members with this characteristic are excluded from Defines the element characteristic when paired with characteristic.type exclude value[x] : DataType [1..1] « CodeableConcept | boolean | Quantity | Range | Reference | id » Defines the reference point for comparison when valueQuantity or valueRange is not compared to zero offset : CodeableConcept [0..1] « null (Strength=Example) CharacteristicOffset ?? » DefinitionByCombination Indicates how elements Used to specify if two or more characteristics are aggregated within the study effective period combined with OR or AND groupMeasure code : code [0..1] [1..1] « null (Strength=Required) GroupMeasure CharacteristicCombination ! » Provides the value of "n" when "at-least" or "at-most" codes are used threshold : positiveInt [0..1] TimeFromStart TimeFromEvent A short, natural language Human readable description description : markdown [0..1] A human-readable string to clarify or explain concepts about the timeFromEvent note : Annotation [0..*] The event used as a base point (reference point) in time event[x] : DataType [0..1] « CodeableConcept | Reference | dateTime | id ; null (Strength=Example) EvidenceVariableEvent ?? » Used to express the observation at a defined amount of time before or after the study start event quantity : Quantity [0..1] Used to express the observation within a period before and/or after the study start event range : Range [0..1] A human-readable string to clarify or explain concepts about the resource note : Annotation [0..*] Category A human-readable title or representation Description of the grouping name : string [0..1] Value or set Definition of values that define the grouping value[x] : Element DataType [0..1] « CodeableConcept | Quantity | Range » Defines the characteristic using both a type and value[x] elements definitionByTypeAndValue [0..1] Indicates duration, period, or point A defining factor of observation from the participant's study entry characteristic timeFromStart characteristic [1..*] Defines the characteristic as a combination of two or more characteristics definitionByCombination [0..1] Timing in which the characteristic is determined timeFromEvent [0..*] A characteristic that defines the members defining factor of the evidence element. EvidenceVariable. Multiple characteristics are applied with "and" semantics characteristic [0..*] A grouping (or set of values) described along with other groupings to specify the set of groupings allowed for the variable ordinal or polychotomous variables category [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 -->
 <

 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 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 -->
 <

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <

 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (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>
 <
 <</contact>

 <purpose value="[markdown]"/><!-- 0..1 Why this EvidenceVariable is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <approvalDate value="[date]"/><!-- 0..1 When the resource was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the resource was last reviewed by the publisher -->
 <effectivePeriod><!-- 0..1 Period When the resource is expected to be used --></effectivePeriod>

 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <</reviewer>
 <</endorser>
 <</relatedArtifact>

 <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 -->
 <
 <
  <
  <)|
    </definition[x]>
  <</method>
  <</device>
  <
  <
   <
   <</quantity>
   <</range>
   <</note>
  </timeFromStart>
  <

 <characteristic>  <!-- 0..* A defining factor of the EvidenceVariable -->
  <linkId value="[id]"/><!-- 0..1 Label for internal linking -->
  <description value="[markdown]"/><!-- 0..1 Natural language description of the characteristic -->
  <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion -->
  <definitionReference><!-- I 0..1 Reference(Evidence|EvidenceVariable|Group) Defines the characteristic (without using type and value) by a Reference --></definitionReference>
  <definitionCanonical><!-- I 0..1 canonical(Evidence|EvidenceVariable) Defines the characteristic (without using type and value) by a Canonical --></definitionCanonical>
  <definitionCodeableConcept><!-- I 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept --></definitionCodeableConcept>
  <definitionExpression><!-- 0..1 Expression Defines the characteristic (without using type and value) by an expression --></definitionExpression>
  <definitionId value="[id]"/><!-- I 0..1 Defines the characteristic (without using type and value) by an id -->
  <definitionByTypeAndValue>  <!-- I 0..1 Defines the characteristic using type and value -->
   <type><!-- 1..1 CodeableConcept Expresses the type of characteristic --></type>
   <method><!-- 0..* CodeableConcept Method for how the characteristic value was determined --></method>
   <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>
   <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference|id Defines the characteristic when coupled with characteristic.type --></value[x]>
   <offset><!-- 0..1 CodeableConcept Reference point for valueQuantity or valueRange --></offset>
  </definitionByTypeAndValue>
  <definitionByCombination>  <!-- I 0..1 Used to specify how two or more characteristics are combined -->
   <code value="[code]"/><!-- 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset -->
   <threshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->
   <characteristic><!-- 1..* Content as for EvidenceVariable.characteristic A defining factor of the characteristic --></characteristic>
  </definitionByCombination>
  <instances[x]><!-- 0..1 Quantity|Range Number of occurrences meeting the characteristic --></instances[x]>
  <duration[x]><!-- 0..1 Quantity|Range Length of time in which the characteristic is met --></duration[x]>
  <timeFromEvent>  <!-- 0..* Timing in which the characteristic is determined -->
   <description value="[markdown]"/><!-- 0..1 Human readable description -->
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
   <event[x]><!-- 0..1 CodeableConcept|Reference|dateTime|id The event used as a base point (reference point) in time --></event[x]>
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time before or after the event --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period before and/or after the event --></range>
  </timeFromEvent>

 </characteristic>
 <
 <
  <
  <</value[x]>

 <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
  "

  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this evidence variable (computer friendly)

  "title" : "<string>", // Name for this evidence variable (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "

  "status" : "<code>", // R!  draft | active | retired | unknown
  "

  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (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
  "
  "

  "purpose" : "<markdown>", // Why this EvidenceVariable is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "approvalDate" : "<date>", // When the resource was approved by publisher
  "lastReviewDate" : "<date>", // When the resource was last reviewed by the publisher
  "effectivePeriod" : { Period }, // When the resource is expected to be used

  "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
  "
  "
    "
    
    " },
    " },
    " },
    " },
    "
    "
    "
    "
      "
      "
      "
      "

  "characteristic" : [{ // A defining factor of the EvidenceVariable
    "linkId" : "<id>", // Label for internal linking
    "description" : "<markdown>", // Natural language description of the characteristic
    "note" : [{ Annotation }], // Used for footnotes or explanatory notes
    "exclude" : <boolean>, // Whether the characteristic is an inclusion criterion or exclusion criterion
    "definitionReference" : { Reference(Evidence|EvidenceVariable|Group) }, // I Defines the characteristic (without using type and value) by a Reference
    "definitionCanonical" : "<canonical(EvidenceVariable|Evidence)>", // I Defines the characteristic (without using type and value) by a Canonical
    "definitionCodeableConcept" : { CodeableConcept }, // I Defines the characteristic (without using type and value) by a CodeableConcept
    "definitionExpression" : { Expression }, // Defines the characteristic (without using type and value) by an expression
    "definitionId" : "<id>", // I Defines the characteristic (without using type and value) by an id
    "definitionByTypeAndValue" : { // I Defines the characteristic using type and value
      "type" : { CodeableConcept }, // R!  Expresses the type of characteristic
      "method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
      "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
      // value[x]: Defines the characteristic when coupled with characteristic.type. One of these 6:

      "valueCodeableConcept" : { CodeableConcept },
      "valueBoolean" : <boolean>,
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valueReference" : { Reference },
      "valueId" : "<id>",
      "offset" : { CodeableConcept } // Reference point for valueQuantity or valueRange

    },
    "

    "definitionByCombination" : { // I Used to specify how two or more characteristics are combined
      "code" : "<code>", // R!  all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      "threshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
      "characteristic" : [{ Content as for EvidenceVariable.characteristic }] // R!  A defining factor of the characteristic
    },
    // instances[x]: Number of occurrences meeting the characteristic. One of these 2:

    "instancesQuantity" : { Quantity },
    "instancesRange" : { Range },
    // duration[x]: Length of time in which the characteristic is met. One of these 2:

    "durationQuantity" : { Quantity },
    "durationRange" : { Range },
    "timeFromEvent" : [{ // Timing in which the characteristic is determined
      "description" : "<markdown>", // Human readable description
      "note" : [{ Annotation }], // Used for footnotes or explanatory notes
      // event[x]: The event used as a base point (reference point) in time. One of these 4:

      "eventCodeableConcept" : { CodeableConcept },
      "eventReference" : { Reference },
      "eventDateTime" : "<dateTime>",
      "eventId" : "<id>",
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time before or after the event
      "range" : { Range } // Used to express the observation within a period before and/or after the event
    }]

  }],
  "
  "
    "

  "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:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    # . One of these 4
      fhir:) ]
      fhir:) ]
      fhir: ]
      fhir: ]
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
    ];
    fhir:
  ], ...;
  fhir:
  fhir:
    fhir:
    # . One of these 3
      fhir: ]
      fhir: ]
      fhir: ]
  ], ...;

  fhir:url [ uri ] ; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the evidence variable
  fhir:version [ string ] ; # 0..1 Business version of the evidence variable
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this evidence variable (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this evidence variable (human friendly)
  fhir:shortTitle [ string ] ; # 0..1 Title for use in informal contexts
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the evidence variable
  fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:purpose [ markdown ] ; # 0..1 Why this EvidenceVariable is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:approvalDate [ date ] ; # 0..1 When the resource was approved by publisher
  fhir:lastReviewDate [ date ] ; # 0..1 When the resource was last reviewed by the publisher
  fhir:effectivePeriod [ Period ] ; # 0..1 When the resource is expected to be used
  fhir:author  ( [ ContactDetail ] ... ) ; # 0..* Who authored the content
  fhir:editor  ( [ ContactDetail ] ... ) ; # 0..* Who edited the content
  fhir:reviewer  ( [ ContactDetail ] ... ) ; # 0..* Who reviewed the content
  fhir:endorser  ( [ ContactDetail ] ... ) ; # 0..* Who endorsed the content
  fhir:relatedArtifact  ( [ RelatedArtifact ] ... ) ; # 0..* Additional documentation, citations, etc
  fhir:actual [ boolean ] ; # 0..1 Actual or conceptual
  fhir:characteristic ( [ # 0..* A defining factor of the EvidenceVariable
    fhir:linkId [ id ] ; # 0..1 Label for internal linking
    fhir:description [ markdown ] ; # 0..1 Natural language description of the characteristic
    fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes
    fhir:exclude [ boolean ] ; # 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion
    fhir:definitionReference [ Reference(Evidence|EvidenceVariable|Group) ] ; # 0..1 I Defines the characteristic (without using type and value) by a Reference
    fhir:definitionCanonical [ canonical(Evidence|EvidenceVariable) ] ; # 0..1 I Defines the characteristic (without using type and value) by a Canonical
    fhir:definitionCodeableConcept [ CodeableConcept ] ; # 0..1 I Defines the characteristic (without using type and value) by a CodeableConcept
    fhir:definitionExpression [ Expression ] ; # 0..1 Defines the characteristic (without using type and value) by an expression
    fhir:definitionId [ id ] ; # 0..1 I Defines the characteristic (without using type and value) by an id
    fhir:definitionByTypeAndValue [ # 0..1 I Defines the characteristic using type and value
      fhir:type [ CodeableConcept ] ; # 1..1 Expresses the type of characteristic
      fhir:method  ( [ CodeableConcept ] ... ) ; # 0..* Method for how the characteristic value was determined
      fhir:device [ Reference(Device|DeviceMetric) ] ; # 0..1 Device used for determining characteristic
      # value[x] : 1..1 Defines the characteristic when coupled with characteristic.type. One of these 6
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:value [  a fhir:boolean ; boolean ]
        fhir:value [  a fhir:Quantity ; Quantity ]
        fhir:value [  a fhir:Range ; Range ]
        fhir:value [  a fhir:Reference ; Reference ]
        fhir:value [  a fhir:id ; id ]
      fhir:offset [ CodeableConcept ] ; # 0..1 Reference point for valueQuantity or valueRange
    ] ;
    fhir:definitionByCombination [ # 0..1 I Used to specify how two or more characteristics are combined
      fhir:code [ code ] ; # 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      fhir:threshold [ positiveInt ] ; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used
      fhir:characteristic  ( [ See EvidenceVariable.characteristic ] ... ) ; # 1..* A defining factor of the characteristic
    ] ;
    # instances[x] : 0..1 Number of occurrences meeting the characteristic. One of these 2
      fhir:instances [  a fhir:Quantity ; Quantity ]
      fhir:instances [  a fhir:Range ; Range ]
    # duration[x] : 0..1 Length of time in which the characteristic is met. One of these 2
      fhir:duration [  a fhir:Quantity ; Quantity ]
      fhir:duration [  a fhir:Range ; Range ]
    fhir:timeFromEvent ( [ # 0..* Timing in which the characteristic is determined
      fhir:description [ markdown ] ; # 0..1 Human readable description
      fhir:note  ( [ Annotation ] ... ) ; # 0..* Used for footnotes or explanatory notes
      # event[x] : 0..1 The event used as a base point (reference point) in time. One of these 4
        fhir:event [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:event [  a fhir:Reference ; Reference ]
        fhir:event [  a fhir:dateTime ; dateTime ]
        fhir:event [  a fhir:id ; id ]
      fhir:quantity [ Quantity ] ; # 0..1 Used to express the observation at a defined amount of time before or after the event
      fhir:range [ Range ] ; # 0..1 Used to express the observation within a period before and/or after the event
    ] ... ) ;
  ] ... ) ;
  fhir:handling [ code ] ; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:category ( [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:name [ string ] ; # 0..1 Description of the grouping
    # value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
  ] ... ) ;

]

Changes since Release 4

EvidenceVariable
EvidenceVariable.versionAlgorithm[x]
  • Added Element
EvidenceVariable.actual EvidenceVariable.experimental
  • Added Element
EvidenceVariable.characteristicCombination EvidenceVariable.purpose
  • Added Element
EvidenceVariable.copyrightLabel
  • Added Element
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.linkId
  • Added Element
EvidenceVariable.characteristic.definition[x] EvidenceVariable.characteristic.description
  • Remove Types DataRequirement, TriggerDefinition Type changed from string to markdown
EvidenceVariable.characteristic.method EvidenceVariable.characteristic.note
  • Added Element
EvidenceVariable.characteristic.device EvidenceVariable.characteristic.definitionReference
  • Added Element
EvidenceVariable.characteristic.timeFromStart EvidenceVariable.characteristic.definitionCanonical
  • Type changed from Duration to BackboneElement Added Element
EvidenceVariable.characteristic.timeFromStart.description EvidenceVariable.characteristic.definitionCodeableConcept
  • Added Element
EvidenceVariable.characteristic.timeFromStart.quantity EvidenceVariable.characteristic.definitionExpression
  • Added Element
EvidenceVariable.characteristic.timeFromStart.range EvidenceVariable.characteristic.definitionId
  • Added Element
EvidenceVariable.characteristic.timeFromStart.note EvidenceVariable.characteristic.definitionByTypeAndValue
  • Added Element
EvidenceVariable.characteristic.definitionByTypeAndValue.type
  • Added Mandatory Element
EvidenceVariable.characteristic.definitionByTypeAndValue.method
  • Added Element
EvidenceVariable.characteristic.definitionByTypeAndValue.device
  • Added Element
EvidenceVariable.characteristic.definitionByTypeAndValue.value[x]
  • Added Mandatory Element
EvidenceVariable.characteristic.definitionByTypeAndValue.offset
  • Added Element
EvidenceVariable.characteristic.definitionByCombination
  • Added Element
EvidenceVariable.characteristic.definitionByCombination.code
  • Added Mandatory Element
EvidenceVariable.characteristic.definitionByCombination.threshold
  • Added Element
EvidenceVariable.characteristic.definitionByCombination.characteristic
  • Added Mandatory Element
EvidenceVariable.characteristic.instances[x]
  • Added Element
EvidenceVariable.characteristic.duration[x]
  • Added Element
EvidenceVariable.characteristic.timeFromEvent
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.description
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.note
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.event[x]
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.range
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction EvidenceVariable.subtitle
  • deleted
EvidenceVariable.copyright EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.approvalDate EvidenceVariable.topic
  • deleted
EvidenceVariable.lastReviewDate EvidenceVariable.type
  • deleted
EvidenceVariable.effectivePeriod EvidenceVariable.characteristic.definition[x]
  • deleted
EvidenceVariable.topic EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.type EvidenceVariable.characteristic.participantEffective[x]
  • deleted
EvidenceVariable.characteristic.usageContext EvidenceVariable.characteristic.timeFromStart
  • deleted
EvidenceVariable.characteristic.participantEffective[x] EvidenceVariable.characteristic.groupMeasure
  • 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 Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis

14.11.4.1 14.14.4.1 Terminology Bindings

EvidenceVariable.characteristicCombination EvidenceVariable.characteristic.method EvidenceVariable.characteristic.groupMeasure
Path Definition ValueSet Type Reference Documentation
EvidenceVariable.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.

EvidenceVariable.status PublicationStatus Required PublicationStatus

The lifecycle status of an artifact.

EvidenceVariable.characteristic.definitionByTypeAndValue.type UsageContextType Required Example CharacteristicCombination

A code that specifies a type of context being specified by a usage context.

EvidenceVariable.characteristic.definitionByTypeAndValue.method DefinitionMethod Example CharacteristicMethod

The method used to define, describe, or determine a characteristic value.

EvidenceVariable.characteristic.definitionByTypeAndValue.offset CharacteristicOffset Example

Reference point for characteristic.valueQuantity.

EvidenceVariable.characteristic.definitionByCombination.code CharacteristicCombination Required GroupMeasure

Logical grouping of characteristics.

EvidenceVariable.characteristic.timeFromEvent.event[x] EvidenceVariableEvent Example

The event used as a base point (reference point) in time.

EvidenceVariable.handling EvidenceVariableHandling Required EvidenceVariableHandling

The handling of the variable in statistical analysis for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive).

14.11.4.2 14.14.4.2 Constraints

id UniqueKey Level Location Description Expression
cnl-0 img  cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}') name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img  cnl-1 Warning EvidenceVariable.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
img  evv-1 Rule EvidenceVariable.characteristic In a characteristic, at most one of these six elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionId or definitionByTypeAndValue or definitionByCombination (definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count()) < 2
img  evv-2 Warning EvidenceVariable.characteristic.definitionExpression When another element provides a definition of the characteristic, the definitionExpression content SHALL match the definition (only adding technical concepts necessary for implementation) without changing the meaning.

14.11.5 14.14.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
composed-of reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='composed-of').resource
(Any) 		6 Resources
context token A use context assigned to the evidence variable (EvidenceVariable.useContext.value as CodeableConcept) (EvidenceVariable.useContext.value.ofType(CodeableConcept)) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the evidence variable (EvidenceVariable.useContext.value as Quantity) (EvidenceVariable.useContext.value.ofType(Quantity)) | (EvidenceVariable.useContext.value as Range) (EvidenceVariable.useContext.value.ofType(Range)) 30 Resources
context-type token A type of use context assigned to the evidence variable EvidenceVariable.useContext.code 30 Resources
context-type-quantity composite A use context type and quantity- or range-based value assigned to the evidence variable On EvidenceVariable.useContext:
  context-type: code
  context-quantity: value.as(Quantity) value.ofType(Quantity) | value.as(Range) value.ofType(Range) 		30 Resources
context-type-value composite A use context type and value assigned to the evidence variable On EvidenceVariable.useContext:
  context-type: code
  context: value.as(CodeableConcept) value.ofType(CodeableConcept) 		30 Resources
date N date The evidence variable publication date EvidenceVariable.date 30 Resources
depends-on reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='depends-on').resource
(Any) 		6 Resources
derived-from reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='derived-from').resource
(Any) 		10 Resources
description N string The description of the evidence variable EvidenceVariable.description 28 Resources
identifier token External identifier for the evidence variable EvidenceVariable.identifier 33 Resources
name N string Computationally friendly name of the evidence variable EvidenceVariable.name 26 Resources
predecessor reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='predecessor').resource
(Any) 		10 Resources
publisher N string Name of the publisher of the evidence variable EvidenceVariable.publisher 30 Resources
status N token The current status of the evidence variable EvidenceVariable.status 34 Resources
successor reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='successor').resource
(Any) 		6 Resources
title N string The human-friendly name of the evidence variable EvidenceVariable.title 27 Resources
topic token Topics associated with the EvidenceVariable 10 Resources
url N uri The uri that identifies the evidence variable EvidenceVariable.url 33 Resources
version N token The business version of the evidence variable EvidenceVariable.version 30 Resources