Resource type: researchdefinition

Description

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.

Elements

PathShortDefinitionComments
A research context or questionThe 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.
urlCanonical identifier for this research definition, represented as a URI (globally unique)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.Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
identifierAdditional identifier for the research definitionA 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.Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this research definition outside of FHIR, where it is not possible to use the logical URI.
versionBusiness version of the research definitionThe 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.There may be different research definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the research definition with the format [url]|[version].
nameName for this research definition (computer friendly)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.The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
titleName for this research definition (human friendly)A short, descriptive, user-friendly title for the research definition.This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
shortTitleTitle for use in informal contextsThe short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
subtitleSubordinate title of the ResearchDefinitionAn explanatory or alternate title for the ResearchDefinition giving additional information about its content.
statusdraft | active | retired | unknownThe status of this research definition. Enables tracking the life-cycle of the content.Allows filtering of research definitions that are appropriate for use versus not.
experimentalFor testing purposes, not real usageA 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.Allows filtering of research definitions that are appropriate for use versus not.
subject[x]E.g. Patient, Practitioner, RelatedPerson, Organization, Location, DeviceThe 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.The subject of the ResearchDefinition is critical in interpreting the criteria definitions, as the logic in the ResearchDefinitions is evaluated with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what content is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
dateDate last changedThe 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.Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the research definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisherName of the publisher (organization or individual)The name of the organization or individual that published the research definition.Usually an organization but may be an individual. The publisher (or steward) of the research definition is the organization or individual primarily responsible for the maintenance and upkeep of the research definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the research definition. This item SHOULD be populated unless the information is available from context.
contactContact details for the publisherContact details to assist a user in finding and communicating with the publisher.May be a web site, an email address, a telephone number, etc.
descriptionNatural language description of the research definitionA free text natural language description of the research definition from a consumer's perspective.This description can be used to capture details such as why the research definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the research definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the research definition is presumed to be the predominant language in the place the research definition was created).
commentUsed for footnotes or explanatory notesA human-readable string to clarify or explain concepts about the resource.
useContextThe context that the content is intended to supportThe 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.When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdictionIntended jurisdiction for research definition (if applicable)A legal or geographic region in which the research definition is intended to be used.It may be possible for the research definition to be used in jurisdictions other than those for which it was originally designed or intended.
purposeWhy this research definition is definedExplanation of why this research definition is needed and why it has been designed as it has.This element does not describe the usage of the research definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this research definition.
usageDescribes the clinical usage of the ResearchDefinitionA detailed description, from a clinical perspective, of how the ResearchDefinition is used.
copyrightUse and/or publishing restrictionsA 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.
approvalDateWhen the research definition was approved by publisherThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
lastReviewDateWhen the research definition was last reviewedThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.If specified, this date follows the original approval date.
effectivePeriodWhen the research definition is expected to be usedThe period during which the research definition content was or is planned to be in active use.The effective period for a research definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
topicThe category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.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.
authorWho authored the contentAn individiual or organization primarily involved in the creation and maintenance of the content.
editorWho edited the contentAn individual or organization primarily responsible for internal coherence of the content.
reviewerWho reviewed the contentAn individual or organization primarily responsible for review of some aspect of the content.
endorserWho endorsed the contentAn individual or organization responsible for officially endorsing the content for use in some setting.
relatedArtifactAdditional documentation, citations, etc.Related artifacts such as additional documentation, justification, or bibliographic references.Each related artifact is either an attachment, or a reference to another resource, but not both.
libraryLogic used by the ResearchDefinitionA reference to a Library resource containing the formal logic used by the ResearchDefinition.
populationWhat population?A reference to a ResearchElementDefinition resource that defines the population for the research.
exposureWhat exposure?A reference to a ResearchElementDefinition resource that defines the exposure for the research.
exposureAlternativeWhat alternative exposure state?A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.
outcomeWhat outcome?A reference to a ResearchElementDefinition resomece that defines the outcome for the research.

Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

TODO

Boundaries and Relationships

TODO

Search Parameters

composed-ofWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='composed-of').resource
contextA use context assigned to the research definition(ResearchDefinition.useContext.value as CodeableConcept)
context-quantityA quantity- or range-valued use context assigned to the research definition(ResearchDefinition.useContext.value as Quantity) | (ResearchDefinition.useContext.value as Range)
context-typeA type of use context assigned to the research definitionResearchDefinition.useContext.code
dateThe research definition publication dateResearchDefinition.date
depends-onWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='depends-on').resource | ResearchDefinition.library
derived-fromWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='derived-from').resource
descriptionThe description of the research definitionResearchDefinition.description
effectiveThe time during which the research definition is intended to be in useResearchDefinition.effectivePeriod
identifierExternal identifier for the research definitionResearchDefinition.identifier
jurisdictionIntended jurisdiction for the research definitionResearchDefinition.jurisdiction
nameComputationally friendly name of the research definitionResearchDefinition.name
predecessorWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='predecessor').resource
publisherName of the publisher of the research definitionResearchDefinition.publisher
statusThe current status of the research definitionResearchDefinition.status
successorWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='successor').resource
titleThe human-friendly name of the research definitionResearchDefinition.title
topicTopics associated with the ResearchDefinitionResearchDefinition.topic
urlThe uri that identifies the research definitionResearchDefinition.url
versionThe business version of the research definitionResearchDefinition.version
context-type-quantityA use context type and quantity- or range-based value assigned to the research definitionResearchDefinition.useContext
context-type-valueA use context type and value assigned to the research definitionResearchDefinition.useContext

Extension Definitions

These are extension definitions for this resource defined by the spec