This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
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 EffectEvidenceSynthesis, which is just a part of the full JSON Schema.
{ "$schema": "http://json-schema.org/draft-06/schema#", "id": "http://hl7.org/fhir/json-schema/EffectEvidenceSynthesis", "$ref": "#/definitions/EffectEvidenceSynthesis", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "EffectEvidenceSynthesis": { "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", "properties": { "resourceType": { "description": "This is a EffectEvidenceSynthesis resource", "const": "EffectEvidenceSynthesis" }, "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, and 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 effect evidence synthesis 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 effect evidence synthesis is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the effect evidence synthesis 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 effect evidence synthesis 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 effect evidence synthesis when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the effect evidence synthesis 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.", "$ref": "#/definitions/string" }, "_version": { "description": "Extensions for version", "$ref": "Element.schema.json#/definitions/Element" }, "name": { "description": "A natural language name identifying the effect evidence synthesis. 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 effect evidence synthesis.", "$ref": "#/definitions/string" }, "_title": { "description": "Extensions for title", "$ref": "Element.schema.json#/definitions/Element" }, "status": { "description": "The status of this effect evidence synthesis. Enables tracking the life-cycle of the content.", "enum": [ "draft", "active", "retired", "unknown" ] }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "date": { "description": "The date (and optionally time) when the effect evidence synthesis 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 effect evidence synthesis 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 effect evidence synthesis.", "$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 effect evidence synthesis from a consumer\u0027s perspective.", "$ref": "#/definitions/markdown" }, "_description": { "description": "Extensions for description", "$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" }, "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 effect evidence synthesis instances.", "items": { "$ref": "UsageContext.schema.json#/definitions/UsageContext" }, "type": "array" }, "jurisdiction": { "description": "A legal or geographic region in which the effect evidence synthesis is intended to be used.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "copyright": { "description": "A copyright statement relating to the effect evidence synthesis and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the effect evidence synthesis.", "$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 effect evidence synthesis content was or is planned to be in active use.", "$ref": "Period.schema.json#/definitions/Period" }, "topic": { "description": "Descriptive topics related to the content of the EffectEvidenceSynthesis. Topics provide a high-level categorization grouping types of EffectEvidenceSynthesiss that can be useful for filtering and searching.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "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" }, "synthesisType": { "description": "Type of synthesis eg meta-analysis.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "studyType": { "description": "Type of study eg randomized trial.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "population": { "description": "A reference to a EvidenceVariable resource that defines the population for the research.", "$ref": "Reference.schema.json#/definitions/Reference" }, "exposure": { "description": "A reference to a EvidenceVariable resource that defines the exposure for the research.", "$ref": "Reference.schema.json#/definitions/Reference" }, "exposureAlternative": { "description": "A reference to a EvidenceVariable resource that defines the comparison exposure for the research.", "$ref": "Reference.schema.json#/definitions/Reference" }, "outcome": { "description": "A reference to a EvidenceVariable resomece that defines the outcome for the research.", "$ref": "Reference.schema.json#/definitions/Reference" }, "sampleSize": { "description": "A description of the size of the sample involved in the synthesis.", "$ref": "#/definitions/EffectEvidenceSynthesis_SampleSize" }, "resultsByExposure": { "description": "A description of the results for each exposure considered in the effect estimate.", "items": { "$ref": "#/definitions/EffectEvidenceSynthesis_ResultsByExposure" }, "type": "array" }, "effectEstimate": { "description": "The estimated effect of the exposure variant.", "items": { "$ref": "#/definitions/EffectEvidenceSynthesis_EffectEstimate" }, "type": "array" }, "certainty": { "description": "A description of the certainty of the effect estimate.", "items": { "$ref": "#/definitions/EffectEvidenceSynthesis_Certainty" }, "type": "array" } }, "additionalProperties": false, "required": [ "exposureAlternative", "exposure", "outcome", "resourceType", "population" ] }, "EffectEvidenceSynthesis_SampleSize": { "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", "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": "Human-readable summary of sample size.", "$ref": "#/definitions/string" }, "_description": { "description": "Extensions for description", "$ref": "Element.schema.json#/definitions/Element" }, "numberOfStudies": { "description": "Number of studies included in this evidence synthesis.", "$ref": "#/definitions/integer" }, "_numberOfStudies": { "description": "Extensions for numberOfStudies", "$ref": "Element.schema.json#/definitions/Element" }, "numberOfParticipants": { "description": "Number of participants included in this evidence synthesis.", "$ref": "#/definitions/integer" }, "_numberOfParticipants": { "description": "Extensions for numberOfParticipants", "$ref": "Element.schema.json#/definitions/Element" } }, "additionalProperties": false }, "EffectEvidenceSynthesis_ResultsByExposure": { "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", "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": "Human-readable summary of results by exposure state.", "$ref": "#/definitions/string" }, "_description": { "description": "Extensions for description", "$ref": "Element.schema.json#/definitions/Element" }, "exposureState": { "description": "Whether these results are for the exposure state or alternative exposure state.", "enum": [ "exposure", "exposure-alternative" ] }, "_exposureState": { "description": "Extensions for exposureState", "$ref": "Element.schema.json#/definitions/Element" }, "variantState": { "description": "Used to define variant exposure states such as low-risk state.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "riskEvidenceSynthesis": { "description": "Reference to a RiskEvidenceSynthesis resource.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "additionalProperties": false, "required": [ "riskEvidenceSynthesis" ] }, "EffectEvidenceSynthesis_EffectEstimate": { "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", "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": "Human-readable summary of effect estimate.", "$ref": "#/definitions/string" }, "_description": { "description": "Extensions for description", "$ref": "Element.schema.json#/definitions/Element" }, "type": { "description": "Examples include relative risk and mean difference.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "variantState": { "description": "Used to define variant exposure states such as low-risk state.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "value": { "description": "The point estimate of the effect estimate.", "$ref": "#/definitions/decimal" }, "_value": { "description": "Extensions for value", "$ref": "Element.schema.json#/definitions/Element" }, "unitOfMeasure": { "description": "Specifies the UCUM unit for the outcome.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "precisionEstimate": { "description": "A description of the precision of the estimate for the effect.", "items": { "$ref": "#/definitions/EffectEvidenceSynthesis_PrecisionEstimate" }, "type": "array" } }, "additionalProperties": false }, "EffectEvidenceSynthesis_PrecisionEstimate": { "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", "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" }, "type": { "description": "Examples include confidence interval and interquartile range.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "level": { "description": "Use 95 for a 95% confidence interval.", "$ref": "#/definitions/decimal" }, "_level": { "description": "Extensions for level", "$ref": "Element.schema.json#/definitions/Element" }, "from": { "description": "Lower bound of confidence interval.", "$ref": "#/definitions/decimal" }, "_from": { "description": "Extensions for from", "$ref": "Element.schema.json#/definitions/Element" }, "to": { "description": "Upper bound of confidence interval.", "$ref": "#/definitions/decimal" }, "_to": { "description": "Extensions for to", "$ref": "Element.schema.json#/definitions/Element" } }, "additionalProperties": false }, "EffectEvidenceSynthesis_Certainty": { "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", "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" }, "rating": { "description": "A rating of the certainty of the effect estimate.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "note": { "description": "A human-readable string to clarify or explain concepts about the resource.", "items": { "$ref": "Annotation.schema.json#/definitions/Annotation" }, "type": "array" }, "certaintySubcomponent": { "description": "A description of a component of the overall certainty.", "items": { "$ref": "#/definitions/EffectEvidenceSynthesis_CertaintySubcomponent" }, "type": "array" } }, "additionalProperties": false }, "EffectEvidenceSynthesis_CertaintySubcomponent": { "description": "The EffectEvidenceSynthesis resource describes the difference in an outcome between exposures states in a population where the effect estimate is derived from a combination of research studies.", "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" }, "type": { "description": "Type of subcomponent of certainty rating.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "rating": { "description": "A rating of a subcomponent of rating certainty.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "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 } } }