Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

14.14 Resource EvidenceVariable - Content

Clinical Decision Support icon Work Group Maturity Level : 1   Trial Use Security Category : Business Compartments : No defined compartments

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

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

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

Evidence may be reported for different types of knowledge. One commonly used format for expression of what evidence is about is the "PICO" format. PICO stands for:

Population - the population within which exposures and outcomes are being considered

Intervention - the conditional state or exposure state being described for which one is expressing the risk of or effect on an outcome

Comparison - the alternative conditional state or alternative exposure state when one is comparing states for the effect on an outcome

Outcome - the result or effect of an intervention or exposure in a population

PICO (and its variants like PECO or PICOT) is a universal acronym used in evidence-based medicine communities to clearly express research questions and evidence findings.

The EvidenceVariable Resource allows expression of the components of a PICO question in codeable and reusable formats. As an exception, the Population specification will NOT use the EvidenceVariable Resource. The Population specification will use the Group Resource to facilitate interoperability in matching Evidence Resources to actual groups. 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 EvidenceVariable.definition element has greater flexibility than a CodeableReference datatype which can define the Group Resource for Population specification. Please submit PICO component as a ballot comment concept and/or reference 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." Resource.

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

Structure

characteristic Σ C 0..* BackboneElement A defining factor of the 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 linkId 0..1 id Label for internal linking description 0..1 markdown Natural language description of the characteristic note 0..* Annotation Used for footnotes or explanatory notes exclude 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion definitionReference Σ C 0..1 Reference ( EvidenceVariable | Group | Evidence ) Defines the characteristic (without using type and value) by a Reference device 0..1 Reference ( Device | DeviceMetric ) Device used for determining characteristic value[x] Σ 1..1 Defines the characteristic when coupled with characteristic.type valueCodeableConcept CodeableConcept valueBoolean boolean valueReference id offset 1..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used characteristic 0..1 Range timeFromEvent 0..* BackboneElement Timing in which the characteristic is determined description event[x] 0..1 eventReference 0..1 code continuous | dichotomous | ordinal | polychotomous Binding: Evidence Variable Handling ( Required ) category 0..* valueCodeableConcept Range
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
. . . versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
. . . . versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
. . . name Σ C 0..1 string Name for this evidence variable (computer friendly)
. . . title Σ 0..1 string Name for this evidence variable (human friendly)
. . . shortTitle Σ 0..1 string Title for use in informal contexts
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

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

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

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

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

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

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

. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

. . . actual 0..1 boolean Actual or conceptual
. . . definitionCanonical definition Σ C 0..1 canonical CodeableReference ( EvidenceVariable | Evidence Group ) 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 variable with a CodeableConcept definitionExpression Σ 0..1 Expression Defines the characteristic (without using type and value) by an expression definitionId Σ C 0..1 id Defines the characteristic (without using type and value) by an id definitionByTypeAndValue Σ C 0..1 BackboneElement Defines the characteristic using type and value type Σ 1..1 CodeableConcept Expresses the type of characteristic Binding: UsageContextType ( Example ) method 0..* CodeableConcept Method for how the characteristic value was determined concept and/or Reference
Binding: Evidence Variable Definition Method ( Example )
. . valueQuantity Quantity . handling valueRange Range Reference () valueId 0..1 CodeableConcept code Reference point for valueQuantity or valueRange continuous | dichotomous | ordinal | polychotomous
Binding: Characteristic Offset Evidence Variable Handling ( Example Required )
. . . definitionByCombination category C 0..1 0..* BackboneElement Used to specify how two A grouping for ordinal or more characteristics are combined polychotomous variables

. . . . code name code all-of | any-of | at-least | at-most | statistical | net-effect | dataset Binding: Characteristic Combination ( Required ) threshold 0..1 1..* see characteristic string A defining factor Description of the characteristic grouping
. . . . instances[x] value[x] Number of occurrences meeting the characteristic instancesQuantity Quantity instancesRange 0..1 Range duration[x] 0..1 Length Definition of time in which the characteristic is met grouping
. . . . durationQuantity Quantity . durationRange valueCodeableConcept 0..1 markdown Human readable description note 0..* Annotation Used for footnotes or explanatory notes The event used as a base point (reference point) in time Binding: Evidence Variable Event ( Example ) eventCodeableConcept CodeableConcept Reference ()
. . . . eventDateTime . valueQuantity dateTime eventId id quantity Quantity Used to express the observation at a defined amount of time before or after the event
. . . . . range valueRange 0..1 Range Used to express the observation within a period before and/or after the event handling 0..1 BackboneElement Range A grouping for ordinal or polychotomous variables
. . name 0..1 string Description of the grouping . value[x] 0..1 Definition of the grouping . . valueReference CodeableConcept Reference valueQuantity Quantity ( Group valueRange )

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 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] 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 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..*] 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 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 identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization) 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 be in active use effectivePeriod : Period [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] The method of handling in statistical analysis handling : code [0..1] « null (Strength=Required) EvidenceVariableHandling ! » Characteristic Label used for when a characteristic refers to another characteristic linkId : id [0..1] 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] Defines the characteristic using variable with a concept and/or Reference definitionReference definition : Reference CodeableReference [0..1] « EvidenceVariable | Group | Evidence » « This element has or is affected by some invariants C » Defines the characteristic using Canonical definitionCanonical : canonical [0..1] « EvidenceVariable | Evidence » « This element has or is affected by some invariants C » Defines the characteristic using CodeableConcept definitionCodeableConcept : CodeableConcept [0..1] « This element has or is affected by some invariants C » Defines the characteristic using Expression definitionExpression : Expression [0..1] Defines the characteristic using id definitionId : id [0..1] « This element has or is affected by some invariants C » Number of occurrences meeting the characteristic instances[x] : DataType [0..1] « Quantity | Range » Length of time in which the characteristic is met duration[x] : DataType [0..1] « Quantity | Range » DefinitionByTypeAndValue Used to express the type of characteristic type : CodeableConcept [1..1] « null (Strength=Example) UsageContextType ?? » Method for how the characteristic value was determined method : CodeableConcept [0..*] « ; null (Strength=Example) DefinitionMethod ?? » Device used for determining characteristic device : Reference [0..1] « Device | DeviceMetric » Defines the characteristic when paired with characteristic.type 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 EvidenceVariableDefinition ?? » DefinitionByCombination Used to specify if two or more characteristics are combined with OR or AND The method of handling in statistical analysis code handling : code [1..1] [0..1] « null (Strength=Required) CharacteristicCombination EvidenceVariableHandling ! » Provides the value of "n" when "at-least" or "at-most" codes are used threshold : positiveInt [0..1] TimeFromEvent 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 event quantity : Quantity [0..1] Used to express the observation within a period before and/or after the event range : Range [0..1] Category Description of the grouping name : string [0..1] Definition of the grouping value[x] : DataType [0..1] « CodeableConcept | Quantity | Range » Defines the characteristic using both a type and value[x] elements definitionByTypeAndValue [0..1] A defining factor of the characteristic characteristic [1..*] | Defines the characteristic as a combination of two or more characteristics definitionByCombination Reference [0..1] Timing in which the characteristic is determined timeFromEvent ( Group [0..*] ) » A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semantics characteristic [0..*] A grouping for 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>
 <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) -->
 <<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.


 <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><!-- 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 -->
 <
  <
  <
  <</note>
  <
  <</definitionReference>
  <</definitionCanonical>
  <</definitionCodeableConcept>
  <</definitionExpression>
  <
  <
   <</type>
   <</method>
   <</device>
   <</value[x]>
   <</offset>
  </definitionByTypeAndValue>
  <
   <
   <
   <</characteristic>
  </definitionByCombination>
  <</instances[x]>
  <</duration[x]>
  <
   <
   <</note>
   <</event[x]>
   <</quantity>
   <</range>
  </timeFromEvent>
 </characteristic>

 <definition><!-- 0..1 CodeableReference(Group) Defines the variable with a concept and/or Reference --></definition>

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

  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range|Reference(Group) 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)
  "<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="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>", // 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
  "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
      "
      "
      "
      
      " },
      ">,
      " },
      " },
      " },
      ">",
      "
    },
    "
      "
      "
      "
    },
    
    " },
    " },
    
    " },
    " },
    "
      "
      "
      
      " },
      " },
      ">",
      ">",
      "
      "
    }]
  }],

  "definition" : { CodeableReference(Group) }, // Defines the variable with a concept and/or Reference

  "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 4:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity },
    " }

    "valueRange" : { Range },
    "valueReference" : { Reference(Group) }

  }]
}

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: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:<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.


  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:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      # . One of these 6
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
      fhir:
    ] ;
    fhir:
      fhir:
      fhir:
      fhir:
    ] ;
    # . One of these 2
      fhir: ]
      fhir: ]
    # . One of these 2
      fhir: ]
      fhir: ]
    fhir:
      fhir:
      fhir:
      # . One of these 4
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
      fhir:
      fhir:
    ] ... ) ;
  ] ... ) ;

  fhir:definition [ CodeableReference(Group) ] ; # 0..1 Defines the variable with a concept and/or Reference

  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
    # . One of these 3

    # value[x] : 0..1 Definition of the grouping. One of these 4

      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:Reference ; Reference(Group) ]

  ] ... ) ;
]

Changes from both R4 and R4B

Added Element EvidenceVariable.characteristic Min Cardinality changed from 1 to 0 EvidenceVariable.characteristic.linkId Added Element EvidenceVariable.characteristic.description Type changed from string to markdown EvidenceVariable.characteristic.note Added Element EvidenceVariable.characteristic.definitionReference Added Element EvidenceVariable.characteristic.definitionCanonical Added Element EvidenceVariable.characteristic.definitionCodeableConcept Added Element EvidenceVariable.characteristic.definitionExpression Added Element EvidenceVariable.characteristic.definitionId Added Element 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] Deleted EvidenceVariable.characteristic.definition[x] Deleted EvidenceVariable.characteristic.usageContext
EvidenceVariable
EvidenceVariable.versionAlgorithm[x]
  • Added Element
EvidenceVariable.experimental
  • Added Element
EvidenceVariable.purpose
  • Added Element
EvidenceVariable.copyrightLabel
  • Added Element
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.quantity Added Element EvidenceVariable.characteristic.timeFromEvent.range EvidenceVariable.definition
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.subtitle
  • Deleted
EvidenceVariable.jurisdiction
  • Deleted
EvidenceVariable.topic
  • Deleted
EvidenceVariable.type
  • Deleted
EvidenceVariable.characteristic.participantEffective[x] Deleted EvidenceVariable.characteristic.timeFromStart Deleted EvidenceVariable.characteristic.groupMeasure EvidenceVariable.characteristic
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Structure

characteristic Σ C 0..* BackboneElement A defining factor of the 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 linkId 0..1 id Label for internal linking description 0..1 markdown Natural language description of the characteristic note 0..* Annotation Used for footnotes or explanatory notes exclude 0..1 boolean Whether the characteristic is an inclusion criterion or exclusion criterion definitionReference Σ C 0..1 Reference ( EvidenceVariable | Group | Evidence ) Defines the characteristic (without using type and value) by a Reference boolean valueReference Reference () valueId id offset 1..1 positiveInt Provides the value of "n" when "at-least" or "at-most" codes are used characteristic 0..1 Range timeFromEvent 0..* BackboneElement Timing in which the characteristic is determined description 0..1 0..1 eventReference Reference () continuous | dichotomous | ordinal | polychotomous Binding: Evidence Variable Handling ( Required ) category valueCodeableConcept Range
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
. . . versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
. . . . versionAlgorithmString string
. . . . versionAlgorithmCoding Coding
. . . name Σ C 0..1 string Name for this evidence variable (computer friendly)
. . . title Σ 0..1 string Name for this evidence variable (human friendly)
. . . shortTitle Σ 0..1 string Title for use in informal contexts
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . experimental 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

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

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

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

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

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

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

. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc

. . . actual 0..1 boolean Actual or conceptual
. . . definitionCanonical definition Σ C 0..1 canonical CodeableReference ( EvidenceVariable | Evidence Group ) 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 variable with a CodeableConcept definitionExpression Σ 0..1 Expression Defines the characteristic (without using type and value) by an expression definitionId Σ C 0..1 id Defines the characteristic (without using type and value) by an id definitionByTypeAndValue Σ C 0..1 BackboneElement Defines the characteristic using type and value type Σ 1..1 CodeableConcept Expresses the type of characteristic Binding: UsageContextType ( Example ) method 0..* CodeableConcept Method for how the characteristic value was determined concept and/or Reference
Binding: Evidence Variable 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 valueCodeableConcept CodeableConcept valueBoolean
. . valueQuantity Quantity . handling valueRange Range 0..1 CodeableConcept code Reference point for valueQuantity or valueRange continuous | dichotomous | ordinal | polychotomous
Binding: Characteristic Offset Evidence Variable Handling ( Example Required )
. . . definitionByCombination category C 0..1 0..* BackboneElement Used to specify how two A grouping for ordinal or more characteristics are combined polychotomous variables

. . . . code name code all-of | any-of | at-least | at-most | statistical | net-effect | dataset Binding: Characteristic Combination ( Required ) threshold 0..1 1..* see characteristic string A defining factor Description of the characteristic grouping
. . . . instances[x] value[x] Number of occurrences meeting the characteristic instancesQuantity Quantity instancesRange 0..1 Range duration[x] 0..1 Length Definition of time in which the characteristic is met grouping
. . . . durationQuantity Quantity . durationRange valueCodeableConcept markdown Human readable description note 0..* Annotation Used for footnotes or explanatory notes event[x] The event used as a base point (reference point) in time Binding: Evidence Variable Event ( Example ) eventCodeableConcept CodeableConcept
. . . . eventDateTime . valueQuantity dateTime eventId id quantity 0..1 Quantity Used to express the observation at a defined amount of time before or after the event
. . . . . range valueRange 0..1 Range Used to express the observation within a period before and/or after the event handling 0..1 code 0..* BackboneElement Range A grouping for ordinal or polychotomous variables
. . name 0..1 string Description of the grouping . value[x] 0..1 Definition of the grouping . . valueReference CodeableConcept Reference valueQuantity Quantity ( Group valueRange )

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 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] 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 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..*] 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 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 identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved') copyrightLabel : string [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. See guidance around (not) making local changes to elements [here](canonicalresource.html#localization) 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 be in active use effectivePeriod : Period [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] The method of handling in statistical analysis handling : code [0..1] « null (Strength=Required) EvidenceVariableHandling ! » Characteristic Label used for when a characteristic refers to another characteristic linkId : id [0..1] 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] Defines the characteristic using variable with a concept and/or Reference definitionReference definition : Reference CodeableReference [0..1] « EvidenceVariable | Group | Evidence » « This element has or is affected by some invariants C » Defines the characteristic using Canonical definitionCanonical : canonical [0..1] « EvidenceVariable | Evidence » « This element has or is affected by some invariants C » Defines the characteristic using CodeableConcept definitionCodeableConcept : CodeableConcept [0..1] « This element has or is affected by some invariants C » Defines the characteristic using Expression definitionExpression : Expression [0..1] Defines the characteristic using id definitionId : id [0..1] « This element has or is affected by some invariants C » Number of occurrences meeting the characteristic instances[x] : DataType [0..1] « Quantity | Range » Length of time in which the characteristic is met duration[x] : DataType [0..1] « Quantity | Range » DefinitionByTypeAndValue Used to express the type of characteristic type : CodeableConcept [1..1] « null (Strength=Example) UsageContextType ?? » Method for how the characteristic value was determined method : CodeableConcept [0..*] « ; null (Strength=Example) DefinitionMethod ?? » Device used for determining characteristic device : Reference [0..1] « Device | DeviceMetric » Defines the characteristic when paired with characteristic.type 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 EvidenceVariableDefinition ?? » DefinitionByCombination Used to specify if two or more characteristics are combined with OR or AND The method of handling in statistical analysis code handling : code [1..1] [0..1] « null (Strength=Required) CharacteristicCombination EvidenceVariableHandling ! » Provides the value of "n" when "at-least" or "at-most" codes are used threshold : positiveInt [0..1] TimeFromEvent 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 event quantity : Quantity [0..1] Used to express the observation within a period before and/or after the event range : Range [0..1] Category Description of the grouping name : string [0..1] Definition of the grouping value[x] : DataType [0..1] « CodeableConcept | Quantity | Range » Defines the characteristic using both a type and value[x] elements definitionByTypeAndValue [0..1] A defining factor of the characteristic characteristic [1..*] | Defines the characteristic as a combination of two or more characteristics definitionByCombination Reference [0..1] Timing in which the characteristic is determined timeFromEvent ( Group [0..*] ) » A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semantics characteristic [0..*] A grouping for 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>
 <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) -->
 <<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.


 <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><!-- 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 -->
 <
  <
  <
  <</note>
  <
  <</definitionReference>
  <</definitionCanonical>
  <</definitionCodeableConcept>
  <</definitionExpression>
  <
  <
   <</type>
   <</method>
   <</device>
   <</value[x]>
   <</offset>
  </definitionByTypeAndValue>
  <
   <
   <
   <</characteristic>
  </definitionByCombination>
  <</instances[x]>
  <</duration[x]>
  <
   <
   <</note>
   <</event[x]>
   <</quantity>
   <</range>
  </timeFromEvent>
 </characteristic>

 <definition><!-- 0..1 CodeableReference(Group) Defines the variable with a concept and/or Reference --></definition>

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

  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range|Reference(Group) 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)
  "<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="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>", // 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
  "
    "
    "
    "
    "
    "
    "
    "
    "
    "
    "
      "
      "
      "
      
      " },
      ">,
      " },
      " },
      " },
      ">",
      "
    },
    "
      "
      "
      "
    },
    
    " },
    " },
    
    " },
    " },
    "
      "
      "
      
      " },
      " },
      ">",
      ">",
      "
      "
    }]
  }],

  "definition" : { CodeableReference(Group) }, // Defines the variable with a concept and/or Reference

  "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 4:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity },
    " }

    "valueRange" : { Range },
    "valueReference" : { Reference(Group) }

  }]
}

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: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:<a href="evidencevariable-definitions.html#EvidenceVariable.approvalDate" title="The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.


  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:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
      fhir:
      # . One of these 6
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
      fhir:
    ] ;
    fhir:
      fhir:
      fhir:
      fhir:
    ] ;
    # . One of these 2
      fhir: ]
      fhir: ]
    # . One of these 2
      fhir: ]
      fhir: ]
    fhir:
      fhir:
      fhir:
      # . One of these 4
        fhir: ]
        fhir: ]
        fhir: ]
        fhir: ]
      fhir:
      fhir:
    ] ... ) ;
  ] ... ) ;

  fhir:definition [ CodeableReference(Group) ] ; # 0..1 Defines the variable with a concept and/or Reference

  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
    # . One of these 3

    # value[x] : 0..1 Definition of the grouping. One of these 4

      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:Range ; Range ]
      fhir:value [  a fhir:Reference ; Reference(Group) ]

  ] ... ) ;
]

Changes from both R4 and R4B

Added Element EvidenceVariable.characteristic Min Cardinality changed from 1 to 0 EvidenceVariable.characteristic.linkId Added Element EvidenceVariable.characteristic.description Type changed from string to markdown EvidenceVariable.characteristic.note Added Element EvidenceVariable.characteristic.definitionReference Added Element EvidenceVariable.characteristic.definitionCanonical Added Element EvidenceVariable.characteristic.definitionCodeableConcept Added Element EvidenceVariable.characteristic.definitionExpression Added Element EvidenceVariable.characteristic.definitionId Added Element 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 Deleted EvidenceVariable.characteristic.definition[x] Deleted EvidenceVariable.characteristic.usageContext Deleted EvidenceVariable.characteristic.participantEffective[x]
EvidenceVariable
EvidenceVariable.versionAlgorithm[x]
  • Added Element
EvidenceVariable.experimental
  • Added Element
EvidenceVariable.purpose
  • Added Element
EvidenceVariable.copyrightLabel
  • Added Element
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.range EvidenceVariable.definition
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.subtitle
  • Deleted
EvidenceVariable.jurisdiction
  • Deleted
EvidenceVariable.topic
  • Deleted
EvidenceVariable.type
  • Deleted
EvidenceVariable.characteristic.timeFromStart Deleted EvidenceVariable.characteristic.groupMeasure EvidenceVariable.characteristic
  • Deleted

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

 

Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) , the spreadsheet version & the dependency analysis

EvidenceVariable.characteristic.definitionByTypeAndValue.type UsageContextType Example A code that specifies a type of context being specified by a usage context. EvidenceVariable.characteristic.definitionByTypeAndValue.method DefinitionMethod Example The method used to define, describe, or determine a characteristic value. EvidenceVariable.characteristic.definitionByTypeAndValue.offset
Path ValueSet Type Documentation
EvidenceVariable.versionAlgorithm[x] VersionAlgorithm Extensible

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

EvidenceVariable.status PublicationStatus Required

The lifecycle status of an artifact.

EvidenceVariable.definition CharacteristicOffset EvidenceVariableDefinition Example

Reference point for characteristic.valueQuantity. EvidenceVariable.characteristic.definitionByCombination.code CharacteristicCombination Required Logical grouping Examples of characteristics. EvidenceVariable.characteristic.timeFromEvent.event[x] EvidenceVariableEvent Example The event used as a base point (reference point) in time. terms that represent an evidence variable definition.

EvidenceVariable.handling EvidenceVariableHandling Required

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

 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
UniqueKey Level Location Description Expression
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_]){1,254}$')
img  cnl-1 Warning EvidenceVariable.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')

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.ofType(CodeableConcept)) 30 Resources
context-quantity quantity A quantity- or range-valued use context assigned to the evidence variable (EvidenceVariable.useContext.value.ofType(Quantity)) | (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.ofType(Quantity) | 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.ofType(CodeableConcept)
30 Resources
date 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 string The description of the evidence variable EvidenceVariable.description 28 Resources
identifier token External identifier for the evidence variable EvidenceVariable.identifier 34 36 Resources
name string Computationally friendly name of the evidence variable EvidenceVariable.name 26 27 Resources
predecessor reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='predecessor').resource
(Any)
10 Resources
publisher string Name of the publisher of the evidence variable EvidenceVariable.publisher 30 Resources
status token The current status of the evidence variable EvidenceVariable.status 35 36 Resources
successor reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='successor').resource
(Any)
6 Resources
title string The human-friendly name of the evidence variable EvidenceVariable.title 27 Resources
topic token Topics associated with the EvidenceVariable 10 Resources
url uri The uri that identifies the evidence variable EvidenceVariable.url 34 35 Resources
version token The business version of the evidence variable EvidenceVariable.version 30 31 Resources