Evidence - FHIR Resource (r4)
This Evidence Resource uses the FHIR API standard for access and structure.
Validate an Evidence FHIR Resource (r4)
Evidence Attributes
AttributeField is listTypeDescription
Description: Canonical identifier for this evidence, represented as a URI (globally unique)
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (Evidence) url FHIR attribute
Description: Additional identifier for the evidence
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Evidence) identifier FHIR attribute
Description: Business version of the evidence
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (Evidence) version FHIR attribute
Description: C? Name for this evidence (computer friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (Evidence) name FHIR attribute
Description: Name for this evidence (human friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (Evidence) title FHIR attribute
Description: Title for use in informal contexts
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"shortTitle": Learn more about the (Evidence) shortTitle FHIR attribute
Description: Subordinate title of the Evidence
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subtitle": Learn more about the (Evidence) subtitle FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "draft"Learn more about the (Evidence) status FHIR attribute
Description: Date last changed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (Evidence) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (Evidence) publisher FHIR attribute
Description: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (Evidence) contact FHIR attribute
Description: Natural language description of the evidence
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (Evidence) description FHIR attribute
Description: Used for footnotes or explanatory notes
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (Evidence) note FHIR attribute
Description: The context that the content is intended to support
FHIR Version: r4
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": Learn more about the (Evidence) useContext FHIR attribute
Description: Intended jurisdiction for evidence (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": Learn more about the (Evidence) jurisdiction FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (Evidence) copyright FHIR attribute
Description: When the evidence was approved by publisher
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"approvalDate": Learn more about the (Evidence) approvalDate FHIR attribute
Description: When the evidence was last reviewed
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lastReviewDate": Learn more about the (Evidence) lastReviewDate FHIR attribute
Description: When the evidence is expected to be used
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"effectivePeriod": Learn more about the (Evidence) effectivePeriod FHIR attribute
Description: The category of the Evidence, such as Education, Treatment, Assessment, etc.
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic": Learn more about the (Evidence) topic FHIR attribute
Description: Who authored the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": Learn more about the (Evidence) author FHIR attribute
Description: Who edited the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"editor": Learn more about the (Evidence) editor FHIR attribute
Description: Who reviewed the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reviewer": Learn more about the (Evidence) reviewer FHIR attribute
Description: Who endorsed the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"endorser": Learn more about the (Evidence) endorser FHIR attribute
Description: Additional documentation, citations, etc.
FHIR Version: r4
Attribute Type : RelatedArtifact
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatedArtifact": Learn more about the (Evidence) relatedArtifact FHIR attribute
Description: What population?
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"exposureBackground": {
"reference": "EvidenceVariable/example"
}Learn more about the (Evidence) exposureBackground FHIR attribute
Description: What exposure?
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"exposureVariant": Learn more about the (Evidence) exposureVariant FHIR attribute
Description: What outcome?
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"outcome": Learn more about the (Evidence) outcome FHIR attribute
Evidence Example
{
"resourceType": "Evidence",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
},
"status": "draft",
"exposureBackground": {
"reference": "EvidenceVariable/example"
}
}Evidence Structure
{
"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 URI (globally unique)
"identifier" : [{ Identifier }], // Additional identifier for the evidence
"version" : "<string>", // Business version of the evidence
"name" : "<string>", // C? Name for this evidence (computer friendly)
"title" : "<string>", // Name for this evidence (human friendly)
"shortTitle" : "<string>", // Title for use in informal contexts
"subtitle" : "<string>", // Subordinate title of the Evidence
"status" : "<code>", // R! draft | active | retired | unknown
"date" : "<dateTime>", // Date last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the evidence
"note" : [{ Annotation }], // Used for footnotes or explanatory notes
"useContext" : [{ UsageContext }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for evidence (if applicable)
"copyright" : "<markdown>", // Use and/or publishing restrictions
"approvalDate" : "<date>", // When the evidence was approved by publisher
"lastReviewDate" : "<date>", // When the evidence was last reviewed
"effectivePeriod" : { Period }, // When the evidence is expected to be used
"topic" : [{ CodeableConcept }], // The category of the Evidence, such as Education, Treatment, Assessment, etc.
"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.
"exposureBackground" : { Reference(EvidenceVariable) }, // R! What population?
"exposureVariant" : [{ Reference(EvidenceVariable) }], // What exposure?
"outcome" : [{ Reference(EvidenceVariable) }] // What outcome?
}
Evidence Search Parameters
The following search parameters can be used to query Evidence resources. Just submit them like so:
https://api.1up.health/fhir/r4/Evidence?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
composed-of | reference | relatedArtifact.where |
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
depends-on | reference | relatedArtifact.where |
derived-from | reference | relatedArtifact.where |
description | text | description |
effective | date | effectivePeriod |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
predecessor | reference | relatedArtifact.where |
publisher | text | publisher |
status | text | status |
successor | reference | relatedArtifact.where |
title | text | title |
topic | text | topic |
url | uri | url |
version | text | version |
