Current Build
Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the ResearchDefinition resource.

ResearchDefinition
Element IdResearchDefinition
Definition

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.

Cardinality0..*
TypeDomainResource
Invariants
Defined on this element
rsd-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ResearchDefinition.url
Element IdResearchDefinition.url
Definition

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.

Cardinality0..1
Typeuri
Requirements

Allows the research definition to be referenced by a single globally unique identifier.

Summarytrue
Comments

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.

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 element to indicate where the current master source of the resource can be found.

ResearchDefinition.identifier
Element IdResearchDefinition.identifier
Definition

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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

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.

ResearchDefinition.version
Element IdResearchDefinition.version
Definition

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.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

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].

ResearchDefinition.name
Element IdResearchDefinition.name
Definition

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.

Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

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.

Invariants
Affect this element
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ResearchDefinition.title
Element IdResearchDefinition.title
Definition

A short, descriptive, user-friendly title for the research definition.

Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

ResearchDefinition.shortTitle
Element IdResearchDefinition.shortTitle
Definition

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

Cardinality0..1
Typestring
Requirements

Need to be able to reference the content by a short description, but still provide a longer, more formal title for the content.

ResearchDefinition.subtitle
Element IdResearchDefinition.subtitle
Definition

An explanatory or alternate title for the ResearchDefinition giving additional information about its content.

Cardinality0..1
Typestring
ResearchDefinition.status
Element IdResearchDefinition.status
Definition

The status of this research definition. Enables tracking the life-cycle of the content.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of research definitions that are appropriate for use versus not.

ResearchDefinition.experimental
Element IdResearchDefinition.experimental
Definition

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.

Cardinality0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level research definition.

Summarytrue
Comments

Allows filtering of research definitions that are appropriate for use versus not.

ResearchDefinition.subject[x]
Element IdResearchDefinition.subject[x]
Definition

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.

Cardinality0..1
Terminology BindingSubject type (Extensible)
TypeCodeableConcept|Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Meaning if MissingPatient
Comments

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.

ResearchDefinition.date
Element IdResearchDefinition.date
Definition

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.

Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

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.

ResearchDefinition.publisher
Element IdResearchDefinition.publisher
Definition

The name of the organization or individual that published the research definition.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the research definition. May also allow for contact.

Summarytrue
Comments

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.

ResearchDefinition.contact
Element IdResearchDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

ResearchDefinition.description
Element IdResearchDefinition.description
Definition

A free text natural language description of the research definition from a consumer's perspective.

Cardinality0..1
Typemarkdown
Summarytrue
Comments

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).

ResearchDefinition.comment
Element IdResearchDefinition.comment
Definition

A human-readable string to clarify or explain concepts about the resource.

Cardinality0..*
Typestring
ResearchDefinition.useContext
Element IdResearchDefinition.useContext
Definition

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.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

ResearchDefinition.jurisdiction
Element IdResearchDefinition.jurisdiction
Definition

A legal or geographic region in which the research definition is intended to be used.

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the research definition to be used in jurisdictions other than those for which it was originally designed or intended.

ResearchDefinition.purpose
Element IdResearchDefinition.purpose
Definition

Explanation of why this research definition is needed and why it has been designed as it has.

Cardinality0..1
Typemarkdown
Comments

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.

ResearchDefinition.usage
Element IdResearchDefinition.usage
Definition

A detailed description, from a clinical perspective, of how the ResearchDefinition is used.

Cardinality0..1
Typestring
ResearchDefinition.copyright
Element IdResearchDefinition.copyright
Definition

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.

Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the research definition and/or its content.

Alternate NamesLicense; Restrictions
ResearchDefinition.approvalDate
Element IdResearchDefinition.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Cardinality0..1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

To DoConsider how this applies to this resource.
ResearchDefinition.lastReviewDate
Element IdResearchDefinition.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Cardinality0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

To DoConsider how this applies to this resource.
ResearchDefinition.effectivePeriod
Element IdResearchDefinition.effectivePeriod
Definition

The period during which the research definition content was or is planned to be in active use.

Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the research definition are or are expected to be used instead.

Summarytrue
Comments

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.

To DoConsider how this applies to this resource.
ResearchDefinition.topic
Element IdResearchDefinition.topic
Definition

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.

Cardinality0..*
Terminology BindingDefinitionTopic (Example)
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the ResearchDefinition so that it can be found by topical searches.

To DoConsider how this applies to this resource.
ResearchDefinition.author
Element IdResearchDefinition.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Cardinality0..*
TypeContactDetail
To DoConsider how this applies to this resource.
ResearchDefinition.editor
Element IdResearchDefinition.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Cardinality0..*
TypeContactDetail
To DoConsider how this applies to this resource.
ResearchDefinition.reviewer
Element IdResearchDefinition.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the content.

Cardinality0..*
TypeContactDetail
To DoConsider how this applies to this resource.
ResearchDefinition.endorser
Element IdResearchDefinition.endorser
Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

Cardinality0..*
TypeContactDetail
To DoConsider how this applies to this resource.
ResearchDefinition.relatedArtifact
Element IdResearchDefinition.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Cardinality0..*
TypeRelatedArtifact
Requirements

ResearchDefinitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

To DoConsider how this applies to this resource.
ResearchDefinition.library
Element IdResearchDefinition.library
Definition

A reference to a Library resource containing the formal logic used by the ResearchDefinition.

Cardinality0..*
Typecanonical(Library)
To DoConsider how this applies to this resource.
ResearchDefinition.population
Element IdResearchDefinition.population
Definition

A reference to a ResearchElementDefinition resource that defines the population for the research.

Cardinality1..1
TypeReference(ResearchElementDefinition)
Summarytrue
ResearchDefinition.exposure
Element IdResearchDefinition.exposure
Definition

A reference to a ResearchElementDefinition resource that defines the exposure for the research.

Cardinality0..1
TypeReference(ResearchElementDefinition)
Summarytrue
ResearchDefinition.exposureAlternative
Element IdResearchDefinition.exposureAlternative
Definition

A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.

Cardinality0..1
TypeReference(ResearchElementDefinition)
Summarytrue
ResearchDefinition.outcome
Element IdResearchDefinition.outcome
Definition

A reference to a ResearchElementDefinition resomece that defines the outcome for the research.

Cardinality0..1
TypeReference(ResearchElementDefinition)
Summarytrue