ResearchDefinition
The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about. If the element is present, it must have either a @value, an @id, or extensions
type ResearchDefinition implements Resource {
url: Uri
identifier: [Identifier]
version: String
name: String
title: String
shortTitle: String
subtitle: String
status: String
experimental: Boolean
subjectCodeableConcept: CodeableConcept
subjectReference: Reference
date: Date
publisher: String
contact: [ContactDetail]
description: String
comment: [String]
useContext: [UsageContext]
jurisdiction: [CodeableConcept]
purpose: String
usage: String
copyright: String
approvalDate: Date
lastReviewDate: Date
effectivePeriod: Period
topic: [CodeableConcept]
author: [ContactDetail]
editor: [ContactDetail]
reviewer: [ContactDetail]
endorser: [ContactDetail]
relatedArtifact: [RelatedArtifact]
library: [Uri]
population: Reference
exposure: Reference
exposureAlternative: Reference
outcome: Reference
text: Narrative
contained: [Resource]
extension: [Extension]
modifierExtension: [Extension]
id: String
meta: Meta
implicitRules: Uri
language: String
}
Fields
ResearchDefinition.url ● Uri scalar
An absolute URI that is used to identify this research definition 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 research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.
ResearchDefinition.identifier ● [Identifier] list object
A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
ResearchDefinition.version ● String scalar
The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition 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.
ResearchDefinition.name ● String scalar
A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
ResearchDefinition.title ● String scalar
A short, descriptive, user-friendly title for the research definition.
ResearchDefinition.shortTitle ● String scalar
The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
ResearchDefinition.subtitle ● String scalar
An explanatory or alternate title for the ResearchDefinition giving additional information about its content.
ResearchDefinition.status ● String scalar
The status of this research definition. Enables tracking the life-cycle of the content.
ResearchDefinition.experimental ● Boolean scalar
A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
ResearchDefinition.subjectCodeableConcept ● CodeableConcept object
The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything. (choose any one of subject*, but only one)
ResearchDefinition.subjectReference ● Reference object
The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything. (choose any one of subject*, but only one)
ResearchDefinition.date ● Date scalar
The date (and optionally time) when the research definition 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 research definition changes.
ResearchDefinition.publisher ● String scalar
The name of the organization or individual that published the research definition.
ResearchDefinition.contact ● [ContactDetail] list object
Contact details to assist a user in finding and communicating with the publisher.
ResearchDefinition.description ● String scalar
A free text natural language description of the research definition from a consumer s perspective.
ResearchDefinition.comment ● [String] list scalar
A human-readable string to clarify or explain concepts about the resource.
ResearchDefinition.useContext ● [UsageContext] list object
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 research definition instances.
ResearchDefinition.jurisdiction ● [CodeableConcept] list object
A legal or geographic region in which the research definition is intended to be used.
ResearchDefinition.purpose ● String scalar
Explanation of why this research definition is needed and why it has been designed as it has.
ResearchDefinition.usage ● String scalar
A detailed description, from a clinical perspective, of how the ResearchDefinition is used.
ResearchDefinition.copyright ● String scalar
A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.
ResearchDefinition.approvalDate ● Date scalar
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
ResearchDefinition.lastReviewDate ● Date scalar
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
ResearchDefinition.effectivePeriod ● Period object
The period during which the research definition content was or is planned to be in active use.
ResearchDefinition.topic ● [CodeableConcept] list object
Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.
ResearchDefinition.author ● [ContactDetail] list object
An individiual or organization primarily involved in the creation and maintenance of the content.
ResearchDefinition.editor ● [ContactDetail] list object
An individual or organization primarily responsible for internal coherence of the content.
ResearchDefinition.reviewer ● [ContactDetail] list object
An individual or organization primarily responsible for review of some aspect of the content.
ResearchDefinition.endorser ● [ContactDetail] list object
An individual or organization responsible for officially endorsing the content for use in some setting.
ResearchDefinition.relatedArtifact ● [RelatedArtifact] list object
Related artifacts such as additional documentation, justification, or bibliographic references.
ResearchDefinition.library ● [Uri] list scalar
A reference to a Library resource containing the formal logic used by the ResearchDefinition.
ResearchDefinition.population ● Reference object
A reference to a ResearchElementDefinition resource that defines the population for the research.
ResearchDefinition.exposure ● Reference object
A reference to a ResearchElementDefinition resource that defines the exposure for the research.
ResearchDefinition.exposureAlternative ● Reference object
A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.
ResearchDefinition.outcome ● Reference object
A reference to a ResearchElementDefinition resomece that defines the outcome for the research.
ResearchDefinition.text ● Narrative object
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.
ResearchDefinition.contained ● [Resource] list interface
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.
ResearchDefinition.extension ● [Extension] list object
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.
ResearchDefinition.modifierExtension ● [Extension] list object
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 s 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ResearchDefinition.id ● String scalar
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ResearchDefinition.meta ● Meta object
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.
ResearchDefinition.implicitRules ● Uri scalar
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.
ResearchDefinition.language ● String scalar
The base language in which the resource is written.
Interfaces
Resource interface
This is the base resource type for everything.
Returned By
ResearchDefinition query ● ResearchDefinitionCreate mutation ● ResearchDefinitionList query ● ResearchDefinitionUpdate mutation