FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

14.14 Resource EvidenceVariable - Content

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

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

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

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

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

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

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

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

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

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

The EvidenceVariable Resource allows expression of the components of a PICO question in codeable and reusable formats. As an exception, the Population specification will NOT use the EvidenceVariable Resource. The Population specification will use the Group Resource to facilitate interoperability in matching Evidence Resources to actual groups.

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

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

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. EvidenceVariable TUDomainResourceA definition of an exposure, outcome, or other variable
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the evidence variable

... version Σ0..1stringBusiness version of the evidence variable
... name ΣC0..1stringName for this evidence variable (computer friendly)
... title Σ0..1stringName for this evidence variable (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the EvidenceVariable
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental 0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description Σ0..1markdownNatural language description of the evidence variable
... note 0..*AnnotationUsed for footnotes or explanatory notes

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

... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the resource was approved by publisher
... lastReviewDate 0..1dateWhen the resource was last reviewed
... effectivePeriod 0..1PeriodWhen the resource is expected to be used
... author 0..*ContactDetailWho authored the content

... editor 0..*ContactDetailWho edited the content

... reviewer 0..*ContactDetailWho reviewed the content

... endorser 0..*ContactDetailWho endorsed the content

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.

... actual 0..1booleanActual or conceptual
... characteristic ΣC0..*BackboneElementA defining factor of the EvidenceVariable
+ Rule: In a characteristic, at most one of these seven elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionExpression or definitionId or definitionByTypeAndValue or definitionByCombination

.... linkId 0..1idLabel for internal linking
.... description 0..1stringNatural language description of the characteristic
.... note 0..*AnnotationUsed for footnotes or explanatory notes

.... exclude 0..1booleanWhether the characteristic is an inclusion criterion or exclusion criterion
.... definitionReference ΣC0..1Reference(EvidenceVariable | Group | Evidence)Defines the characteristic (without using type and value) by a Reference
.... definitionCanonical ΣC0..1canonical(EvidenceVariable | Evidence)Defines the characteristic (without using type and value) by a Canonical
.... definitionCodeableConcept ΣC0..1CodeableConceptDefines the characteristic (without using type and value) by a CodeableConcept
.... definitionExpression ΣC0..1ExpressionDefines the characteristic (without using type and value) by a Expression
.... definitionId ΣC0..1idDefines the characteristic (without using type and value) by a id
.... definitionByTypeAndValue ΣC0..1BackboneElementDefines the characteristic using type and value
..... type Σ1..1CodeableConceptExpresses the type of characteristic
UsageContextType (Example)
..... method 0..*CodeableConceptMethod for how the characteristic value was determined
DefinitionMethod (Example)

..... device 0..1Reference(Device | DeviceMetric)Device used for determining characteristic
..... value[x] Σ1..1Defines the characteristic when coupled with characteristic.type
...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
...... valueReferenceReference()
...... valueIdid
..... offset 0..1CodeableConceptReference point for valueQuantity
CharacteristicOffset (Example)
.... definitionByCombination C0..1BackboneElementUsed to specify how two or more characteristics are combined
..... code 1..1codeall-of | any-of | at-least | at-most | statistical | net-effect | dataset
CharacteristicCombination (Required)
..... threshold 0..1positiveIntProvides the value of "n" when "at-least" or "at-most" codes are used
..... characteristic 1..*see characteristicA defining factor of the characteristic

.... timeFromEvent 0..*BackboneElementObservation time from study specified event

..... description 0..1stringHuman readable description
..... note 0..*AnnotationUsed for footnotes or explanatory notes

..... event[x] 0..1The event used as a base point (reference point) in time
EvidenceVariableEvent (Example)
...... eventCodeableConceptCodeableConcept
...... eventReferenceReference()
...... eventDateTimedateTime
...... eventIdid
..... quantity 0..1QuantityUsed to express the observation at a defined amount of time after the study start
..... range 0..1RangeUsed to express the observation within a period after the study start
... handling 0..1codecontinuous | dichotomous | ordinal | polychotomous
EvidenceVariableHandling (Required)
... category 0..*BackboneElementA grouping for ordinal or polychotomous variables

.... name 0..1stringDescription of the grouping
.... value[x] 0..1Definition of the grouping
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

EvidenceVariable (DomainResource) +MetadataResourceAn 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 serversurl : uri [0..1]A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the evidence variabletitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the EvidenceVariable giving additional information about its contentsubtitle : string [0..1]The status of this evidence variable. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « 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 usageexperimental : boolean [0..1]The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variablepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the evidence variable from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcenote : Annotation [0..*]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instancesuseContext : UsageContext [0..*]A copyright statement relating to the resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resourcecopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the resource content was or is planned to be in active useeffectivePeriod : Period [0..1]An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]True if the actual variable measured, false if a conceptual representation of the intended variableactual : boolean [0..1]The method of handling in statistical analysishandling : code [0..1] « null (Strength=Required)EvidenceVariableHandling! »CharacteristicLabel used for when a characteristic refers to another characteristiclinkId : id [0..1]A short, natural language description of the characteristic that could be used to communicate the criteria to an end-userdescription : string [0..1]A human-readable string to clarify or explain concepts about the characteristicnote : Annotation [0..*]When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterionexclude : boolean [0..1]Defines the characteristic using a ReferencedefinitionReference : Reference [0..1] « EvidenceVariable|Group| Evidence » « This element has or is affected by some invariantsC »Defines the characteristic using CanonicaldefinitionCanonical : canonical [0..1] « EvidenceVariable|Evidence » « This element has or is affected by some invariantsC »Defines the characteristic using CodeableConceptdefinitionCodeableConcept : CodeableConcept [0..1] « This element has or is affected by some invariantsC »Defines the characteristic using ExpressiondefinitionExpression : Expression [0..1] « This element has or is affected by some invariantsC »Defines the characteristic using iddefinitionId : id [0..1] « This element has or is affected by some invariantsC »DefinitionByTypeAndValueUsed to express the type of characteristictype : CodeableConcept [1..1] « null (Strength=Example)UsageContextType?? »Method for how the characteristic value was determinedmethod : CodeableConcept [0..*] « null (Strength=Example)DefinitionMethod?? »Device used for determining characteristicdevice : Reference [0..1] « Device|DeviceMetric »Defines the characteristic when paired with characteristic.typevalue[x] : DataType [1..1] « CodeableConcept|boolean|Quantity|Range| Reference|id »Defines the reference point for comparison when valueQuantity is not compared to zerooffset : CodeableConcept [0..1] « null (Strength=Example)CharacteristicOffset?? »DefinitionByCombinationUsed to specify if two or more characteristics are combined with OR or ANDcode : code [1..1] « null (Strength=Required)CharacteristicCombination! »Provides the value of "n" when "at-least" or "at-most" codes are usedthreshold : positiveInt [0..1]TimeFromEventHuman readable descriptiondescription : string [0..1]A human-readable string to clarify or explain concepts about the timeFromEventnote : Annotation [0..*]The event used as a base point (reference point) in timeevent[x] : DataType [0..1] « CodeableConcept|Reference|dateTime|id; null (Strength=Example) EvidenceVariableEvent?? »Used to express the observation at a defined amount of time after the study startquantity : Quantity [0..1]Used to express the observation within a period after the study startrange : Range [0..1]CategoryDescription of the groupingname : string [0..1]Definition of the groupingvalue[x] : DataType [0..1] « CodeableConcept|Quantity|Range »Defines the characteristic using both a type and value[x] elementsdefinitionByTypeAndValue[0..1]A defining factor of the characteristiccharacteristic[1..*]Defines the characteristic as a combination of two or more characteristicsdefinitionByCombination[0..1]Observation time from study specified eventtimeFromEvent[0..*]A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semanticscharacteristic[0..*]A grouping for ordinal or polychotomous variablescategory[0..*]

XML Template

<EvidenceVariable xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the evidence variable -->
 <name value="[string]"/><!-- 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 -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable -->
 <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>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the resource was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the resource was last reviewed -->
 <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 -->
 <characteristic>  <!-- 0..* A defining factor of the EvidenceVariable -->
  <linkId value="[id]"/><!-- 0..1 Label for internal linking -->
  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion -->
  <definitionReference><!-- I 0..1 Reference(Evidence|EvidenceVariable|Group) Defines the characteristic (without using type and value) by a Reference --></definitionReference>
  <definitionCanonical><!-- I 0..1 canonical(Evidence|EvidenceVariable) Defines the characteristic (without using type and value) by a Canonical --></definitionCanonical>
  <definitionCodeableConcept><!-- I 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept --></definitionCodeableConcept>
  <definitionExpression><!-- I 0..1 Expression Defines the characteristic (without using type and value) by a Expression --></definitionExpression>
  <definitionId value="[id]"/><!-- I 0..1 Defines the characteristic (without using type and value) by a id -->
  <definitionByTypeAndValue>  <!-- I 0..1 Defines the characteristic using type and value -->
   <type><!-- 1..1 CodeableConcept Expresses the type of characteristic --></type>
   <method><!-- 0..* CodeableConcept Method for how the characteristic value was determined --></method>
   <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>
   <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference|id Defines the characteristic when coupled with characteristic.type --></value[x]>
   <offset><!-- 0..1 CodeableConcept Reference point for valueQuantity --></offset>
  </definitionByTypeAndValue>
  <definitionByCombination>  <!-- I 0..1 Used to specify how two or more characteristics are combined -->
   <code value="[code]"/><!-- 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset -->
   <threshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->
   <characteristic><!-- 1..* Content as for EvidenceVariable.characteristic A defining factor of the characteristic --></characteristic>
  </definitionByCombination>
  <timeFromEvent>  <!-- 0..* Observation time from study specified event -->
   <description value="[string]"/><!-- 0..1 Human readable description -->
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
   <event[x]><!-- 0..1 CodeableConcept|Reference|dateTime|id The event used as a base point (reference point) in time --></event[x]>
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range>
  </timeFromEvent>
 </characteristic>
 <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous -->
 <category>  <!-- 0..* A grouping for ordinal or polychotomous variables -->
  <name value="[string]"/><!-- 0..1 Description of the grouping -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range Definition of the grouping --></value[x]>
 </category>
</EvidenceVariable>

JSON Template

{doco
  "resourceType" : "EvidenceVariable",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the evidence variable
  "version" : "<string>", // Business version of the evidence variable
  "name" : "<string>", // 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
  "subtitle" : "<string>", // Subordinate title of the EvidenceVariable
  "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
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the resource was approved by publisher
  "lastReviewDate" : "<date>", // When the resource was last reviewed
  "effectivePeriod" : { Period }, // When the resource is expected to be used
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "actual" : <boolean>, // Actual or conceptual
  "characteristic" : [{ // A defining factor of the EvidenceVariable
    "linkId" : "<id>", // Label for internal linking
    "description" : "<string>", // Natural language description of the characteristic
    "note" : [{ Annotation }], // Used for footnotes or explanatory notes
    "exclude" : <boolean>, // Whether the characteristic is an inclusion criterion or exclusion criterion
    "definitionReference" : { Reference(Evidence|EvidenceVariable|Group) }, // I Defines the characteristic (without using type and value) by a Reference
    "definitionCanonical" : "<canonical(EvidenceVariable|Evidence)>", // I Defines the characteristic (without using type and value) by a Canonical
    "definitionCodeableConcept" : { CodeableConcept }, // I Defines the characteristic (without using type and value) by a CodeableConcept
    "definitionExpression" : { Expression }, // I Defines the characteristic (without using type and value) by a Expression
    "definitionId" : "<id>", // I Defines the characteristic (without using type and value) by a id
    "definitionByTypeAndValue" : { // I Defines the characteristic using type and value
      "type" : { CodeableConcept }, // R!  Expresses the type of characteristic
      "method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
      "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
      // value[x]: Defines the characteristic when coupled with characteristic.type. One of these 6:
      "valueCodeableConcept" : { CodeableConcept },
      "valueBoolean" : <boolean>,
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valueReference" : { Reference },
      "valueId" : "<id>",
      "offset" : { CodeableConcept } // Reference point for valueQuantity
    },
    "definitionByCombination" : { // I Used to specify how two or more characteristics are combined
      "code" : "<code>", // R!  all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      "threshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
      "characteristic" : [{ Content as for EvidenceVariable.characteristic }] // R!  A defining factor of the characteristic
    },
    "timeFromEvent" : [{ // Observation time from study specified event
      "description" : "<string>", // Human readable description
      "note" : [{ Annotation }], // Used for footnotes or explanatory notes
      // event[x]: The event used as a base point (reference point) in time. One of these 4:
      "eventCodeableConcept" : { CodeableConcept },
      "eventReference" : { Reference },
      "eventDateTime" : "<dateTime>",
      "eventId" : "<id>",
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start
      "range" : { Range } // Used to express the observation within a period after the study start
    }]
  }],
  "handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
  "category" : [{ // A grouping for ordinal or polychotomous variables
    "name" : "<string>", // Description of the grouping
    // value[x]: Definition of the grouping. One of these 3:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range }
  }]
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable
  fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable
  fhir:EvidenceVariable.name [ string ]; # 0..1 I 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.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed
  fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable
  fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the resource was approved by publisher
  fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the resource was last reviewed
  fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the resource is expected to be used
  fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:EvidenceVariable.actual [ boolean ]; # 0..1 Actual or conceptual
  fhir:EvidenceVariable.characteristic [ # 0..* A defining factor of the EvidenceVariable
    fhir:EvidenceVariable.characteristic.linkId [ id ]; # 0..1 Label for internal linking
    fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic
    fhir:EvidenceVariable.characteristic.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion
    fhir:EvidenceVariable.characteristic.definitionReference [ Reference(Evidence|EvidenceVariable|Group) ]; # 0..1 I Defines the characteristic (without using type and value) by a Reference
    fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Evidence|EvidenceVariable) ]; # 0..1 I Defines the characteristic (without using type and value) by a Canonical
    fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]; # 0..1 I Defines the characteristic (without using type and value) by a CodeableConcept
    fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]; # 0..1 I Defines the characteristic (without using type and value) by a Expression
    fhir:EvidenceVariable.characteristic.definitionId [ id ]; # 0..1 I Defines the characteristic (without using type and value) by a id
    fhir:EvidenceVariable.characteristic.definitionByTypeAndValue [ # 0..1 I Defines the characteristic using type and value
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.type [ CodeableConcept ]; # 1..1 Expresses the type of characteristic
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.method [ CodeableConcept ], ... ; # 0..* Method for how the characteristic value was determined
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic
      # EvidenceVariable.characteristic.definitionByTypeAndValue.value[x] : 1..1 Defines the characteristic when coupled with characteristic.type. One of these 6
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueCodeableConcept [ CodeableConcept ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueBoolean [ boolean ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueQuantity [ Quantity ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueRange [ Range ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueReference [ Reference ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueId [ id ]
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.offset [ CodeableConcept ]; # 0..1 Reference point for valueQuantity
    ];
    fhir:EvidenceVariable.characteristic.definitionByCombination [ # 0..1 I Used to specify how two or more characteristics are combined
      fhir:EvidenceVariable.characteristic.definitionByCombination.code [ code ]; # 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      fhir:EvidenceVariable.characteristic.definitionByCombination.threshold [ positiveInt ]; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used
      fhir:EvidenceVariable.characteristic.definitionByCombination.characteristic [ See EvidenceVariable.characteristic ], ... ; # 1..* A defining factor of the characteristic
    ];
    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.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
      # EvidenceVariable.characteristic.timeFromEvent.event[x] : 0..1 The event used as a base point (reference point) in time. One of these 4
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventCodeableConcept [ CodeableConcept ]
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventReference [ Reference ]
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventDateTime [ dateTime ]
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventId [ id ]
      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.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping
    # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.category.valueQuantity [ Quantity ]
      fhir:EvidenceVariable.category.valueRange [ Range ]
  ], ...;
]

Changes since R4

EvidenceVariable
EvidenceVariable.experimental
  • Added Element
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.linkId
  • Added Element
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.timeFromEvent
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.description
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.note
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.event[x]
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.range
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.topic
  • deleted
EvidenceVariable.type
  • deleted
EvidenceVariable.characteristic.definition[x]
  • deleted
EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.characteristic.participantEffective[x]
  • deleted
EvidenceVariable.characteristic.timeFromStart
  • deleted
EvidenceVariable.characteristic.groupMeasure
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. EvidenceVariable TUDomainResourceA definition of an exposure, outcome, or other variable
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC0..1uriCanonical 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..*IdentifierAdditional identifier for the evidence variable

... version Σ0..1stringBusiness version of the evidence variable
... name ΣC0..1stringName for this evidence variable (computer friendly)
... title Σ0..1stringName for this evidence variable (human friendly)
... shortTitle Σ0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the EvidenceVariable
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental 0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description Σ0..1markdownNatural language description of the evidence variable
... note 0..*AnnotationUsed for footnotes or explanatory notes

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

... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the resource was approved by publisher
... lastReviewDate 0..1dateWhen the resource was last reviewed
... effectivePeriod 0..1PeriodWhen the resource is expected to be used
... author 0..*ContactDetailWho authored the content

... editor 0..*ContactDetailWho edited the content

... reviewer 0..*ContactDetailWho reviewed the content

... endorser 0..*ContactDetailWho endorsed the content

... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.

... actual 0..1booleanActual or conceptual
... characteristic ΣC0..*BackboneElementA defining factor of the EvidenceVariable
+ Rule: In a characteristic, at most one of these seven elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionExpression or definitionId or definitionByTypeAndValue or definitionByCombination

.... linkId 0..1idLabel for internal linking
.... description 0..1stringNatural language description of the characteristic
.... note 0..*AnnotationUsed for footnotes or explanatory notes

.... exclude 0..1booleanWhether the characteristic is an inclusion criterion or exclusion criterion
.... definitionReference ΣC0..1Reference(EvidenceVariable | Group | Evidence)Defines the characteristic (without using type and value) by a Reference
.... definitionCanonical ΣC0..1canonical(EvidenceVariable | Evidence)Defines the characteristic (without using type and value) by a Canonical
.... definitionCodeableConcept ΣC0..1CodeableConceptDefines the characteristic (without using type and value) by a CodeableConcept
.... definitionExpression ΣC0..1ExpressionDefines the characteristic (without using type and value) by a Expression
.... definitionId ΣC0..1idDefines the characteristic (without using type and value) by a id
.... definitionByTypeAndValue ΣC0..1BackboneElementDefines the characteristic using type and value
..... type Σ1..1CodeableConceptExpresses the type of characteristic
UsageContextType (Example)
..... method 0..*CodeableConceptMethod for how the characteristic value was determined
DefinitionMethod (Example)

..... device 0..1Reference(Device | DeviceMetric)Device used for determining characteristic
..... value[x] Σ1..1Defines the characteristic when coupled with characteristic.type
...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
...... valueReferenceReference()
...... valueIdid
..... offset 0..1CodeableConceptReference point for valueQuantity
CharacteristicOffset (Example)
.... definitionByCombination C0..1BackboneElementUsed to specify how two or more characteristics are combined
..... code 1..1codeall-of | any-of | at-least | at-most | statistical | net-effect | dataset
CharacteristicCombination (Required)
..... threshold 0..1positiveIntProvides the value of "n" when "at-least" or "at-most" codes are used
..... characteristic 1..*see characteristicA defining factor of the characteristic

.... timeFromEvent 0..*BackboneElementObservation time from study specified event

..... description 0..1stringHuman readable description
..... note 0..*AnnotationUsed for footnotes or explanatory notes

..... event[x] 0..1The event used as a base point (reference point) in time
EvidenceVariableEvent (Example)
...... eventCodeableConceptCodeableConcept
...... eventReferenceReference()
...... eventDateTimedateTime
...... eventIdid
..... quantity 0..1QuantityUsed to express the observation at a defined amount of time after the study start
..... range 0..1RangeUsed to express the observation within a period after the study start
... handling 0..1codecontinuous | dichotomous | ordinal | polychotomous
EvidenceVariableHandling (Required)
... category 0..*BackboneElementA grouping for ordinal or polychotomous variables

.... name 0..1stringDescription of the grouping
.... value[x] 0..1Definition of the grouping
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueRangeRange

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

EvidenceVariable (DomainResource) +MetadataResourceAn 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 serversurl : uri [0..1]A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifactsversion : string [0..1]A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the evidence variabletitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the EvidenceVariable giving additional information about its contentsubtitle : string [0..1]The status of this evidence variable. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « 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 usageexperimental : boolean [0..1]The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variablepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the evidence variable from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcenote : Annotation [0..*]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instancesuseContext : UsageContext [0..*]A copyright statement relating to the resource and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the resourcecopyright : markdown [0..1]The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usageapprovalDate : date [0..1]The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval datelastReviewDate : date [0..1]The period during which the resource content was or is planned to be in active useeffectivePeriod : Period [0..1]An individiual or organization primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]True if the actual variable measured, false if a conceptual representation of the intended variableactual : boolean [0..1]The method of handling in statistical analysishandling : code [0..1] « null (Strength=Required)EvidenceVariableHandling! »CharacteristicLabel used for when a characteristic refers to another characteristiclinkId : id [0..1]A short, natural language description of the characteristic that could be used to communicate the criteria to an end-userdescription : string [0..1]A human-readable string to clarify or explain concepts about the characteristicnote : Annotation [0..*]When true, this characteristic is an exclusion criterion. In other words, not matching this characteristic definition is equivalent to meeting this criterionexclude : boolean [0..1]Defines the characteristic using a ReferencedefinitionReference : Reference [0..1] « EvidenceVariable|Group| Evidence » « This element has or is affected by some invariantsC »Defines the characteristic using CanonicaldefinitionCanonical : canonical [0..1] « EvidenceVariable|Evidence » « This element has or is affected by some invariantsC »Defines the characteristic using CodeableConceptdefinitionCodeableConcept : CodeableConcept [0..1] « This element has or is affected by some invariantsC »Defines the characteristic using ExpressiondefinitionExpression : Expression [0..1] « This element has or is affected by some invariantsC »Defines the characteristic using iddefinitionId : id [0..1] « This element has or is affected by some invariantsC »DefinitionByTypeAndValueUsed to express the type of characteristictype : CodeableConcept [1..1] « null (Strength=Example)UsageContextType?? »Method for how the characteristic value was determinedmethod : CodeableConcept [0..*] « null (Strength=Example)DefinitionMethod?? »Device used for determining characteristicdevice : Reference [0..1] « Device|DeviceMetric »Defines the characteristic when paired with characteristic.typevalue[x] : DataType [1..1] « CodeableConcept|boolean|Quantity|Range| Reference|id »Defines the reference point for comparison when valueQuantity is not compared to zerooffset : CodeableConcept [0..1] « null (Strength=Example)CharacteristicOffset?? »DefinitionByCombinationUsed to specify if two or more characteristics are combined with OR or ANDcode : code [1..1] « null (Strength=Required)CharacteristicCombination! »Provides the value of "n" when "at-least" or "at-most" codes are usedthreshold : positiveInt [0..1]TimeFromEventHuman readable descriptiondescription : string [0..1]A human-readable string to clarify or explain concepts about the timeFromEventnote : Annotation [0..*]The event used as a base point (reference point) in timeevent[x] : DataType [0..1] « CodeableConcept|Reference|dateTime|id; null (Strength=Example) EvidenceVariableEvent?? »Used to express the observation at a defined amount of time after the study startquantity : Quantity [0..1]Used to express the observation within a period after the study startrange : Range [0..1]CategoryDescription of the groupingname : string [0..1]Definition of the groupingvalue[x] : DataType [0..1] « CodeableConcept|Quantity|Range »Defines the characteristic using both a type and value[x] elementsdefinitionByTypeAndValue[0..1]A defining factor of the characteristiccharacteristic[1..*]Defines the characteristic as a combination of two or more characteristicsdefinitionByCombination[0..1]Observation time from study specified eventtimeFromEvent[0..*]A defining factor of the EvidenceVariable. Multiple characteristics are applied with "and" semanticscharacteristic[0..*]A grouping for ordinal or polychotomous variablescategory[0..*]

XML Template

<EvidenceVariable xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the evidence variable --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the evidence variable -->
 <name value="[string]"/><!-- 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 -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the EvidenceVariable -->
 <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>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the resource was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the resource was last reviewed -->
 <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 -->
 <characteristic>  <!-- 0..* A defining factor of the EvidenceVariable -->
  <linkId value="[id]"/><!-- 0..1 Label for internal linking -->
  <description value="[string]"/><!-- 0..1 Natural language description of the characteristic -->
  <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
  <exclude value="[boolean]"/><!-- 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion -->
  <definitionReference><!-- I 0..1 Reference(Evidence|EvidenceVariable|Group) Defines the characteristic (without using type and value) by a Reference --></definitionReference>
  <definitionCanonical><!-- I 0..1 canonical(Evidence|EvidenceVariable) Defines the characteristic (without using type and value) by a Canonical --></definitionCanonical>
  <definitionCodeableConcept><!-- I 0..1 CodeableConcept Defines the characteristic (without using type and value) by a CodeableConcept --></definitionCodeableConcept>
  <definitionExpression><!-- I 0..1 Expression Defines the characteristic (without using type and value) by a Expression --></definitionExpression>
  <definitionId value="[id]"/><!-- I 0..1 Defines the characteristic (without using type and value) by a id -->
  <definitionByTypeAndValue>  <!-- I 0..1 Defines the characteristic using type and value -->
   <type><!-- 1..1 CodeableConcept Expresses the type of characteristic --></type>
   <method><!-- 0..* CodeableConcept Method for how the characteristic value was determined --></method>
   <device><!-- 0..1 Reference(Device|DeviceMetric) Device used for determining characteristic --></device>
   <value[x]><!-- 1..1 CodeableConcept|boolean|Quantity|Range|Reference|id Defines the characteristic when coupled with characteristic.type --></value[x]>
   <offset><!-- 0..1 CodeableConcept Reference point for valueQuantity --></offset>
  </definitionByTypeAndValue>
  <definitionByCombination>  <!-- I 0..1 Used to specify how two or more characteristics are combined -->
   <code value="[code]"/><!-- 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset -->
   <threshold value="[positiveInt]"/><!-- 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used -->
   <characteristic><!-- 1..* Content as for EvidenceVariable.characteristic A defining factor of the characteristic --></characteristic>
  </definitionByCombination>
  <timeFromEvent>  <!-- 0..* Observation time from study specified event -->
   <description value="[string]"/><!-- 0..1 Human readable description -->
   <note><!-- 0..* Annotation Used for footnotes or explanatory notes --></note>
   <event[x]><!-- 0..1 CodeableConcept|Reference|dateTime|id The event used as a base point (reference point) in time --></event[x]>
   <quantity><!-- 0..1 Quantity Used to express the observation at a defined amount of time after the study start --></quantity>
   <range><!-- 0..1 Range Used to express the observation within a period after the study start --></range>
  </timeFromEvent>
 </characteristic>
 <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous -->
 <category>  <!-- 0..* A grouping for ordinal or polychotomous variables -->
  <name value="[string]"/><!-- 0..1 Description of the grouping -->
  <value[x]><!-- 0..1 CodeableConcept|Quantity|Range Definition of the grouping --></value[x]>
 </category>
</EvidenceVariable>

JSON Template

{doco
  "resourceType" : "EvidenceVariable",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this evidence variable, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the evidence variable
  "version" : "<string>", // Business version of the evidence variable
  "name" : "<string>", // 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
  "subtitle" : "<string>", // Subordinate title of the EvidenceVariable
  "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
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the resource was approved by publisher
  "lastReviewDate" : "<date>", // When the resource was last reviewed
  "effectivePeriod" : { Period }, // When the resource is expected to be used
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "actual" : <boolean>, // Actual or conceptual
  "characteristic" : [{ // A defining factor of the EvidenceVariable
    "linkId" : "<id>", // Label for internal linking
    "description" : "<string>", // Natural language description of the characteristic
    "note" : [{ Annotation }], // Used for footnotes or explanatory notes
    "exclude" : <boolean>, // Whether the characteristic is an inclusion criterion or exclusion criterion
    "definitionReference" : { Reference(Evidence|EvidenceVariable|Group) }, // I Defines the characteristic (without using type and value) by a Reference
    "definitionCanonical" : "<canonical(EvidenceVariable|Evidence)>", // I Defines the characteristic (without using type and value) by a Canonical
    "definitionCodeableConcept" : { CodeableConcept }, // I Defines the characteristic (without using type and value) by a CodeableConcept
    "definitionExpression" : { Expression }, // I Defines the characteristic (without using type and value) by a Expression
    "definitionId" : "<id>", // I Defines the characteristic (without using type and value) by a id
    "definitionByTypeAndValue" : { // I Defines the characteristic using type and value
      "type" : { CodeableConcept }, // R!  Expresses the type of characteristic
      "method" : [{ CodeableConcept }], // Method for how the characteristic value was determined
      "device" : { Reference(Device|DeviceMetric) }, // Device used for determining characteristic
      // value[x]: Defines the characteristic when coupled with characteristic.type. One of these 6:
      "valueCodeableConcept" : { CodeableConcept },
      "valueBoolean" : <boolean>,
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "valueReference" : { Reference },
      "valueId" : "<id>",
      "offset" : { CodeableConcept } // Reference point for valueQuantity
    },
    "definitionByCombination" : { // I Used to specify how two or more characteristics are combined
      "code" : "<code>", // R!  all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      "threshold" : "<positiveInt>", // Provides the value of "n" when "at-least" or "at-most" codes are used
      "characteristic" : [{ Content as for EvidenceVariable.characteristic }] // R!  A defining factor of the characteristic
    },
    "timeFromEvent" : [{ // Observation time from study specified event
      "description" : "<string>", // Human readable description
      "note" : [{ Annotation }], // Used for footnotes or explanatory notes
      // event[x]: The event used as a base point (reference point) in time. One of these 4:
      "eventCodeableConcept" : { CodeableConcept },
      "eventReference" : { Reference },
      "eventDateTime" : "<dateTime>",
      "eventId" : "<id>",
      "quantity" : { Quantity }, // Used to express the observation at a defined amount of time after the study start
      "range" : { Range } // Used to express the observation within a period after the study start
    }]
  }],
  "handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
  "category" : [{ // A grouping for ordinal or polychotomous variables
    "name" : "<string>", // Description of the grouping
    // value[x]: Definition of the grouping. One of these 3:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity },
    "valueRange" : { Range }
  }]
}

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:EvidenceVariable.url [ uri ]; # 0..1 Canonical identifier for this evidence variable, represented as a URI (globally unique)
  fhir:EvidenceVariable.identifier [ Identifier ], ... ; # 0..* Additional identifier for the evidence variable
  fhir:EvidenceVariable.version [ string ]; # 0..1 Business version of the evidence variable
  fhir:EvidenceVariable.name [ string ]; # 0..1 I 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.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:EvidenceVariable.date [ dateTime ]; # 0..1 Date last changed
  fhir:EvidenceVariable.publisher [ string ]; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:EvidenceVariable.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EvidenceVariable.description [ markdown ]; # 0..1 Natural language description of the evidence variable
  fhir:EvidenceVariable.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:EvidenceVariable.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EvidenceVariable.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:EvidenceVariable.approvalDate [ date ]; # 0..1 When the resource was approved by publisher
  fhir:EvidenceVariable.lastReviewDate [ date ]; # 0..1 When the resource was last reviewed
  fhir:EvidenceVariable.effectivePeriod [ Period ]; # 0..1 When the resource is expected to be used
  fhir:EvidenceVariable.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceVariable.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceVariable.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceVariable.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceVariable.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:EvidenceVariable.actual [ boolean ]; # 0..1 Actual or conceptual
  fhir:EvidenceVariable.characteristic [ # 0..* A defining factor of the EvidenceVariable
    fhir:EvidenceVariable.characteristic.linkId [ id ]; # 0..1 Label for internal linking
    fhir:EvidenceVariable.characteristic.description [ string ]; # 0..1 Natural language description of the characteristic
    fhir:EvidenceVariable.characteristic.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
    fhir:EvidenceVariable.characteristic.exclude [ boolean ]; # 0..1 Whether the characteristic is an inclusion criterion or exclusion criterion
    fhir:EvidenceVariable.characteristic.definitionReference [ Reference(Evidence|EvidenceVariable|Group) ]; # 0..1 I Defines the characteristic (without using type and value) by a Reference
    fhir:EvidenceVariable.characteristic.definitionCanonical [ canonical(Evidence|EvidenceVariable) ]; # 0..1 I Defines the characteristic (without using type and value) by a Canonical
    fhir:EvidenceVariable.characteristic.definitionCodeableConcept [ CodeableConcept ]; # 0..1 I Defines the characteristic (without using type and value) by a CodeableConcept
    fhir:EvidenceVariable.characteristic.definitionExpression [ Expression ]; # 0..1 I Defines the characteristic (without using type and value) by a Expression
    fhir:EvidenceVariable.characteristic.definitionId [ id ]; # 0..1 I Defines the characteristic (without using type and value) by a id
    fhir:EvidenceVariable.characteristic.definitionByTypeAndValue [ # 0..1 I Defines the characteristic using type and value
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.type [ CodeableConcept ]; # 1..1 Expresses the type of characteristic
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.method [ CodeableConcept ], ... ; # 0..* Method for how the characteristic value was determined
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.device [ Reference(Device|DeviceMetric) ]; # 0..1 Device used for determining characteristic
      # EvidenceVariable.characteristic.definitionByTypeAndValue.value[x] : 1..1 Defines the characteristic when coupled with characteristic.type. One of these 6
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueCodeableConcept [ CodeableConcept ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueBoolean [ boolean ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueQuantity [ Quantity ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueRange [ Range ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueReference [ Reference ]
        fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.valueId [ id ]
      fhir:EvidenceVariable.characteristic.definitionByTypeAndValue.offset [ CodeableConcept ]; # 0..1 Reference point for valueQuantity
    ];
    fhir:EvidenceVariable.characteristic.definitionByCombination [ # 0..1 I Used to specify how two or more characteristics are combined
      fhir:EvidenceVariable.characteristic.definitionByCombination.code [ code ]; # 1..1 all-of | any-of | at-least | at-most | statistical | net-effect | dataset
      fhir:EvidenceVariable.characteristic.definitionByCombination.threshold [ positiveInt ]; # 0..1 Provides the value of "n" when "at-least" or "at-most" codes are used
      fhir:EvidenceVariable.characteristic.definitionByCombination.characteristic [ See EvidenceVariable.characteristic ], ... ; # 1..* A defining factor of the characteristic
    ];
    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.note [ Annotation ], ... ; # 0..* Used for footnotes or explanatory notes
      # EvidenceVariable.characteristic.timeFromEvent.event[x] : 0..1 The event used as a base point (reference point) in time. One of these 4
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventCodeableConcept [ CodeableConcept ]
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventReference [ Reference ]
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventDateTime [ dateTime ]
        fhir:EvidenceVariable.characteristic.timeFromEvent.eventId [ id ]
      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.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous
  fhir:EvidenceVariable.category [ # 0..* A grouping for ordinal or polychotomous variables
    fhir:EvidenceVariable.category.name [ string ]; # 0..1 Description of the grouping
    # EvidenceVariable.category.value[x] : 0..1 Definition of the grouping. One of these 3
      fhir:EvidenceVariable.category.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceVariable.category.valueQuantity [ Quantity ]
      fhir:EvidenceVariable.category.valueRange [ Range ]
  ], ...;
]

Changes since Release 4

EvidenceVariable
EvidenceVariable.experimental
  • Added Element
EvidenceVariable.actual
  • Added Element
EvidenceVariable.characteristic
  • Min Cardinality changed from 1 to 0
  • Min Cardinality changed from 1 to 0
EvidenceVariable.characteristic.linkId
  • Added Element
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.timeFromEvent
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.description
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.note
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.event[x]
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.quantity
  • Added Element
EvidenceVariable.characteristic.timeFromEvent.range
  • Added Element
EvidenceVariable.handling
  • Added Element
EvidenceVariable.category
  • Added Element
EvidenceVariable.category.name
  • Added Element
EvidenceVariable.category.value[x]
  • Added Element
EvidenceVariable.jurisdiction
  • deleted
EvidenceVariable.topic
  • deleted
EvidenceVariable.type
  • deleted
EvidenceVariable.characteristic.definition[x]
  • deleted
EvidenceVariable.characteristic.usageContext
  • deleted
EvidenceVariable.characteristic.participantEffective[x]
  • deleted
EvidenceVariable.characteristic.timeFromStart
  • deleted
EvidenceVariable.characteristic.groupMeasure
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

 

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

PathDefinitionTypeReference
EvidenceVariable.status

The lifecycle status of an artifact.

RequiredPublicationStatus
EvidenceVariable.characteristic.definitionByTypeAndValue.type

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

ExampleUsageContextType
EvidenceVariable.characteristic.definitionByTypeAndValue.method

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

ExampleDefinitionMethod
EvidenceVariable.characteristic.definitionByTypeAndValue.offset

Reference point for characteristic.valueQuantity.

ExampleCharacteristicOffset
EvidenceVariable.characteristic.definitionByCombination.code

Logical grouping of characteristics.

RequiredCharacteristicCombination
EvidenceVariable.characteristic.timeFromEvent.event[x]

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

ExampleEvidenceVariableEvent
EvidenceVariable.handling

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

RequiredEvidenceVariableHandling

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
img cnl-1Warning EvidenceVariable.urlURL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
img evv-1Rule EvidenceVariable.characteristicIn a characteristic, at most one of these seven elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionExpression or definitionId or definitionByTypeAndValue or definitionByCombination(definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionExpression.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count()) < 2

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

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='composed-of').resource
(Any)
contexttokenA use context assigned to the evidence variable(EvidenceVariable.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the evidence variable(EvidenceVariable.useContext.value as Quantity) | (EvidenceVariable.useContext.value as Range)
context-typetokenA type of use context assigned to the evidence variableEvidenceVariable.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the evidence variableOn EvidenceVariable.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)
context-type-valuecompositeA use context type and value assigned to the evidence variableOn EvidenceVariable.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)
date NdateThe evidence variable publication dateEvidenceVariable.date
depends-onreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='depends-on').resource
(Any)
derived-fromreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='derived-from').resource
(Any)
description NstringThe description of the evidence variableEvidenceVariable.description
identifiertokenExternal identifier for the evidence variableEvidenceVariable.identifier
name NstringComputationally friendly name of the evidence variableEvidenceVariable.name
predecessorreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='predecessor').resource
(Any)
publisher NstringName of the publisher of the evidence variableEvidenceVariable.publisher
status NtokenThe current status of the evidence variableEvidenceVariable.status
successorreferenceWhat resource is being referencedEvidenceVariable.relatedArtifact.where(type='successor').resource
(Any)
title NstringThe human-friendly name of the evidence variableEvidenceVariable.title
topictokenTopics associated with the EvidenceVariable
url NuriThe uri that identifies the evidence variableEvidenceVariable.url
version NtokenThe business version of the evidence variableEvidenceVariable.version