Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - 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 . Page versions: R4B R4 R4B R4

Clinical Decision Support Work Group Maturity Level : 0   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the ResearchDefinition resource.

Invariants Affect this element inv-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ResearchDefinition
Element Id ResearchDefinition
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.

Cardinality 0..*
Type DomainResource
Summary false
Invariants
Defined on this element
rsd-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ResearchDefinition.url
Element Id ResearchDefinition.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.

Cardinality 0..1
Type uri
Requirements

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

Summary true
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 Id ResearchDefinition.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.

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Requirements

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

Summary true
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 Id ResearchDefinition.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.

Note This is a business versionId, not a resource version id (see discussion )
Cardinality 0..1
Type string
Summary true
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 Id ResearchDefinition.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.

Cardinality 0..1
Type string
Requirements

Support human navigation and code generation.

Summary true
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.

ResearchDefinition.title
Element Id ResearchDefinition.title
Definition

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

Cardinality 0..1
Type string
Summary true
Comments

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

ResearchDefinition.shortTitle
Element Id ResearchDefinition.shortTitle
Definition

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

Cardinality 0..1
Type string
Requirements

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

Summary false
ResearchDefinition.subtitle
Element Id ResearchDefinition.subtitle
Definition

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

Cardinality 0..1
Type string
Summary false
ResearchDefinition.status
Element Id ResearchDefinition.status
Definition

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

Cardinality 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summary true
Comments

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

ResearchDefinition.experimental
Element Id ResearchDefinition.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.

Cardinality 0..1
Type boolean
Requirements

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

Summary true
Comments

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

ResearchDefinition.subject[x]
Element Id ResearchDefinition.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.

Cardinality 0..1
Terminology Binding Subject type ( Extensible )
Type CodeableConcept | Reference ( Group )
[x] Note See Choice of Data Types for further information about how to use [x]
Meaning if Missing Patient
Summary false
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 Id ResearchDefinition.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.

Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
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 Id ResearchDefinition.publisher
Definition

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

Cardinality 0..1
Type string
Requirements

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

Summary true
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 Id ResearchDefinition.contact
Definition

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

Cardinality 0..*
Type ContactDetail
Summary true
Comments

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

ResearchDefinition.description
Element Id ResearchDefinition.description
Definition

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

Cardinality 0..1
Type markdown
Summary true
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 Id ResearchDefinition.comment
Definition

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

Cardinality 0..*
Type string
Summary false
ResearchDefinition.useContext
Element Id ResearchDefinition.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.

Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

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

ResearchDefinition.jurisdiction
Element Id ResearchDefinition.jurisdiction
Definition

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

Cardinality 0..*
Terminology Binding Jurisdiction ( Extensible )
Type CodeableConcept
Summary true
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 Id ResearchDefinition.purpose
Definition

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

Cardinality 0..1
Type markdown
Summary false
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 Id ResearchDefinition.usage
Definition

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

Cardinality 0..1
Type string
Summary false
ResearchDefinition.copyright
Element Id ResearchDefinition.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.

Cardinality 0..1
Type markdown
Requirements

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

Alternate Names License; Restrictions
Summary false
ResearchDefinition.approvalDate
Element Id ResearchDefinition.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.

Cardinality 0..1
Type date
Summary false
Comments

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

To Do Consider how this applies to this resource.
ResearchDefinition.lastReviewDate
Element Id ResearchDefinition.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.

Cardinality 0..1
Type date
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.

Summary false
Comments

If specified, this date follows the original approval date.

To Do Consider how this applies to this resource.
ResearchDefinition.effectivePeriod
Element Id ResearchDefinition.effectivePeriod
Definition

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

Cardinality 0..1
Type Period
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.

Summary true
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 Do Consider how this applies to this resource.
ResearchDefinition.topic
Element Id ResearchDefinition.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.

Cardinality 0..*
Terminology Binding DefinitionTopic ( Example )
Type CodeableConcept
Requirements

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

Summary false
To Do Consider how this applies to this resource.
ResearchDefinition.author
Element Id ResearchDefinition.author
Definition

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

Cardinality 0..*
Type ContactDetail
Summary false
To Do Consider how this applies to this resource.
ResearchDefinition.editor
Element Id ResearchDefinition.editor
Definition

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

Cardinality 0..*
Type ContactDetail
Summary false
To Do Consider how this applies to this resource.
ResearchDefinition.reviewer
Element Id ResearchDefinition.reviewer
Definition

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

Cardinality 0..*
Type ContactDetail
Summary false
To Do Consider how this applies to this resource.
ResearchDefinition.endorser
Element Id ResearchDefinition.endorser
Definition

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

Cardinality 0..*
Type ContactDetail
Summary false
To Do Consider how this applies to this resource.
ResearchDefinition.relatedArtifact
Element Id ResearchDefinition.relatedArtifact
Definition

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

Cardinality 0..*
Type RelatedArtifact
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.

Summary false
Comments

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

To Do Consider how this applies to this resource.
ResearchDefinition.library
Element Id ResearchDefinition.library
Definition

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

Cardinality 0..*
Type canonical ( Library )
Summary false
To Do Consider how this applies to this resource.
ResearchDefinition.population
Element Id ResearchDefinition.population
Definition

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

Cardinality 1..1
Type Reference ( ResearchElementDefinition )
Summary true
ResearchDefinition.exposure
Element Id ResearchDefinition.exposure
Definition

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

Cardinality 0..1
Type Reference ( ResearchElementDefinition )
Summary true
ResearchDefinition.exposureAlternative
Element Id ResearchDefinition.exposureAlternative
Definition

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

Cardinality 0..1
Type Reference ( ResearchElementDefinition )
Summary true
ResearchDefinition.outcome
Element Id ResearchDefinition.outcome
Definition

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

Cardinality 0..1
Type Reference ( ResearchElementDefinition )
Summary true