Release 4 5 Snapshot #1

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

14.10 14.14 Resource EvidenceVariable - Content

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

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

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

The scope of the EvidenceVariable resource Resource is to describe a "PICO" an element that knowledge (evidence, assertion, recommendation) (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 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.

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

This resource is referenced by EffectEvidenceSynthesis , Evidence , itself and RiskEvidenceSynthesis ResearchStudy .

This resource implements the Definition pattern.

Structure

publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
Name Flags Card. Type Description & Constraints doco
. . EvidenceVariable I TU DomainResource MetadataResource A population, intervention, or exposure definition of an exposure, outcome, or other variable
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright , approvalDate , lastReviewDate , effectivePeriod , topic , author , editor , reviewer , endorser , relatedArtifact
. . . url Σ 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the evidence variable
. . . version Σ 0..1 string Business version of the evidence variable
. . . title Σ 0..1 string Name for this evidence variable (human friendly)
. . . shortTitle Σ 0..1 string Title for use in informal contexts
. . . subtitle 0..1 string Subordinate title of the EvidenceVariable
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . date Σ 0..1 dateTime Date last changed
. . . 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
. . jurisdiction . publisher Σ 0..* 0..1 CodeableConcept string Intended jurisdiction for evidence variable (if applicable) Jurisdiction ( Extensible ) Name of the publisher (organization or individual)
. . copyright . contact Σ 0..1 0..* markdown ContactDetail Use and/or publishing restrictions Contact details for the publisher
. . approvalDate . author 0..1 0..* date ContactDetail When Who authored the evidence variable was approved by publisher content
. . lastReviewDate . editor 0..1 0..* date ContactDetail When Who edited the evidence variable was last reviewed content
. . . effectivePeriod reviewer Σ 0..1 0..* Period ContactDetail When Who reviewed the evidence variable is expected to be used content
. . . topic endorser 0..* CodeableConcept ContactDetail The category of Who endorsed the EvidenceVariable, such as Education, Treatment, Assessment, etc. DefinitionTopic ( Example ) content
. . . author relatedArtifact 0..* ContactDetail RelatedArtifact Who authored the content Additional documentation, citations, etc.
. . editor . actual 0..* 0..1 ContactDetail boolean Who edited the content Actual or conceptual
. . reviewer . characteristicCombination 0..* 0..1 ContactDetail BackboneElement Who reviewed the content Used to specify how two or more characteristics are combined
. . . endorser . code 0..* 1..1 ContactDetail code Who endorsed the content all-of | any-of | at-least | at-most | net-effect
CharacteristicCombination ( Required )
. . relatedArtifact . . threshold 0..* 0..1 RelatedArtifact positiveInt Additional documentation, citations, etc. Provides the value of "n" when "at-least" or "at-most" codes are used
. . type . characteristic Σ 0..1 0..* code BackboneElement dichotomous | continuous | descriptive What defines the members of the evidence element
EvidenceVariableType ( Required )
. . characteristic . . description Σ 1..* 0..1 BackboneElement string What defines the members Natural language description of the evidence element characteristic
. . . description . type 0..1 string CodeableConcept Natural language description of Expresses the type of characteristic
UsageContextType ( Example )
. . . . definition[x] Σ 1..1 What code or expression defines members?
. . . . . definitionReference Reference ( Group | EvidenceVariable )
. . . . . definitionCanonical canonical ( ActivityDefinition Any )
. . . . . definitionCodeableConcept CodeableConcept
. . . . . definitionExpression Expression
. . . . definitionDataRequirement method 0..1 DataRequirement CodeableConcept Method used for describing characteristic
CharacteristicMethod ( Example )
. . . definitionTriggerDefinition . device 0..1 TriggerDefinition Reference ( Device | DeviceMetric ) Device used for determining characteristic
. . . usageContext . exclude 0..* 0..1 UsageContext boolean What code/value pairs define members? Whether the characteristic includes or excludes members
. . . exclude . timeFromEvent 0..1 0..* boolean BackboneElement Whether the characteristic includes or excludes members Observation time from study specified event
. . . . participantEffective[x] . description 0..1 string What time period do participants cover Human readable description
. . . . participantEffectiveDateTime . event 0..1 dateTime CodeableConcept The event used as a base point (reference point) in time
EvidenceVariableEvent ( Example )
. . . . . participantEffectivePeriod quantity 0..1 Period Quantity Used to express the observation at a defined amount of time after the study start
. . . . . participantEffectiveDuration range 0..1 Duration Range Used to express the observation within a period after the study start
. . . . . participantEffectiveTiming note 0..* Timing Annotation Used for footnotes or explanatory notes
. . . timeFromStart . groupMeasure 0..1 Duration code Observation time from study start mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure ( Required )
. . . groupMeasure handling 0..1 code mean | median | mean-of-mean continuous | mean-of-median dichotomous | median-of-mean ordinal | median-of-median polychotomous
GroupMeasure EvidenceVariableHandling ( 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

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] 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] 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] « The lifecycle status of an artifact. null (Strength=Required) PublicationStatus ! » The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes date : dateTime [0..1] The name of the organization or individual that published 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..*] A legal or geographic region in which the evidence variable is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change name of the original approval date lastReviewDate : date [0..1] The period during which organization or individual that published the evidence variable content was or is planned to be in active use effectivePeriod publisher : Period string [0..1] Descriptive topics related Contact details to the content of the EvidenceVariable. Topics provide assist a high-level categorization grouping types of EvidenceVariables that can be useful for filtering user in finding and searching communicating with the publisher topic contact : CodeableConcept ContactDetail [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization 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..*] The type of evidence element, True if the actual variable measured, false if a population, an exposure, or an outcome conceptual representation of the intended variable type actual : boolean [0..1] continuous | dichotomous | ordinal | polychotomous handling : code [0..1] « The possible types of variables for exposures null (Strength=Required) EvidenceVariableHandling ! » CharacteristicCombination Used to specify if two or outcomes (E.g. Dichotomous, Continuous, Descriptive). more characteristics are combined with OR or AND code : code [1..1] « null (Strength=Required) EvidenceVariableType CharacteristicCombination ! » Provides the value of "n" when "at-least" or "at-most" codes are used threshold : positiveInt [0..1] Characteristic A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user description : string [0..1] Used to expressing the type of characteristic type : CodeableConcept [0..1] « null (Strength=Example) UsageContextType ?? » Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year) definition[x] : Type DataType [1..1] « Reference ( Group | EvidenceVariable )| canonical ( ActivityDefinition Any )| CodeableConcept | Expression | DataRequirement | » TriggerDefinition Method used for describing characteristic method : CodeableConcept [0..1] « null (Strength=Example) CharacteristicMethod ?? » Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings Device used for determining characteristic usageContext device : UsageContext Reference [0..*] [0..1] « Device | DeviceMetric » When true, members with this characteristic are excluded from the element exclude : boolean [0..1] Indicates what effective period Value or set of values that define the study covers grouping participantEffective[x] groupMeasure : Type code [0..1] « dateTime | Period null (Strength=Required) GroupMeasure ! » TimeFromEvent Human readable description description | Duration : string | [0..1] Timing The event used as a base point (reference point) in time event : CodeableConcept [0..1] « null (Strength=Example) EvidenceVariableEvent ?? » Indicates duration from Used to express the observation at a defined amount of time after the participant's study entry start timeFromStart quantity : Duration Quantity [0..1] Indicates how elements are aggregated Used to express the observation within a period after the study effective period start groupMeasure range : code Range [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required) A human-readable string to clarify or explain concepts about the resource GroupMeasure ! note : Annotation [0..*] Category Description of the grouping name : string [0..1] Definition of the grouping value[x] : DataType [0..1] « CodeableConcept | Quantity | Range » Used to specify how two or more characteristics are combined characteristicCombination [0..1] Observation time from study specified event timeFromEvent [0..*] A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics characteristic [1..*] [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  -->

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the evidence variable -->
 <

 <name value="[string]"/><!-- ?? 0..1 Name for this evidence variable (computer friendly) -->

 <title value="[string]"/><!-- 0..1 Name for this evidence variable (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <
 <</contact>

 <description value="[markdown]"/><!-- 0..1 Natural language description of the evidence variable -->
 <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <</jurisdiction>
 <
 <
 <
 <</effectivePeriod>
 <</topic>

 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>

 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <
 <

 <actual value="[boolean]"/><!-- 0..1 Actual or conceptual -->
 <characteristicCombination>  <!-- 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 | net-effect -->
  <threshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->
 </characteristicCombination>
 <characteristic>  <!-- 0..* What defines the members of the evidence element -->

  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <)|
    </definition[x]>
  <</usageContext>

  <type><!-- 0..1 CodeableConcept Expresses the type of characteristic --></type>
  <definition[x]><!-- 1..1 Reference(EvidenceVariable|Group)|canonical(Any)|
    CodeableConcept|Expression What code or expression defines members? --></definition[x]>

  <method><!-- 0..1 CodeableConcept Method used for describing characteristic --></method>
  <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>

  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <</participantEffective[x]>
  <</timeFromStart>
  <

  <timeFromEvent>  <!-- 0..* Observation time from study specified event -->
   <description value="[string]"/><!-- 0..1 Human readable description -->
   <event><!-- 0..1 CodeableConcept The event used as a base point (reference point) in time --></event>
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range>
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  </timeFromEvent>
  <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->

 </characteristic>
 <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous -->
 <category>  <!-- 0..* A grouping for ordinal or polychotomous variables -->
  <name value="[string]"/><!-- 0..1 Description of the grouping -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range Definition of the grouping --></value[x]>
 </category>

</EvidenceVariable>

JSON Template

{doco
  "resourceType" : "",

  "resourceType" : "EvidenceVariable",

  // from Resource: id, meta, implicitRules, and language
  // from 

  "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the evidence variable
  "version" : "<string>", // Business version of the evidence variable
  "

  "name" : "<string>", // C? Name for this evidence variable (computer friendly)

  "title" : "<string>", // Name for this evidence variable (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the EvidenceVariable
  "status" : "<code>", // R!  draft | active | retired | unknown
  "date" : "<dateTime>", // Date last changed
  "
  "

  "description" : "<markdown>", // Natural language description of the evidence variable
  "note" : [{ Annotation }], // Used for footnotes or explanatory notes
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "
  "
  "
  "
  "
  "

  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher

  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "
  "

  "actual" : <boolean>, // Actual or conceptual
  "characteristicCombination" : { // Used to specify how two or more characteristics are combined
    "code" : "<code>", // R!  all-of | any-of | at-least | at-most | net-effect
    "threshold" : "<positiveInt>" // Provides the value of "n" when "at-least" or "at-most" codes are used
  },
  "characteristic" : [{ // What defines the members of the evidence element

    "description" : "<string>", // Natural language description of the characteristic
    
    " },
    " },

    "type" : { CodeableConcept }, // Expresses the type of characteristic
    // definition[x]: What code or expression defines members?. One of these 4:

    "definitionReference" : { Reference(EvidenceVariable|Group) },
    "definitionCanonical" : { canonical(Any) },

    "definitionCodeableConcept" : { CodeableConcept },
    "definitionExpression" : { Expression },
    " },
    " },
    "

    "method" : { CodeableConcept }, // Method used for describing characteristic
    "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic

    "exclude" : <boolean>, // Whether the characteristic includes or excludes members
    
    ">",
    " },
    " },
    " },
    "
    "

    "timeFromEvent" : [{ // Observation time from study specified event
      "description" : "<string>", // Human readable description
      "event" : { CodeableConcept }, // The event used as a base point (reference point) in time
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start
      "range" : { Range }, // Used to express the observation within a period after the study start
      "note" : [{ Annotation }] // Used for footnotes or explanatory notes
    }],
    "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  }],
  "handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
  "category" : [{ // A grouping for ordinal or polychotomous variables
    "name" : "<string>", // Description of the grouping
    // value[x]: Definition of the grouping. One of these 3:

    "valueCodeableConcept" : { CodeableConcept }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }

  }]
}

Turtle Template

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


[ a fhir:;

[ a fhir:EvidenceVariable;

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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from 

  fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable
  fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable
  fhir:EvidenceVariable.name [ string ]; # 0..1 Name for this evidence variable (computer friendly)
  fhir:EvidenceVariable.title [ string ]; # 0..1 Name for this evidence variable (human friendly)
  fhir:EvidenceVariable.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:EvidenceVariable.subtitle [ string ]; # 0..1 Subordinate title of the EvidenceVariable
  fhir:EvidenceVariable.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed
  fhir:
  fhir:

  fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable
  fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher

  fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:
  fhir:

  fhir:EvidenceVariable.actual [ boolean ]; # 0..1 Actual or conceptual
  fhir:EvidenceVariable.characteristicCombination [ # 0..1 Used to specify how two or more characteristics are combined
    fhir:EvidenceVariable.characteristicCombination.code [ code ]; # 1..1 all-of | any-of | at-least | at-most | net-effect
    fhir:EvidenceVariable.characteristicCombination.threshold [ positiveInt ]; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used
  ];
  fhir:EvidenceVariable.characteristic [ # 0..* What defines the members of the evidence element

    fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic
    # . One of these 6
      fhir:) ]
      fhir:) ]

    fhir:EvidenceVariable.characteristic.type [ CodeableConcept ]; # 0..1 Expresses the type of characteristic
    # EvidenceVariable.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 4
      fhir:EvidenceVariable.characteristic.definitionReference [ Reference(EvidenceVariable|Group) ]
      fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Any) ]

      fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]
      fhir: ]
      fhir: ]
    fhir:

    fhir:EvidenceVariable.characteristic.method [ CodeableConcept ]; # 0..1 Method used for describing characteristic
    fhir:EvidenceVariable.characteristic.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic

    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    # . One of these 4
      fhir: ]
      fhir: ]
      fhir: ]
      fhir: ]
    fhir:
    fhir:

    fhir:EvidenceVariable.characteristic.timeFromEvent [ # 0..* Observation time from study specified event
      fhir:EvidenceVariable.characteristic.timeFromEvent.description [ string ]; # 0..1 Human readable description
      fhir:EvidenceVariable.characteristic.timeFromEvent.event [ CodeableConcept ]; # 0..1 The event used as a base point (reference point) in time
      fhir:EvidenceVariable.characteristic.timeFromEvent.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start
      fhir:EvidenceVariable.characteristic.timeFromEvent.range [ Range ]; # 0..1 Used to express the observation within a period after the study start
      fhir:EvidenceVariable.characteristic.timeFromEvent.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
    ], ...;
    fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
  fhir:EvidenceVariable.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping
    # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.category.valueQuantity [ Quantity ]
      fhir:EvidenceVariable.category.valueRange [ Range ]

  ], ...;
]

Changes since R3

EvidenceVariable
EvidenceVariable.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|5.0.0-snapshot1
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristicCombination
  • Added Element
EvidenceVariable.characteristicCombination.code
  • Added Mandatory Element
EvidenceVariable.characteristicCombination.threshold
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.type
  • Added Element
EvidenceVariable.characteristic.definition[x]
  • Remove Types DataRequirement, TriggerDefinition
EvidenceVariable.characteristic.method
  • Added Element
EvidenceVariable.characteristic.device
  • Added Element
EvidenceVariable.characteristic.timeFromEvent
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.description
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.event
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.range
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.note
  • Added Element
EvidenceVariable.characteristic.groupMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/group-measure|4.0.0 to http://hl7.org/fhir/ValueSet/group-measure|5.0.0-snapshot1
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.copyright
  • deleted
EvidenceVariable.approvalDate
  • deleted
EvidenceVariable.lastReviewDate
  • deleted
EvidenceVariable.effectivePeriod
  • deleted
EvidenceVariable.topic
  • deleted
EvidenceVariable.type
  • deleted
EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.characteristic.participantEffective[x]
  • deleted
EvidenceVariable.characteristic.timeFromStart
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher
Name Flags Card. Type Description & Constraints doco
. . EvidenceVariable I TU DomainResource MetadataResource A population, intervention, or exposure definition of an exposure, outcome, or other variable
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright , approvalDate , lastReviewDate , effectivePeriod , topic , author , editor , reviewer , endorser , relatedArtifact
. . . url Σ 0..1 uri Canonical identifier for this evidence variable, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the evidence variable
. . . version Σ 0..1 string Business version of the evidence variable
. . . title Σ 0..1 string Name for this evidence variable (human friendly)
. . . shortTitle Σ 0..1 string Title for use in informal contexts
. . . subtitle 0..1 string Subordinate title of the EvidenceVariable
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . date Σ 0..1 dateTime Date last changed
. . . 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
. . jurisdiction . publisher Σ 0..* 0..1 CodeableConcept string Intended jurisdiction for evidence variable (if applicable) Jurisdiction ( Extensible ) Name of the publisher (organization or individual)
. . copyright . contact Σ 0..1 0..* markdown ContactDetail Use and/or publishing restrictions Contact details for the publisher
. . approvalDate . author 0..1 0..* date ContactDetail When Who authored the evidence variable was approved by publisher content
. . lastReviewDate . editor 0..1 0..* date ContactDetail When Who edited the evidence variable was last reviewed content
. . . effectivePeriod reviewer Σ 0..1 0..* Period ContactDetail When Who reviewed the evidence variable is expected to be used content
. . . topic endorser 0..* CodeableConcept ContactDetail The category of Who endorsed the EvidenceVariable, such as Education, Treatment, Assessment, etc. DefinitionTopic ( Example ) content
. . . author relatedArtifact 0..* ContactDetail RelatedArtifact Who authored the content Additional documentation, citations, etc.
. . editor . actual 0..* 0..1 ContactDetail boolean Who edited the content Actual or conceptual
. . reviewer . characteristicCombination 0..* 0..1 ContactDetail BackboneElement Who reviewed the content Used to specify how two or more characteristics are combined
. . . endorser . code 0..* 1..1 ContactDetail code Who endorsed the content all-of | any-of | at-least | at-most | net-effect
CharacteristicCombination ( Required )
. . relatedArtifact . . threshold 0..* 0..1 RelatedArtifact positiveInt Additional documentation, citations, etc. Provides the value of "n" when "at-least" or "at-most" codes are used
. . type . characteristic Σ 0..1 0..* code BackboneElement dichotomous | continuous | descriptive What defines the members of the evidence element
EvidenceVariableType ( Required )
. . characteristic . . description Σ 1..* 0..1 BackboneElement string What defines the members Natural language description of the evidence element characteristic
. . . description . type 0..1 string CodeableConcept Natural language description of Expresses the type of characteristic
UsageContextType ( Example )
. . . . definition[x] Σ 1..1 What code or expression defines members?
. . . . . definitionReference Reference ( Group | EvidenceVariable )
. . . . . definitionCanonical canonical ( ActivityDefinition Any )
. . . . . definitionCodeableConcept CodeableConcept
. . . . . definitionExpression Expression
. . . . definitionDataRequirement method 0..1 DataRequirement CodeableConcept Method used for describing characteristic
CharacteristicMethod ( Example )
. . . definitionTriggerDefinition . device 0..1 TriggerDefinition Reference ( Device | DeviceMetric ) Device used for determining characteristic
. . . usageContext . exclude 0..* 0..1 UsageContext boolean What code/value pairs define members? Whether the characteristic includes or excludes members
. . . exclude . timeFromEvent 0..1 0..* boolean BackboneElement Whether the characteristic includes or excludes members Observation time from study specified event
. . . . participantEffective[x] . description 0..1 string What time period do participants cover Human readable description
. . . . participantEffectiveDateTime . event 0..1 dateTime CodeableConcept The event used as a base point (reference point) in time
EvidenceVariableEvent ( Example )
. . . . . participantEffectivePeriod quantity 0..1 Period Quantity Used to express the observation at a defined amount of time after the study start
. . . . . participantEffectiveDuration range 0..1 Duration Range Used to express the observation within a period after the study start
. . . . . participantEffectiveTiming note 0..* Timing Annotation Used for footnotes or explanatory notes
. . . timeFromStart . groupMeasure 0..1 Duration code Observation time from study start mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
GroupMeasure ( Required )
. . . groupMeasure handling 0..1 code mean | median | mean-of-mean continuous | mean-of-median dichotomous | median-of-mean ordinal | median-of-median polychotomous
GroupMeasure EvidenceVariableHandling ( 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

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] 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] 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] « The lifecycle status of an artifact. null (Strength=Required) PublicationStatus ! » The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes date : dateTime [0..1] The name of the organization or individual that published 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..*] A legal or geographic region in which the evidence variable is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » A copyright statement relating to the evidence variable and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence variable copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change name of the original approval date lastReviewDate : date [0..1] The period during which organization or individual that published the evidence variable content was or is planned to be in active use effectivePeriod publisher : Period string [0..1] Descriptive topics related Contact details to the content of the EvidenceVariable. Topics provide assist a high-level categorization grouping types of EvidenceVariables that can be useful for filtering user in finding and searching communicating with the publisher topic contact : CodeableConcept ContactDetail [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization 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..*] The type of evidence element, True if the actual variable measured, false if a population, an exposure, or an outcome conceptual representation of the intended variable type actual : boolean [0..1] continuous | dichotomous | ordinal | polychotomous handling : code [0..1] « The possible types of variables for exposures null (Strength=Required) EvidenceVariableHandling ! » CharacteristicCombination Used to specify if two or outcomes (E.g. Dichotomous, Continuous, Descriptive). more characteristics are combined with OR or AND code : code [1..1] « null (Strength=Required) EvidenceVariableType CharacteristicCombination ! » Provides the value of "n" when "at-least" or "at-most" codes are used threshold : positiveInt [0..1] Characteristic A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user description : string [0..1] Used to expressing the type of characteristic type : CodeableConcept [0..1] « null (Strength=Example) UsageContextType ?? » Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year) definition[x] : Type DataType [1..1] « Reference ( Group | EvidenceVariable )| canonical ( ActivityDefinition Any )| CodeableConcept | Expression | DataRequirement | » TriggerDefinition Method used for describing characteristic method : CodeableConcept [0..1] « null (Strength=Example) CharacteristicMethod ?? » Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings Device used for determining characteristic usageContext device : UsageContext Reference [0..*] [0..1] « Device | DeviceMetric » When true, members with this characteristic are excluded from the element exclude : boolean [0..1] Indicates what effective period Value or set of values that define the study covers grouping participantEffective[x] groupMeasure : Type code [0..1] « dateTime | Period null (Strength=Required) GroupMeasure ! » TimeFromEvent Human readable description description | Duration : string | [0..1] Timing The event used as a base point (reference point) in time event : CodeableConcept [0..1] « null (Strength=Example) EvidenceVariableEvent ?? » Indicates duration from Used to express the observation at a defined amount of time after the participant's study entry start timeFromStart quantity : Duration Quantity [0..1] Indicates how elements are aggregated Used to express the observation within a period after the study effective period start groupMeasure range : code Range [0..1] « Possible group measure aggregates (E.g. Mean, Median). (Strength=Required) A human-readable string to clarify or explain concepts about the resource GroupMeasure ! note : Annotation [0..*] Category Description of the grouping name : string [0..1] Definition of the grouping value[x] : DataType [0..1] « CodeableConcept | Quantity | Range » Used to specify how two or more characteristics are combined characteristicCombination [0..1] Observation time from study specified event timeFromEvent [0..*] A characteristic that defines the members of the evidence element. Multiple characteristics are applied with "and" semantics characteristic [1..*] [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  -->

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the evidence variable -->
 <

 <name value="[string]"/><!-- ?? 0..1 Name for this evidence variable (computer friendly) -->

 <title value="[string]"/><!-- 0..1 Name for this evidence variable (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <
 <</contact>

 <description value="[markdown]"/><!-- 0..1 Natural language description of the evidence variable -->
 <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <</jurisdiction>
 <
 <
 <
 <</effectivePeriod>
 <</topic>

 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>

 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <
 <

 <actual value="[boolean]"/><!-- 0..1 Actual or conceptual -->
 <characteristicCombination>  <!-- 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 | net-effect -->
  <threshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->
 </characteristicCombination>
 <characteristic>  <!-- 0..* What defines the members of the evidence element -->

  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <)|
    </definition[x]>
  <</usageContext>

  <type><!-- 0..1 CodeableConcept Expresses the type of characteristic --></type>
  <definition[x]><!-- 1..1 Reference(EvidenceVariable|Group)|canonical(Any)|
    CodeableConcept|Expression What code or expression defines members? --></definition[x]>

  <method><!-- 0..1 CodeableConcept Method used for describing characteristic --></method>
  <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>

  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic includes or excludes members -->
  <</participantEffective[x]>
  <</timeFromStart>
  <

  <timeFromEvent>  <!-- 0..* Observation time from study specified event -->
   <description value="[string]"/><!-- 0..1 Human readable description -->
   <event><!-- 0..1 CodeableConcept The event used as a base point (reference point) in time --></event>
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range>
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  </timeFromEvent>
  <groupMeasure value="[code]"/><!-- 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median -->

 </characteristic>
 <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous -->
 <category>  <!-- 0..* A grouping for ordinal or polychotomous variables -->
  <name value="[string]"/><!-- 0..1 Description of the grouping -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range Definition of the grouping --></value[x]>
 </category>

</EvidenceVariable>

JSON Template

{doco
  "resourceType" : "",

  "resourceType" : "EvidenceVariable",

  // from Resource: id, meta, implicitRules, and language
  // from 

  "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the evidence variable
  "version" : "<string>", // Business version of the evidence variable
  "

  "name" : "<string>", // C? Name for this evidence variable (computer friendly)

  "title" : "<string>", // Name for this evidence variable (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the EvidenceVariable
  "status" : "<code>", // R!  draft | active | retired | unknown
  "date" : "<dateTime>", // Date last changed
  "
  "

  "description" : "<markdown>", // Natural language description of the evidence variable
  "note" : [{ Annotation }], // Used for footnotes or explanatory notes
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "
  "
  "
  "
  "
  "

  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher

  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "
  "

  "actual" : <boolean>, // Actual or conceptual
  "characteristicCombination" : { // Used to specify how two or more characteristics are combined
    "code" : "<code>", // R!  all-of | any-of | at-least | at-most | net-effect
    "threshold" : "<positiveInt>" // Provides the value of "n" when "at-least" or "at-most" codes are used
  },
  "characteristic" : [{ // What defines the members of the evidence element

    "description" : "<string>", // Natural language description of the characteristic
    
    " },
    " },

    "type" : { CodeableConcept }, // Expresses the type of characteristic
    // definition[x]: What code or expression defines members?. One of these 4:

    "definitionReference" : { Reference(EvidenceVariable|Group) },
    "definitionCanonical" : { canonical(Any) },

    "definitionCodeableConcept" : { CodeableConcept },
    "definitionExpression" : { Expression },
    " },
    " },
    "

    "method" : { CodeableConcept }, // Method used for describing characteristic
    "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic

    "exclude" : <boolean>, // Whether the characteristic includes or excludes members
    
    ">",
    " },
    " },
    " },
    "
    "

    "timeFromEvent" : [{ // Observation time from study specified event
      "description" : "<string>", // Human readable description
      "event" : { CodeableConcept }, // The event used as a base point (reference point) in time
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start
      "range" : { Range }, // Used to express the observation within a period after the study start
      "note" : [{ Annotation }] // Used for footnotes or explanatory notes
    }],
    "groupMeasure" : "<code>" // mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  }],
  "handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
  "category" : [{ // A grouping for ordinal or polychotomous variables
    "name" : "<string>", // Description of the grouping
    // value[x]: Definition of the grouping. One of these 3:

    "valueCodeableConcept" : { CodeableConcept }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }

  }]
}

Turtle Template

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


[ a fhir:;

[ a fhir:EvidenceVariable;

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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from 

  fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable
  fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable
  fhir:EvidenceVariable.name [ string ]; # 0..1 Name for this evidence variable (computer friendly)
  fhir:EvidenceVariable.title [ string ]; # 0..1 Name for this evidence variable (human friendly)
  fhir:EvidenceVariable.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:EvidenceVariable.subtitle [ string ]; # 0..1 Subordinate title of the EvidenceVariable
  fhir:EvidenceVariable.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed
  fhir:
  fhir:

  fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable
  fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:

  fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher

  fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:
  fhir:

  fhir:EvidenceVariable.actual [ boolean ]; # 0..1 Actual or conceptual
  fhir:EvidenceVariable.characteristicCombination [ # 0..1 Used to specify how two or more characteristics are combined
    fhir:EvidenceVariable.characteristicCombination.code [ code ]; # 1..1 all-of | any-of | at-least | at-most | net-effect
    fhir:EvidenceVariable.characteristicCombination.threshold [ positiveInt ]; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used
  ];
  fhir:EvidenceVariable.characteristic [ # 0..* What defines the members of the evidence element

    fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic
    # . One of these 6
      fhir:) ]
      fhir:) ]

    fhir:EvidenceVariable.characteristic.type [ CodeableConcept ]; # 0..1 Expresses the type of characteristic
    # EvidenceVariable.characteristic.definition[x] : 1..1 What code or expression defines members?. One of these 4
      fhir:EvidenceVariable.characteristic.definitionReference [ Reference(EvidenceVariable|Group) ]
      fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Any) ]

      fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]
      fhir: ]
      fhir: ]
    fhir:

    fhir:EvidenceVariable.characteristic.method [ CodeableConcept ]; # 0..1 Method used for describing characteristic
    fhir:EvidenceVariable.characteristic.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic

    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic includes or excludes members
    # . One of these 4
      fhir: ]
      fhir: ]
      fhir: ]
      fhir: ]
    fhir:
    fhir:

    fhir:EvidenceVariable.characteristic.timeFromEvent [ # 0..* Observation time from study specified event
      fhir:EvidenceVariable.characteristic.timeFromEvent.description [ string ]; # 0..1 Human readable description
      fhir:EvidenceVariable.characteristic.timeFromEvent.event [ CodeableConcept ]; # 0..1 The event used as a base point (reference point) in time
      fhir:EvidenceVariable.characteristic.timeFromEvent.quantity [ Quantity ]; # 0..1 Used to express the observation at a defined amount of time after the study start
      fhir:EvidenceVariable.characteristic.timeFromEvent.range [ Range ]; # 0..1 Used to express the observation within a period after the study start
      fhir:EvidenceVariable.characteristic.timeFromEvent.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
    ], ...;
    fhir:EvidenceVariable.characteristic.groupMeasure [ code ]; # 0..1 mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median
  ], ...;
  fhir:EvidenceVariable.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping
    # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.category.valueQuantity [ Quantity ]
      fhir:EvidenceVariable.category.valueRange [ Range ]

  ], ...;
]

Changes since Release 3

EvidenceVariable
EvidenceVariable.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|5.0.0-snapshot1
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristicCombination
  • Added Element
EvidenceVariable.characteristicCombination.code
  • Added Mandatory Element
EvidenceVariable.characteristicCombination.threshold
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.type
  • Added Element
EvidenceVariable.characteristic.definition[x]
  • Remove Types DataRequirement, TriggerDefinition
EvidenceVariable.characteristic.method
  • Added Element
EvidenceVariable.characteristic.device
  • Added Element
EvidenceVariable.characteristic.timeFromEvent
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.description
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.event
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.range
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.note
  • Added Element
EvidenceVariable.characteristic.groupMeasure
  • Change value set from http://hl7.org/fhir/ValueSet/group-measure|4.0.0 to http://hl7.org/fhir/ValueSet/group-measure|5.0.0-snapshot1
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.copyright
  • deleted
EvidenceVariable.approvalDate
  • deleted
EvidenceVariable.lastReviewDate
  • deleted
EvidenceVariable.effectivePeriod
  • deleted
EvidenceVariable.topic
  • deleted
EvidenceVariable.type
  • deleted
EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.characteristic.participantEffective[x]
  • deleted
EvidenceVariable.characteristic.timeFromStart
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

 

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

EvidenceVariable.jurisdiction EvidenceVariable.topic EvidenceVariable.type
Path Definition Type Reference
EvidenceVariable.status The lifecycle status of an artifact. Required PublicationStatus
EvidenceVariable.characteristicCombination.code Countries and regions within which this artifact is targeted for use. Extensible Required Jurisdiction ValueSet CharacteristicCombination
EvidenceVariable.characteristic.type High-level categorization of the definition, used for searching, sorting, and filtering. Example DefinitionTopic UsageContextType
EvidenceVariable.characteristic.method The possible types of variables for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). Required Example EvidenceVariableType CharacteristicMethod
EvidenceVariable.characteristic.timeFromEvent.event Example EvidenceVariableEvent
EvidenceVariable.characteristic.groupMeasure Possible group measure aggregates (E.g. Mean, Median). Required GroupMeasure
EvidenceVariable.handling Required EvidenceVariableHandling

id Level Location Description Expression
evv-0 cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

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

Name Type Description Expression In Common
composed-of reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='composed-of').resource
(Any)
context token A use context assigned to the evidence variable (EvidenceVariable.useContext.value as CodeableConcept)
context-quantity quantity A quantity- or range-valued use context assigned to the evidence variable (EvidenceVariable.useContext.value as Quantity) | (EvidenceVariable.useContext.value as Range)
context-type token A type of use context assigned to the evidence variable EvidenceVariable.useContext.code
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.as(Range)
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)
date N date The evidence variable publication date EvidenceVariable.date
depends-on reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='depends-on').resource
(Any)
derived-from reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='derived-from').resource
(Any)
description N string The description of the evidence variable EvidenceVariable.description
effective date The time during which the evidence variable is intended to be in use EvidenceVariable.effectivePeriod identifier token External identifier for the evidence variable EvidenceVariable.identifier
jurisdiction token Intended jurisdiction for the evidence variable EvidenceVariable.jurisdiction name N string Computationally friendly name of the evidence variable EvidenceVariable.name
predecessor reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='predecessor').resource
(Any)
publisher N string Name of the publisher of the evidence variable EvidenceVariable.publisher
status N token The current status of the evidence variable EvidenceVariable.status
successor reference What resource is being referenced EvidenceVariable.relatedArtifact.where(type='successor').resource
(Any)
title N string The human-friendly name of the evidence variable EvidenceVariable.title
topic token Topics associated with the EvidenceVariable EvidenceVariable.topic
url N uri The uri that identifies the evidence variable EvidenceVariable.url
version N token The business version of the evidence variable EvidenceVariable.version