Release 5 Ballot
Clinical ReasoningThis page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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
| Clinical Decision Support Work Group | Maturity Level: 1 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
The Evidence Resource provides a machine-interpretable expression of an evidence concept including the evidence variables (e.g., population, exposures/interventions, comparators, outcomes, measured variables, confounding variables), the statistics, and the certainty of this evidence.
The Evidence Resource enables the expression of the most granular form of evidence, such as the actual quantitative results of a study or scientific analysis.
Human-readable summaries of the Evidence Resource may be expressed in description, assertion, and note elements. The description element is typically used for the primary expression. The assertion element is less commonly used and is typically used for interpretive expression. The note element may be used for any number of explanatory, variant, or related comments.
The variableDefinition element is used to describe what the evidence is about. Each variable defined must be assigned a variable role which signals how that variable is used in the statistics within the Evidence Resource. The variable definition may be expressed in human-readable form (with a description element) and/or expressed in computable form by referencing Group or EvidenceVariable Resources. In general, Group Resources are used to define populations and EvidenceVariable Resources are used to define exposures and measured variables. The variableDefinition elements allows expression of the observed variable and the intended variable. In many forms of expression the Evidence is interpreted for a specific context and recognition of both observed and intended variables is important for understanding the applicability and certainty of the evidence.
The heart of the evidence is the statistic. The statistic BackboneElement provides a machine-interpretable expression of a statistic, including the quantity; unit of measure; classification of statistic type; sample size; attributes such as confidence intervals, p values, and heterogeneity estimates; and statistic model characteristics. An Evidence Resource may contain more than one statistic, in which case each statistic matches the same combination of variable definitions.
Because a statistic can rarely be interpreted without knowing how it was obtained, the Evidence Resource enables expression of the studyType. For evidence derived from synthesis of evidence, the Evidence Resource enables expression of the synthesisType.
The certainty Element provides a machine-interpretable expression of certainty, confidence or quality of the resource in which it is included. The certainty Element can express overall certainty and certainty of any subcomponent concepts using codeable concepts from structured rating systems. The certainty Element enables machine-to-machine communication of the certainty of evidence.
The Evidence Resource is the central atomic component for the Evidence-related Resources. The Evidence Resource may reference multiple Group and EvidenceVariable Resources; in these cases, the Group and EvidenceVariable Resources to which an Evidence Resource points does not refer back to the Evidence. In the context of evidence synthesis, an EvidenceVariable Resource may reference Evidence Resources where the EvidenceVariable Resource is used to define the set of evidence being synthesized.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Evidence | TU | DomainResource | Single evidence bit + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
  url | ΣC | 0..1 | uri | Canonical identifier for this evidence, represented as a globally unique URI + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
 identifier | Σ | 0..* | Identifier | Additional identifier for the summary |
| version | Σ | 0..1 | string | Business version of this summary |
| name | C | 0..1 | string | Name for this summary (machine friendly) |
| title | Σ | 0..1 | string | Name for this summary (human friendly) |
  citeAs[x] | 0..1 | Citation for this evidence | ||
  citeAsReference | Reference(Citation) | |||
 citeAsMarkdown | markdown | |||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
| experimental | 0..1 | boolean | For testing purposes, not real usage | |
| date | Σ | 0..1 | dateTime | Date last changed |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| approvalDate | 0..1 | date | When the summary was approved by publisher | |
| lastReviewDate | 0..1 | date | When the summary was last reviewed | |
| publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| author | Σ | 0..* | ContactDetail | Who authored the content |
| editor | 0..* | ContactDetail | Who edited the content | |
| reviewer | 0..* | ContactDetail | Who reviewed the content | |
| endorser | Σ | 0..* | ContactDetail | Who endorsed the content |
| relatedArtifact | 0..* | RelatedArtifact | Link or citation to artifact associated with the summary | |
| description | 0..1 | markdown | Description of the particular summary | |
| assertion | 0..1 | markdown | Declarative description of the Evidence | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
 variableDefinition | 1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| description | 0..1 | markdown | A text description or summary of the variable | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
| variableRole | Σ | 1..1 | CodeableConcept | population | subpopulation | exposure | referenceExposure | measuredVariable | confounder EvidenceVariableRole (Extensible) |
| observed | Σ | 0..1 | Reference(Group | EvidenceVariable) | Definition of the actual variable related to the statistic(s) |
| intended | 0..1 | Reference(Group | EvidenceVariable) | Definition of the intended variable related to the Evidence | |
| directnessMatch | 0..1 | CodeableConcept | low | moderate | high | exact EvidenceDirectness (Extensible) | |
| synthesisType | 0..1 | CodeableConcept | The method to combine studies SynthesisType (Extensible) | |
| studyDesign | 0..* | CodeableConcept | The design of the study that produced this evidence Study Design (Extensible) | |
| statistic | 0..* | BackboneElement | Values and parameters for a single statistic | |
| description | 0..1 | string | Description of content | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
| statisticType | 0..1 | CodeableConcept | Type of statistic, e.g., relative risk StatisticType (Extensible) | |
| category | 0..1 | CodeableConcept | Associated category for categorical variable | |
| quantity | 0..1 | Quantity | Statistic value | |
| numberOfEvents | 0..1 | unsignedInt | The number of events associated with the statistic | |
| numberAffected | 0..1 | unsignedInt | The number of participants affected | |
| sampleSize | 0..1 | BackboneElement | Number of samples in the statistic | |
| description | 0..1 | string | Textual description of sample size for statistic | |
| note | 0..* | Annotation | Footnote or explanatory note about the sample size | |
| numberOfStudies | 0..1 | unsignedInt | Number of contributing studies | |
| numberOfParticipants | 0..1 | unsignedInt | Cumulative number of participants | |
| knownDataCount | 0..1 | unsignedInt | Number of participants with known results for measured variables | |
| attributeEstimate | 0..* | BackboneElement | An attribute of the Statistic | |
| description | 0..1 | string | Textual description of the attribute estimate | |
| note | 0..* | Annotation | Footnote or explanatory note about the estimate | |
| type | 0..1 | CodeableConcept | The type of attribute estimate, e.g., confidence interval or p value AttributeEstimateType (Extensible) | |
| quantity | 0..1 | Quantity | The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure | |
| level | 0..1 | decimal | Level of confidence interval, e.g., 0.95 for 95% confidence interval | |
| range | 0..1 | Range | Lower and upper bound values of the attribute estimate | |
 attributeEstimate | 0..* | see attributeEstimate | A nested attribute estimate; which is the attribute estimate of an attribute estimate | |
 modelCharacteristic | 0..* | BackboneElement | An aspect of the statistical model | |
 code | 1..1 | CodeableConcept | Model specification StatisticModelCode (Extensible) | |
| value | 0..1 | SimpleQuantity | Numerical value to complete model specification | |
| variable | 0..* | BackboneElement | A variable adjusted for in the adjusted analysis | |
| variableDefinition | 1..1 | Reference(Group | EvidenceVariable) | Description of the variable | |
| handling | 0..1 | code | continuous | dichotomous | ordinal | polychotomous EvidenceVariableHandling (Required) | |
| valueCategory | 0..* | CodeableConcept | Description for grouping of ordinal or polychotomous variables | |
| valueQuantity | 0..* | Quantity | Discrete value for grouping of ordinal or polychotomous variables | |
| valueRange | 0..* | Range | Range of values for grouping of ordinal or polychotomous variables | |
| attributeEstimate | 0..* | see attributeEstimate | An attribute of the statistic used as a model characteristic | |
| certainty | 0..* | BackboneElement | Certainty or quality of the evidence | |
| description | 0..1 | string | Textual description of certainty | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
| type | 0..1 | CodeableConcept | Aspect of certainty being rated EvidenceCertaintyType (Extensible) | |
| rating | 0..1 | CodeableConcept | Assessment or judgement of the aspect EvidenceCertaintyRating (Extensible) | |
| rater | 0..1 | string | Individual or group who did the rating | |
| subcomponent | 0..* | see certainty | A domain or subdomain of certainty | |
| Documentation for this format | ||||
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<Evidence xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this evidence, represented as a globally unique URI --> <identifier><!-- 0..* Identifier Additional identifier for the summary --></identifier> <version value="[string]"/><!-- 0..1 Business version of this summary --> <name value="[string]"/><!-- I 0..1 Name for this summary (machine friendly) --> <title value="[string]"/><!-- 0..1 Name for this summary (human friendly) --> <citeAs[x]><!-- 0..1 Reference(Citation)|markdown Citation for this evidence --></citeAs[x]> <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 --> <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <approvalDate value="[date]"/><!-- 0..1 When the summary was approved by publisher --> <lastReviewDate value="[date]"/><!-- 0..1 When the summary was last reviewed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (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 Link or citation to artifact associated with the summary --></relatedArtifact> <description value="[markdown]"/><!-- 0..1 Description of the particular summary --> <assertion value="[markdown]"/><!-- 0..1 Declarative description of the Evidence --> <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note> <variableDefinition> <!-- 1..* Evidence variable such as population, exposure, or outcome --> <description value="[markdown]"/><!-- 0..1 A text description or summary of the variable --> <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note> <variableRole><!-- 1..1 CodeableConcept population | subpopulation | exposure | referenceExposure | measuredVariable | confounder --></variableRole> <observed><!-- 0..1 Reference(EvidenceVariable|Group) Definition of the actual variable related to the statistic(s) --></observed> <intended><!-- 0..1 Reference(EvidenceVariable|Group) Definition of the intended variable related to the Evidence --></intended> <directnessMatch><!-- 0..1 CodeableConcept low | moderate | high | exact --></directnessMatch> </variableDefinition> <synthesisType><!-- 0..1 CodeableConcept The method to combine studies --></synthesisType> <studyDesign><!-- 0..* CodeableConcept The design of the study that produced this evidence --></studyDesign> <statistic> <!-- 0..* Values and parameters for a single statistic --> <description value="[string]"/><!-- 0..1 Description of content --> <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note> <statisticType><!-- 0..1 CodeableConcept Type of statistic, e.g., relative risk --></statisticType> <category><!-- 0..1 CodeableConcept Associated category for categorical variable --></category> <quantity><!-- 0..1 Quantity Statistic value --></quantity> <numberOfEvents value="[unsignedInt]"/><!-- 0..1 The number of events associated with the statistic --> <numberAffected value="[unsignedInt]"/><!-- 0..1 The number of participants affected --> <sampleSize> <!-- 0..1 Number of samples in the statistic --> <description value="[string]"/><!-- 0..1 Textual description of sample size for statistic --> <note><!-- 0..* Annotation Footnote or explanatory note about the sample size --></note> <numberOfStudies value="[unsignedInt]"/><!-- 0..1 Number of contributing studies --> <numberOfParticipants value="[unsignedInt]"/><!-- 0..1 Cumulative number of participants --> <knownDataCount value="[unsignedInt]"/><!-- 0..1 Number of participants with known results for measured variables --> </sampleSize> <attributeEstimate> <!-- 0..* An attribute of the Statistic --> <description value="[string]"/><!-- 0..1 Textual description of the attribute estimate --> <note><!-- 0..* Annotation Footnote or explanatory note about the estimate --></note> <type><!-- 0..1 CodeableConcept The type of attribute estimate, e.g., confidence interval or p value --></type> <quantity><!-- 0..1 Quantity The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure --></quantity> <level value="[decimal]"/><!-- 0..1 Level of confidence interval, e.g., 0.95 for 95% confidence interval --> <range><!-- 0..1 Range Lower and upper bound values of the attribute estimate --></range> <attributeEstimate><!-- 0..* Content as for Evidence.statistic.attributeEstimate A nested attribute estimate; which is the attribute estimate of an attribute estimate --></attributeEstimate> </attributeEstimate> <modelCharacteristic> <!-- 0..* An aspect of the statistical model --> <code><!-- 1..1 CodeableConcept Model specification --></code> <value><!-- 0..1 Quantity(SimpleQuantity) Numerical value to complete model specification --></value> <variable> <!-- 0..* A variable adjusted for in the adjusted analysis --> <variableDefinition><!-- 1..1 Reference(EvidenceVariable|Group) Description of the variable --></variableDefinition> <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous --> <valueCategory><!-- 0..* CodeableConcept Description for grouping of ordinal or polychotomous variables --></valueCategory> <valueQuantity><!-- 0..* Quantity Discrete value for grouping of ordinal or polychotomous variables --></valueQuantity> <valueRange><!-- 0..* Range Range of values for grouping of ordinal or polychotomous variables --></valueRange> </variable> <attributeEstimate><!-- 0..* Content as for Evidence.statistic.attributeEstimate An attribute of the statistic used as a model characteristic --></attributeEstimate> </modelCharacteristic> </statistic> <certainty> <!-- 0..* Certainty or quality of the evidence --> <description value="[string]"/><!-- 0..1 Textual description of certainty --> <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note> <type><!-- 0..1 CodeableConcept Aspect of certainty being rated --></type> <rating><!-- 0..1 CodeableConcept Assessment or judgement of the aspect --></rating> <rater value="[string]"/><!-- 0..1 Individual or group who did the rating --> <subcomponent><!-- 0..* Content as for Evidence.certainty A domain or subdomain of certainty --></subcomponent> </certainty> </Evidence>
JSON Template
{
"resourceType" : "Evidence",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this evidence, represented as a globally unique URI
"identifier" : [{ Identifier }], // Additional identifier for the summary
"version" : "<string>", // Business version of this summary
"name" : "<string>", // I Name for this summary (machine friendly)
"title" : "<string>", // Name for this summary (human friendly)
// citeAs[x]: Citation for this evidence. One of these 2:
"citeAsReference" : { Reference(Citation) },
"citeAsMarkdown" : "<markdown>",
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"approvalDate" : "<date>", // When the summary was approved by publisher
"lastReviewDate" : "<date>", // When the summary was last reviewed
"publisher" : "<string>", // Name of the publisher/steward (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 }], // Link or citation to artifact associated with the summary
"description" : "<markdown>", // Description of the particular summary
"assertion" : "<markdown>", // Declarative description of the Evidence
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"variableDefinition" : [{ // R! Evidence variable such as population, exposure, or outcome
"description" : "<markdown>", // A text description or summary of the variable
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"variableRole" : { CodeableConcept }, // R! population | subpopulation | exposure | referenceExposure | measuredVariable | confounder
"observed" : { Reference(EvidenceVariable|Group) }, // Definition of the actual variable related to the statistic(s)
"intended" : { Reference(EvidenceVariable|Group) }, // Definition of the intended variable related to the Evidence
"directnessMatch" : { CodeableConcept } // low | moderate | high | exact
}],
"synthesisType" : { CodeableConcept }, // The method to combine studies
"studyDesign" : [{ CodeableConcept }], // The design of the study that produced this evidence
"statistic" : [{ // Values and parameters for a single statistic
"description" : "<string>", // Description of content
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"statisticType" : { CodeableConcept }, // Type of statistic, e.g., relative risk
"category" : { CodeableConcept }, // Associated category for categorical variable
"quantity" : { Quantity }, // Statistic value
"numberOfEvents" : "<unsignedInt>", // The number of events associated with the statistic
"numberAffected" : "<unsignedInt>", // The number of participants affected
"sampleSize" : { // Number of samples in the statistic
"description" : "<string>", // Textual description of sample size for statistic
"note" : [{ Annotation }], // Footnote or explanatory note about the sample size
"numberOfStudies" : "<unsignedInt>", // Number of contributing studies
"numberOfParticipants" : "<unsignedInt>", // Cumulative number of participants
"knownDataCount" : "<unsignedInt>" // Number of participants with known results for measured variables
},
"attributeEstimate" : [{ // An attribute of the Statistic
"description" : "<string>", // Textual description of the attribute estimate
"note" : [{ Annotation }], // Footnote or explanatory note about the estimate
"type" : { CodeableConcept }, // The type of attribute estimate, e.g., confidence interval or p value
"quantity" : { Quantity }, // The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
"level" : <decimal>, // Level of confidence interval, e.g., 0.95 for 95% confidence interval
"range" : { Range }, // Lower and upper bound values of the attribute estimate
"attributeEstimate" : [{ Content as for Evidence.statistic.attributeEstimate }] // A nested attribute estimate; which is the attribute estimate of an attribute estimate
}],
"modelCharacteristic" : [{ // An aspect of the statistical model
"code" : { CodeableConcept }, // R! Model specification
"value" : { Quantity(SimpleQuantity) }, // Numerical value to complete model specification
"variable" : [{ // A variable adjusted for in the adjusted analysis
"variableDefinition" : { Reference(EvidenceVariable|Group) }, // R! Description of the variable
"handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
"valueCategory" : [{ CodeableConcept }], // Description for grouping of ordinal or polychotomous variables
"valueQuantity" : [{ Quantity }], // Discrete value for grouping of ordinal or polychotomous variables
"valueRange" : [{ Range }] // Range of values for grouping of ordinal or polychotomous variables
}],
"attributeEstimate" : [{ Content as for Evidence.statistic.attributeEstimate }] // An attribute of the statistic used as a model characteristic
}]
}],
"certainty" : [{ // Certainty or quality of the evidence
"description" : "<string>", // Textual description of certainty
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"type" : { CodeableConcept }, // Aspect of certainty being rated
"rating" : { CodeableConcept }, // Assessment or judgement of the aspect
"rater" : "<string>", // Individual or group who did the rating
"subcomponent" : [{ Content as for Evidence.certainty }] // A domain or subdomain of certainty
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since R4
| Evidence | |
| Evidence.citeAs[x] |
|
| Evidence.experimental |
|
| Evidence.assertion |
|
| Evidence.variableDefinition |
|
| Evidence.variableDefinition.description |
|
| Evidence.variableDefinition.note |
|
| Evidence.variableDefinition.variableRole |
|
| Evidence.variableDefinition.observed |
|
| Evidence.variableDefinition.intended |
|
| Evidence.variableDefinition.directnessMatch |
|
| Evidence.synthesisType |
|
| Evidence.studyDesign |
|
| Evidence.statistic |
|
| Evidence.statistic.description |
|
| Evidence.statistic.note |
|
| Evidence.statistic.statisticType |
|
| Evidence.statistic.category |
|
| Evidence.statistic.quantity |
|
| Evidence.statistic.numberOfEvents |
|
| Evidence.statistic.numberAffected |
|
| Evidence.statistic.sampleSize |
|
| Evidence.statistic.sampleSize.description |
|
| Evidence.statistic.sampleSize.note |
|
| Evidence.statistic.sampleSize.numberOfStudies |
|
| Evidence.statistic.sampleSize.numberOfParticipants |
|
| Evidence.statistic.sampleSize.knownDataCount |
|
| Evidence.statistic.attributeEstimate |
|
| Evidence.statistic.attributeEstimate.description |
|
| Evidence.statistic.attributeEstimate.note |
|
| Evidence.statistic.attributeEstimate.type |
|
| Evidence.statistic.attributeEstimate.quantity |
|
| Evidence.statistic.attributeEstimate.level |
|
| Evidence.statistic.attributeEstimate.range |
|
| Evidence.statistic.attributeEstimate.attributeEstimate |
|
| Evidence.statistic.modelCharacteristic |
|
| Evidence.statistic.modelCharacteristic.code |
|
| Evidence.statistic.modelCharacteristic.value |
|
| Evidence.statistic.modelCharacteristic.variable |
|
| Evidence.statistic.modelCharacteristic.variable.variableDefinition |
|
| Evidence.statistic.modelCharacteristic.variable.handling |
|
| Evidence.statistic.modelCharacteristic.variable.valueCategory |
|
| Evidence.statistic.modelCharacteristic.variable.valueQuantity |
|
| Evidence.statistic.modelCharacteristic.variable.valueRange |
|
| Evidence.statistic.modelCharacteristic.attributeEstimate |
|
| Evidence.certainty |
|
| Evidence.certainty.description |
|
| Evidence.certainty.note |
|
| Evidence.certainty.type |
|
| Evidence.certainty.rating |
|
| Evidence.certainty.rater |
|
| Evidence.certainty.subcomponent |
|
| Evidence.shortTitle |
|
| Evidence.subtitle |
|
| Evidence.jurisdiction |
|
| Evidence.copyright |
|
| Evidence.effectivePeriod |
|
| Evidence.topic |
|
| Evidence.exposureBackground |
|
| Evidence.exposureVariant |
|
| Evidence.outcome |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Evidence | TU | DomainResource | Single evidence bit + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | |
| url | ΣC | 0..1 | uri | Canonical identifier for this evidence, represented as a globally unique URI + Warning: URL should not contain | or # - these characters make processing canonical references problematic |
| identifier | Σ | 0..* | Identifier | Additional identifier for the summary |
| version | Σ | 0..1 | string | Business version of this summary |
| name | C | 0..1 | string | Name for this summary (machine friendly) |
| title | Σ | 0..1 | string | Name for this summary (human friendly) |
| citeAs[x] | 0..1 | Citation for this evidence | ||
| citeAsReference | Reference(Citation) | |||
| citeAsMarkdown | markdown | |||
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
| experimental | 0..1 | boolean | For testing purposes, not real usage | |
| date | Σ | 0..1 | dateTime | Date last changed |
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
| approvalDate | 0..1 | date | When the summary was approved by publisher | |
| lastReviewDate | 0..1 | date | When the summary was last reviewed | |
| publisher | Σ | 0..1 | string | Name of the publisher/steward (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| author | Σ | 0..* | ContactDetail | Who authored the content |
| editor | 0..* | ContactDetail | Who edited the content | |
| reviewer | 0..* | ContactDetail | Who reviewed the content | |
| endorser | Σ | 0..* | ContactDetail | Who endorsed the content |
| relatedArtifact | 0..* | RelatedArtifact | Link or citation to artifact associated with the summary | |
| description | 0..1 | markdown | Description of the particular summary | |
| assertion | 0..1 | markdown | Declarative description of the Evidence | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
| variableDefinition | 1..* | BackboneElement | Evidence variable such as population, exposure, or outcome | |
| description | 0..1 | markdown | A text description or summary of the variable | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
| variableRole | Σ | 1..1 | CodeableConcept | population | subpopulation | exposure | referenceExposure | measuredVariable | confounder EvidenceVariableRole (Extensible) |
| observed | Σ | 0..1 | Reference(Group | EvidenceVariable) | Definition of the actual variable related to the statistic(s) |
| intended | 0..1 | Reference(Group | EvidenceVariable) | Definition of the intended variable related to the Evidence | |
| directnessMatch | 0..1 | CodeableConcept | low | moderate | high | exact EvidenceDirectness (Extensible) | |
| synthesisType | 0..1 | CodeableConcept | The method to combine studies SynthesisType (Extensible) | |
| studyDesign | 0..* | CodeableConcept | The design of the study that produced this evidence Study Design (Extensible) | |
| statistic | 0..* | BackboneElement | Values and parameters for a single statistic | |
| description | 0..1 | string | Description of content | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
| statisticType | 0..1 | CodeableConcept | Type of statistic, e.g., relative risk StatisticType (Extensible) | |
| category | 0..1 | CodeableConcept | Associated category for categorical variable | |
| quantity | 0..1 | Quantity | Statistic value | |
| numberOfEvents | 0..1 | unsignedInt | The number of events associated with the statistic | |
| numberAffected | 0..1 | unsignedInt | The number of participants affected | |
| sampleSize | 0..1 | BackboneElement | Number of samples in the statistic | |
| description | 0..1 | string | Textual description of sample size for statistic | |
| note | 0..* | Annotation | Footnote or explanatory note about the sample size | |
| numberOfStudies | 0..1 | unsignedInt | Number of contributing studies | |
| numberOfParticipants | 0..1 | unsignedInt | Cumulative number of participants | |
| knownDataCount | 0..1 | unsignedInt | Number of participants with known results for measured variables | |
| attributeEstimate | 0..* | BackboneElement | An attribute of the Statistic | |
| description | 0..1 | string | Textual description of the attribute estimate | |
| note | 0..* | Annotation | Footnote or explanatory note about the estimate | |
| type | 0..1 | CodeableConcept | The type of attribute estimate, e.g., confidence interval or p value AttributeEstimateType (Extensible) | |
| quantity | 0..1 | Quantity | The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure | |
| level | 0..1 | decimal | Level of confidence interval, e.g., 0.95 for 95% confidence interval | |
| range | 0..1 | Range | Lower and upper bound values of the attribute estimate | |
| attributeEstimate | 0..* | see attributeEstimate | A nested attribute estimate; which is the attribute estimate of an attribute estimate | |
| modelCharacteristic | 0..* | BackboneElement | An aspect of the statistical model | |
| code | 1..1 | CodeableConcept | Model specification StatisticModelCode (Extensible) | |
| value | 0..1 | SimpleQuantity | Numerical value to complete model specification | |
| variable | 0..* | BackboneElement | A variable adjusted for in the adjusted analysis | |
| variableDefinition | 1..1 | Reference(Group | EvidenceVariable) | Description of the variable | |
| handling | 0..1 | code | continuous | dichotomous | ordinal | polychotomous EvidenceVariableHandling (Required) | |
| valueCategory | 0..* | CodeableConcept | Description for grouping of ordinal or polychotomous variables | |
| valueQuantity | 0..* | Quantity | Discrete value for grouping of ordinal or polychotomous variables | |
| valueRange | 0..* | Range | Range of values for grouping of ordinal or polychotomous variables | |
| attributeEstimate | 0..* | see attributeEstimate | An attribute of the statistic used as a model characteristic | |
| certainty | 0..* | BackboneElement | Certainty or quality of the evidence | |
| description | 0..1 | string | Textual description of certainty | |
| note | 0..* | Annotation | Footnotes and/or explanatory notes | |
| type | 0..1 | CodeableConcept | Aspect of certainty being rated EvidenceCertaintyType (Extensible) | |
| rating | 0..1 | CodeableConcept | Assessment or judgement of the aspect EvidenceCertaintyRating (Extensible) | |
| rater | 0..1 | string | Individual or group who did the rating | |
| subcomponent | 0..* | see certainty | A domain or subdomain of certainty | |
| Documentation for this format | ||||
See the Extensions for this resource
XML Template
<Evidence xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "Evidence",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this evidence, represented as a globally unique URI
"identifier" : [{ Identifier }], // Additional identifier for the summary
"version" : "<string>", // Business version of this summary
"name" : "<string>", // I Name for this summary (machine friendly)
"title" : "<string>", // Name for this summary (human friendly)
// citeAs[x]: Citation for this evidence. One of these 2:
"citeAsReference" : { Reference(Citation) },
"citeAsMarkdown" : "<markdown>",
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date last changed
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"approvalDate" : "<date>", // When the summary was approved by publisher
"lastReviewDate" : "<date>", // When the summary was last reviewed
"publisher" : "<string>", // Name of the publisher/steward (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 }], // Link or citation to artifact associated with the summary
"description" : "<markdown>", // Description of the particular summary
"assertion" : "<markdown>", // Declarative description of the Evidence
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"variableDefinition" : [{ // R! Evidence variable such as population, exposure, or outcome
"description" : "<markdown>", // A text description or summary of the variable
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"variableRole" : { CodeableConcept }, // R! population | subpopulation | exposure | referenceExposure | measuredVariable | confounder
"observed" : { Reference(EvidenceVariable|Group) }, // Definition of the actual variable related to the statistic(s)
"intended" : { Reference(EvidenceVariable|Group) }, // Definition of the intended variable related to the Evidence
"directnessMatch" : { CodeableConcept } // low | moderate | high | exact
}],
"synthesisType" : { CodeableConcept }, // The method to combine studies
"studyDesign" : [{ CodeableConcept }], // The design of the study that produced this evidence
"statistic" : [{ // Values and parameters for a single statistic
"description" : "<string>", // Description of content
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"statisticType" : { CodeableConcept }, // Type of statistic, e.g., relative risk
"category" : { CodeableConcept }, // Associated category for categorical variable
"quantity" : { Quantity }, // Statistic value
"numberOfEvents" : "<unsignedInt>", // The number of events associated with the statistic
"numberAffected" : "<unsignedInt>", // The number of participants affected
"sampleSize" : { // Number of samples in the statistic
"description" : "<string>", // Textual description of sample size for statistic
"note" : [{ Annotation }], // Footnote or explanatory note about the sample size
"numberOfStudies" : "<unsignedInt>", // Number of contributing studies
"numberOfParticipants" : "<unsignedInt>", // Cumulative number of participants
"knownDataCount" : "<unsignedInt>" // Number of participants with known results for measured variables
},
"attributeEstimate" : [{ // An attribute of the Statistic
"description" : "<string>", // Textual description of the attribute estimate
"note" : [{ Annotation }], // Footnote or explanatory note about the estimate
"type" : { CodeableConcept }, // The type of attribute estimate, e.g., confidence interval or p value
"quantity" : { Quantity }, // The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
"level" : <decimal>, // Level of confidence interval, e.g., 0.95 for 95% confidence interval
"range" : { Range }, // Lower and upper bound values of the attribute estimate
"attributeEstimate" : [{ Content as for Evidence.statistic.attributeEstimate }] // A nested attribute estimate; which is the attribute estimate of an attribute estimate
}],
"modelCharacteristic" : [{ // An aspect of the statistical model
"code" : { CodeableConcept }, // R! Model specification
"value" : { Quantity(SimpleQuantity) }, // Numerical value to complete model specification
"variable" : [{ // A variable adjusted for in the adjusted analysis
"variableDefinition" : { Reference(EvidenceVariable|Group) }, // R! Description of the variable
"handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
"valueCategory" : [{ CodeableConcept }], // Description for grouping of ordinal or polychotomous variables
"valueQuantity" : [{ Quantity }], // Discrete value for grouping of ordinal or polychotomous variables
"valueRange" : [{ Range }] // Range of values for grouping of ordinal or polychotomous variables
}],
"attributeEstimate" : [{ Content as for Evidence.statistic.attributeEstimate }] // An attribute of the statistic used as a model characteristic
}]
}],
"certainty" : [{ // Certainty or quality of the evidence
"description" : "<string>", // Textual description of certainty
"note" : [{ Annotation }], // Footnotes and/or explanatory notes
"type" : { CodeableConcept }, // Aspect of certainty being rated
"rating" : { CodeableConcept }, // Assessment or judgement of the aspect
"rater" : "<string>", // Individual or group who did the rating
"subcomponent" : [{ Content as for Evidence.certainty }] // A domain or subdomain of certainty
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since Release 4
| Evidence | |
| Evidence.citeAs[x] |
|
| Evidence.experimental |
|
| Evidence.assertion |
|
| Evidence.variableDefinition |
|
| Evidence.variableDefinition.description |
|
| Evidence.variableDefinition.note |
|
| Evidence.variableDefinition.variableRole |
|
| Evidence.variableDefinition.observed |
|
| Evidence.variableDefinition.intended |
|
| Evidence.variableDefinition.directnessMatch |
|
| Evidence.synthesisType |
|
| Evidence.studyDesign |
|
| Evidence.statistic |
|
| Evidence.statistic.description |
|
| Evidence.statistic.note |
|
| Evidence.statistic.statisticType |
|
| Evidence.statistic.category |
|
| Evidence.statistic.quantity |
|
| Evidence.statistic.numberOfEvents |
|
| Evidence.statistic.numberAffected |
|
| Evidence.statistic.sampleSize |
|
| Evidence.statistic.sampleSize.description |
|
| Evidence.statistic.sampleSize.note |
|
| Evidence.statistic.sampleSize.numberOfStudies |
|
| Evidence.statistic.sampleSize.numberOfParticipants |
|
| Evidence.statistic.sampleSize.knownDataCount |
|
| Evidence.statistic.attributeEstimate |
|
| Evidence.statistic.attributeEstimate.description |
|
| Evidence.statistic.attributeEstimate.note |
|
| Evidence.statistic.attributeEstimate.type |
|
| Evidence.statistic.attributeEstimate.quantity |
|
| Evidence.statistic.attributeEstimate.level |
|
| Evidence.statistic.attributeEstimate.range |
|
| Evidence.statistic.attributeEstimate.attributeEstimate |
|
| Evidence.statistic.modelCharacteristic |
|
| Evidence.statistic.modelCharacteristic.code |
|
| Evidence.statistic.modelCharacteristic.value |
|
| Evidence.statistic.modelCharacteristic.variable |
|
| Evidence.statistic.modelCharacteristic.variable.variableDefinition |
|
| Evidence.statistic.modelCharacteristic.variable.handling |
|
| Evidence.statistic.modelCharacteristic.variable.valueCategory |
|
| Evidence.statistic.modelCharacteristic.variable.valueQuantity |
|
| Evidence.statistic.modelCharacteristic.variable.valueRange |
|
| Evidence.statistic.modelCharacteristic.attributeEstimate |
|
| Evidence.certainty |
|
| Evidence.certainty.description |
|
| Evidence.certainty.note |
|
| Evidence.certainty.type |
|
| Evidence.certainty.rating |
|
| Evidence.certainty.rater |
|
| Evidence.certainty.subcomponent |
|
| Evidence.shortTitle |
|
| Evidence.subtitle |
|
| Evidence.jurisdiction |
|
| Evidence.copyright |
|
| Evidence.effectivePeriod |
|
| Evidence.topic |
|
| Evidence.exposureBackground |
|
| Evidence.exposureVariant |
|
| Evidence.outcome |
|
See the Full Difference for further information
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| Evidence.status | The lifecycle status of an artifact. | Required | PublicationStatus |
| Evidence.variableDefinition.variableRole | The role that the assertion variable plays. | Extensible | EvidenceVariableRole |
| Evidence.variableDefinition.directnessMatch | The quality of how direct the match is. | Extensible | EvidenceDirectness |
| Evidence.synthesisType | Types of combining results from a body of evidence (eg. summary data meta-analysis). | Extensible | SynthesisType |
| Evidence.studyDesign | This is a set of terms for study design characteristics. | Extensible | StudyDesign |
| Evidence.statistic.statisticType | The type of a statistic, e.g. relative risk or mean | Extensible | StatisticType |
| Evidence.statistic.attributeEstimate.type | A statistic about a statistic, e.g. Confidence interval or p-value | Extensible | AttributeEstimateType |
| Evidence.statistic.modelCharacteristic.code | The handling of the variable in statistical analysis for exposures or outcomes. | Extensible | StatisticModelCode |
| Evidence.statistic.modelCharacteristic.variable.handling | The handling of the variable in statistical analysis for exposures or outcomes (E.g. Dichotomous, Continuous, Descriptive). | Required | EvidenceVariableHandling |
| Evidence.certainty.type | The aspect of quality, confidence, or certainty. | Extensible | EvidenceCertaintyType |
| Evidence.certainty.rating | The assessment of quality, confidence, or certainty. | Extensible | EvidenceCertaintyRating |
| UniqueKey | Level | Location | Description | Expression |
 cnl-0 | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}') |
| cnl-1 | Warning | Evidence.url | URL should not contain | or # - these characters make processing canonical references problematic | url.matches('([^|#])*') |
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 |
| context | token | A use context assigned to the evidence | (Evidence.useContext.value as CodeableConcept) | |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the evidence | (Evidence.useContext.value as Quantity) | (Evidence.useContext.value as Range) | |
| context-type | token | A type of use context assigned to the evidence | Evidence.useContext.code | |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the evidence | On Evidence.useContext: context-type: code context-quantity: value.ofType(Quantity) | value.ofType(Range) | |
| context-type-value | composite | A use context type and value assigned to the evidence | On Evidence.useContext: context-type: code context: value.ofType(CodeableConcept) | |
| date N | date | The evidence publication date | Evidence.date | |
| description N | string | The description of the evidence | Evidence.description | |
| identifier | token | External identifier for the evidence | Evidence.identifier | |
| publisher N | string | Name of the publisher of the evidence | Evidence.publisher | |
| status N | token | The current status of the evidence | Evidence.status | |
| title N | string | The human-friendly name of the evidence | Evidence.title | |
| url N | uri | The uri that identifies the evidence | Evidence.url | |
| version N | token | The business version of the evidence | Evidence.version |
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Wed, Sep 7, 2022 11:08+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R5 Draft |
|
Propose a change