Release 5 Preview #3
This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). 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: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for EvidenceVariable, which is just a part of the full JSON Schema.
Clinical Reasoning
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/EvidenceVariable",
"$ref": "#/definitions/EvidenceVariable",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"EvidenceVariable": {
"description": "The EvidenceVariable resource describes an element that knowledge (Evidence) is about.",
"properties": {
"resourceType": {
"description": "This is a EvidenceVariable resource",
"const": "EvidenceVariable"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "An absolute URI that is used to identify this evidence variable when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "A formal identifier that is used to identify this evidence variable when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "A natural language name identifying the evidence variable. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the evidence variable.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this evidence variable. Enables tracking the life-cycle of the content.",
"enum": [
"draft",
"active",
"retired",
"unknown"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "The date (and optionally time) when the evidence variable was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual that published the evidence variable.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the evidence variable from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence variable instances.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the {{title}} is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this {{title}} is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the {{title}} content was or is planned to be in active use.",
"$ref": "Period.schema.json#/definitions/Period"
},
"shortTitle": {
"description": "The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.",
"$ref": "#/definitions/string"
},
"_shortTitle": {
"description": "Extensions for shortTitle",
"$ref": "Element.schema.json#/definitions/Element"
},
"subtitle": {
"description": "An explanatory or alternate title for the EvidenceVariable giving additional information about its content.",
"$ref": "#/definitions/string"
},
"_subtitle": {
"description": "Extensions for subtitle",
"$ref": "Element.schema.json#/definitions/Element"
},
"note": {
"description": "A human-readable string to clarify or explain concepts about the resource.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"author": {
"description": "An individiual or organization primarily involved in the creation and maintenance of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization primarily responsible for review of some aspect of the content.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization responsible for officially endorsing the content for use in some setting.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, or bibliographic references.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"actual": {
"description": "True if the actual variable measured, false if a conceptual representation of the intended variable.",
"$ref": "#/definitions/boolean"
},
"_actual": {
"description": "Extensions for actual",
"$ref": "Element.schema.json#/definitions/Element"
},
"characteristicCombination": {
"description": "Used to specify if two or more characteristics are combined with OR or AND.",
"enum": [
"intersection",
"union"
]
},
"_characteristicCombination": {
"description": "Extensions for characteristicCombination",
"$ref": "Element.schema.json#/definitions/Element"
},
"characteristic": {
"description": "A characteristic that defines the members of the evidence element. Multiple characteristics are applied with \"and\" semantics.",
"items": {
"$ref": "#/definitions/EvidenceVariable_Characteristic"
},
"type": "array"
},
"handling": {
"description": "Used for an outcome to classify.",
"enum": [
"continuous",
"dichotomous",
"ordinal",
"polychotomous"
]
},
"_handling": {
"description": "Extensions for handling",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "A grouping (or set of values) described along with other groupings to specify the set of groupings allowed for the variable.",
"items": {
"$ref": "#/definitions/EvidenceVariable_Category"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"EvidenceVariable_Characteristic": {
"description": "The EvidenceVariable resource describes an element that knowledge (Evidence) is about.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"definitionReference": {
"description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"definitionCanonical": {
"description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"pattern": "^\\S*$",
"type": "string"
},
"_definitionCanonical": {
"description": "Extensions for definitionCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"definitionCodeableConcept": {
"description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"definitionExpression": {
"description": "Define members of the evidence element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"method": {
"description": "Method used for describing characteristic.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"device": {
"description": "Device used for determining characteristic.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"exclude": {
"description": "When true, members with this characteristic are excluded from the element.",
"$ref": "#/definitions/boolean"
},
"_exclude": {
"description": "Extensions for exclude",
"$ref": "Element.schema.json#/definitions/Element"
},
"timeFromStart": {
"description": "Indicates duration, period, or point of observation from the participant\u0027s study entry.",
"$ref": "#/definitions/EvidenceVariable_TimeFromStart"
},
"groupMeasure": {
"description": "Indicates how elements are aggregated within the study effective period.",
"enum": [
"mean",
"median",
"mean-of-mean",
"mean-of-median",
"median-of-mean",
"median-of-median"
]
},
"_groupMeasure": {
"description": "Extensions for groupMeasure",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"EvidenceVariable_TimeFromStart": {
"description": "The EvidenceVariable resource describes an element that knowledge (Evidence) is about.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "A short, natural language description.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"quantity": {
"description": "Used to express the observation at a defined amount of time after the study start.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"range": {
"description": "Used to express the observation within a period after the study start.",
"$ref": "Range.schema.json#/definitions/Range"
},
"note": {
"description": "A human-readable string to clarify or explain concepts about the resource.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
}
},
"additionalProperties": false
},
"EvidenceVariable_Category": {
"description": "The EvidenceVariable resource describes an element that knowledge (Evidence) is about.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"name": {
"description": "A human-readable title or representation of the grouping.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCodeableConcept": {
"description": "Value or set of values that define the grouping.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueQuantity": {
"description": "Value or set of values that define the grouping.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueRange": {
"description": "Value or set of values that define the grouping.",
"$ref": "Range.schema.json#/definitions/Range"
}
},
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:45+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change