FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3

Responsible Owner: Regulated Clinical Biomedical Research Information Management and Regulation icon Work Group   Normative Maturity Level : 0   Draft Security Category : Business Compartments : Practitioner Group

Detailed Descriptions for the elements in the ResearchStudy resource.

Control Control Control Control Control Control Control Control Control Control Alternate Names .participation[typeCode=SBJ].role. Control Alternate Names Control Control Type Control Control Control Annotation Control Control Control Control
Definition Element Id ResearchStudy
Definition

A process where a researcher or organization plans and then executes research study is a series of steps intended scientific investigation designed to increase the field of healthcare-related generate health-related knowledge. This includes studies can include clinical trials involving human participants (or animals in the case of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional veterinary clinical trials). These studies may be related to new ways to screen, prevent, diagnose, and investigative techniques. A ResearchStudy involves treat disease. Research studies may also analyze data collected from individuals in the gathering of information about human past (retrospective studies) or animal subjects. future (prospective studies) to understand specific outcomes or trends in particular populations.

Short Display Investigation to increase healthcare-related patient-independent knowledge
Cardinality 0..*
1..1 Type DomainResource
Alternate Names Clinical Trial; Study
Comments Summary false
Comments

Need to make sure we encompass The ResearchStudy Resource may be used for any type of research study, such as public health studies. studies evaluating populations or systematic reviews evaluating research studies, and is not limited to clinical trials or limited to studies of individual people.

Element Id ResearchStudy.url
Definition

Canonical identifier for this study resource, represented as a globally unique URI.

Short Display Canonical identifier for this study resource
Cardinality 0..1
Type uri
Summary false
Definition Element Id ResearchStudy.identifier
Definition

Identifiers assigned to this research study by the sponsor or other systems.

Note Short Display Business Identifier for study
Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Requirements

Allows identification of the research study as it is known by various participating systems and in a way that remains consistent across servers.

Summary true
Element Id ResearchStudy.version
Definition

The business version for the study record.

Short Display The business version for the study record
Note This is a business versionId, not a resource version id (see discussion )
Cardinality 0..1
Type string
Summary false
Element Id ResearchStudy.name
Definition

Name for this study (computer friendly).

Short Display Name for this study (computer friendly)
Cardinality 0..1
Type string
Summary false
Element Id ResearchStudy.title
Definition

The human readable name of the research study.

Short Display Human readable name of the study
Cardinality 0..1
Type string
Summary true
Element Id ResearchStudy.label
Definition

A short, descriptive user-friendly label Additional names for the study.

Short Display Additional names for the study
Control Cardinality 0..*
Summary false
Element Id ResearchStudy.label.type
Definition

Kind of name.

Short Display primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid
Cardinality 0..1
Terminology Binding Title Type icon ( Preferred )
Type CodeableConcept
Summary false
Element Id ResearchStudy.label.value
Definition

The name.

Short Display The name
Cardinality 0..1
Type string
Summary false
true Element Id ResearchStudy.label.language
Definition

Used to express the specific language of the title.

Short Display Used to express the specific language
Cardinality 0..1
Terminology Binding All Languages ( Required )
Additional Bindings Purpose
Common Languages Starter
Type code
Summary false
Definition Element Id ResearchStudy.protocol
Definition

The set of steps expected to be performed as part of the execution of the study.

Short Display Steps followed in executing study
Cardinality 0..*
Type Reference ( PlanDefinition )
Summary true
Definition Element Id ResearchStudy.partOf
Definition

A larger research study of which this particular study is a component or step.

Short Display Part of larger study
Cardinality 0..*
Type Reference ( ResearchStudy )
Requirements Hierarchy This reference is part of a strict Hierarchy
Requirements

Allows breaking a study into components (e.g. by study site) each with their own PI, status, enrollment, etc.

Alternate Names container
Summary true
Element Id ResearchStudy.citeAs
Definition

Display of the bibliographic citation of this ResearchStudy.

Short Display How to cite this ResearchStudy
Cardinality 0..1
Type markdown
Summary false
Element Id ResearchStudy.relatesTo
Definition

Relationships that this ResearchStudy has with other FHIR or non-FHIR resources that already exist.

Short Display Relationships to other Resources
Cardinality 0..*
Summary false
Element Id ResearchStudy.relatesTo.type
Definition

The current state type of relationship to the study. related artifact.

Short Display documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as | reprint | reprint-of | summarizes
Cardinality 1..1
Terminology Binding ResearchStudyStatus Artifact Relationship Type icon ( Required Extensible )
Type CodeableConcept
code Summary false
Element Id ResearchStudy.relatesTo.target[x]
Definition Is Modifier

The artifact that is related to this ResearchStudy Resource.

Short Display The artifact that is related to this ResearchStudy
Cardinality 1..1
true Type uri | Attachment | canonical ( Any )| Reference ( Any )| markdown
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true false
Comments

A targetReference using a DocumentReference allows providing metadata regarding the referenced document.

Element Id ResearchStudy.date
Definition

The date (and optionally time) when the ResearchStudy Resource was last significantly changed. 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 ResearchStudy Resource changes.

Short Display Date the resource last changed
Cardinality 0..1
Type dateTime
Summary false
Element Id ResearchStudy.status
Definition

The publication state of the resource (not of the study).

Short Display draft | active | retired | unknown
Cardinality 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true (Reason: This element is labeled as a modifier because the it is a status element that contains codes status entered-in-error which means that mark the resource as should not currently valid. be treated as valid)
To Do Summary Should this be a common code system for all events? true
Definition Element Id ResearchStudy.primaryPurposeType
Definition

Codes categorizing the The type of study such as investigational vs. observational, type based upon the intent of blinding, type the study activities. A classification of randomization, safety vs. efficacy, etc. the intent of the study.

Short Display treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
Cardinality 0..* 0..1
Terminology Binding ResearchStudyCategory : ResearchStudyPrimaryPurposeType icon ( Preferred )
Type CodeableConcept
Summary true
Definition Element Id ResearchStudy.phase
Definition

The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that stage in the study is seeking progression of a therapy from initial experimental use in humans in clinical trials to gain more information about. post-market evaluation.

Short Display Classifier used for clinical trials
Cardinality 0..* 0..1
Terminology Binding ResearchStudyFocus : ResearchStudyPhase icon ( Preferred )
Type CodeableConcept
Summary true
Definition Element Id ResearchStudy.studyDesign
Definition

Contact details to assist a user in learning more about or engaging with Codes categorizing the study. type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.

Short Display Classifications of the study design characteristics
Control Cardinality 0..*
Terminology Binding Study Design ( Preferred )
Type ContactDetail CodeableConcept
Summary true
Comments

See the Evidence Based Medicine on FHIR Implementation Guide (https://hl7.org/fhir/uv/ebm) for Extensible and Preferred value sets for evidence-related terminologies.

Definition Element Id ResearchStudy.focus
Definition

Citations, references and The medication(s), food(s), therapy(ies), device(s) or other related documents. concerns or interventions that the study is seeking to gain more information about.

Short Display Drugs, devices, etc. under study
Cardinality 0..*
Terminology Binding Research Study Focus Type ( Example )
Type CodeableReference ( Medication | MedicinalProductDefinition | SubstanceDefinition | DeviceDefinition | PlanDefinition )
Summary false
Element Id ResearchStudy.condition
Definition

The condition that is the focus of the study. For example, In a study to examine risk factors for Lupus, might have as an inclusion criterion "healthy volunteer", but the target condition code would be a Lupus SNOMED code.

Short Display Condition being studied
Cardinality 0..*
Terminology Binding Condition/Problem/Diagnosis Codes ( Example )
Type CodeableConcept
RelatedArtifact Summary true
Definition Element Id ResearchStudy.keyword
Definition

Key terms to aid in searching for or filtering the study.

Short Display Used to search for the study
Cardinality 0..*
Terminology Binding ResearchStudyKeyword : Research Study Focus Type ( Example )
Type CodeableConcept
Summary true
Definition Element Id ResearchStudy.region
Definition

Indicates a A country, state or other region area where the study is taking place. place rather than its precise geographic location or address.

Short Display Geographic area for the study
Cardinality 0..*
Terminology Binding Jurisdiction ValueSet icon ( Extensible Preferred )
Type CodeableConcept
Summary true
Element Id ResearchStudy.descriptionSummary
Definition

A brief text for explaining the study.

Short Display Brief text explaining the study
Cardinality 0..1
Type markdown
Summary false
Definition Element Id ResearchStudy.description
Definition

A full description detailed and human-readable narrative of how the study. E.g., study is being conducted. abstract.

Short Display Detailed narrative of the study
Cardinality 0..1
Type markdown
Summary false
Definition Element Id ResearchStudy.period
Definition

Reference to a Group that defines Identifies the criteria for start date and quantity of subjects participating in the expected (or actual, depending on status) end date for the study. E.g. " 200 female Europeans between

Short Display When the ages of 20 study began and 45 with early onset diabetes". ended
Control Cardinality 0..1
Type Period
Alternate Names timing
Summary true
Element Id ResearchStudy.site
Definition

A facility in which study activities are conducted.

Short Display Facility where study activities are conducted
Cardinality 0..*
Type Reference ( Group Location | ResearchStudy | Organization )
Summary true
patient Element Id ResearchStudy.note
Definition

Comments made about the study by the performer, subject or other participants.

Short Display Comments made about the study
Cardinality 0..*
Type Annotation
Summary true false
Comments Element Id ResearchStudy.classifier
Definition

The Group referenced should Additional grouping mechanism or categorization of a research study. Example: FDA regulated device, FDA regulated drug, MPG Paragraph 23b (a German legal requirement), IRB-exempt, etc. Implementation Note: do not generally enumerate specific subjects. Subjects will be linked use the classifier element to support existing semantics that are already supported thru explicit elements in the resource.

Short Display Classification for the study using
Cardinality 0..*
Terminology Binding Research Study Classifiers ( Example )
Type CodeableConcept
Summary false
Element Id ResearchStudy.associatedParty
Definition

Sponsors, collaborators, and other parties.

Short Display Sponsors, collaborators, and other parties
Cardinality 0..*
Requirements

While there are explicit attributes for a Sponsor and a PrincipalInvestigator many trial record a range of other organizations and individuals in key roles.

Summary false
Comments

For a Sponsor or a PrincipalInvestigator use the ResearchSubject resource. dedicated attributes provided.

To Do Element Id ResearchStudy.associatedParty.name
Definition

Name of associated party.

Short Display Name of associated party
Cardinality 0..1
Type string
Summary false
Element Id ResearchStudy.associatedParty.role
Definition

Type of association.

Short Display sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-chair | irb | data-monitoring
Cardinality 1..1
Terminology Binding Research Study Party Role ( Example )
Type CodeableConcept
Summary false
Element Id ResearchStudy.associatedParty.period
Definition

Identifies the start date and the expected (or actual, depending on status) end date for of the study. associated party in the role.

Short Display When active in the role
Cardinality 0..1 0..*
Type Period
Requirements Summary false
Comments

[The list of types The cardinality is 0..* due to the fact that an associated party may be constrained as appropriate intermittently active in a given role over multiple time periods.

Element Id ResearchStudy.associatedParty.classifier
Definition

A categorization other than role for the type of event]. associated party.

Short Display timing nih | fda | government | nonprofit | academic | industry
Summary Cardinality 0..*
true Terminology Binding Research Study Party Organization Type ( Example )
To Do Type CodeableConcept .effectiveTime.
Summary false
Definition Element Id ResearchStudy.associatedParty.party
Definition

The Individual or organization responsible for the execution of the study. associated with study (use practitionerRole to specify their organisation).

Short Display Individual or organization associated with study (use practitionerRole to specify their organisation)
Cardinality 0..1
Type Reference ( Practitioner | PractitionerRole | Organization )
Summary true false
To Do Comments .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE].

Suggestions of a better attribute name are appreciated

Definition Element Id ResearchStudy.progressStatus
Definition

Indicates the individual who has primary oversite of the execution Status of the study. study with time for that status.

Short Display Status of study with time for that status
Cardinality 0..*
0..1 Summary false
Element Id ResearchStudy.progressStatus.state
Definition

Label for status or state (e.g. recruitment status).

Short Display Label for status or state (e.g. recruitment status)
Cardinality 1..1
Reference Terminology Binding Research Study Status ( Practitioner Example )
Type CodeableConcept
Summary true false
Definition Element Id ResearchStudy.progressStatus.actual
Definition

Clinic, hospital An indication of whether or other healthcare location that not the date is participating in a known date when the study. state changed or will change. A value of true indicates a known date. A value of false indicates an estimated date.

Short Display Actual if true else anticipated
Cardinality 0..* 0..1
Type boolean
Reference Summary ( Location false
Element Id ResearchStudy.progressStatus.period
Definition

Date range.

Short Display Date range
Cardinality 0..1
Type Period
Summary true false
Definition Element Id ResearchStudy.whyStopped
Definition

A description and/or code explaining the premature termination of the study.

Short Display accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
Cardinality 0..1
Terminology Binding ResearchStudyReasonStopped icon ( Example )
Type CodeableConcept
Summary true
Element Id ResearchStudy.recruitment
Definition

Target or actual group of participants enrolled in study.

Short Display Target or actual group of participants enrolled in study
Cardinality 0..1
Summary true
Element Id ResearchStudy.recruitment.targetNumber
Definition

Estimated total number of participants to be enrolled.

Short Display Estimated total number of participants to be enrolled
Cardinality 0..1
Type unsignedInt
Summary false
Element Id ResearchStudy.recruitment.actualNumber
Definition

Comments made about the event by the performer, subject or other participants. Actual total number of participants enrolled in study.

Short Display Actual total number of participants enrolled in study
Cardinality 0..1
0..* Type unsignedInt
Summary false
Element Id ResearchStudy.recruitment.eligibility
Definition

Inclusion and exclusion criteria. The referenced Group Resource should have a membership element value of either 'definitional' or 'conceptual'.

Short Display Inclusion and exclusion criteria
Cardinality 0..1
Type Reference ( Group )
Summary false
Element Id ResearchStudy.recruitment.actualGroup
Definition

Group of participants who were enrolled in study. The referenced Group Resource should have a membership element value of 'enumerated'.

Short Display Group of participants who were enrolled in study
Cardinality 0..1
To Do Type .inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]. Reference ( Group )
Summary true
Element Id ResearchStudy.recruitment.description
Definition

Free text description of the recruitment of the study.

Short Display Description of the recruitment
Cardinality 0..1
Type markdown
Summary false
Element Id ResearchStudy.comparisonGroup
Definition

Describes an expected event or sequence of events for one of the participants subjects of a study. E.g. Exposure for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.

Short Display Defined path through the study for a subject
Cardinality 0..*
Alternate Names arm
Summary false
Comments

In many clinical trials this is refered to as the ARM of the study, but such a term is not used in other sorts of trials even when there is a comparison between two or more groups.

Element Id ResearchStudy.comparisonGroup.targetNumber
Definition

Estimated total number of participants to be enrolled in the comparison group.

Short Display Estimated total number of participants to be enrolled in the comparison group
Cardinality 0..1
Type unsignedInt
Summary false
Element Id ResearchStudy.comparisonGroup.actualNumber
Definition

Actual total number of participants enrolled in the comparison group.

Short Display Actual total number of participants enrolled in the comparison group
Cardinality 0..1
Type unsignedInt
Summary false
Element Id ResearchStudy.comparisonGroup.eligibility
Definition

Inclusion and exclusion criteria for the comparison group as a subset of the eligibility for the overall study. The referenced Group Resource should have a membership element value of either 'definitional' or 'conceptual'.

Short Display Inclusion and exclusion criteria for the comparison group
Cardinality 0..1
Type Reference ( Group )
Summary false
Element Id ResearchStudy.comparisonGroup.observedGroup
Definition

Group of participants who were enrolled in the comparison group as a subset of those enrolled in the overall study. The referenced Group Resource should have a membership element value of 'enumerated'.

Short Display Group of participants who were enrolled in the comparison group
Cardinality 0..1
Type Reference ( Group )
Summary false
Element Id ResearchStudy.comparisonGroup.description
Definition

Description of the comparison Group.

Short Display Description of the comparison Group
Cardinality 0..1
Type markdown
Summary false
Element Id ResearchStudy.objective
Definition

A goal that the study is aiming to achieve in terms of a scientific question to be answered by the analysis of data collected during the study.

Short Display A goal for the study
Cardinality 0..*
Summary false
Element Id ResearchStudy.objective.name
Definition

Unique, human-readable label for this arm objective of the study.

Short Display Label for the objective
Cardinality 1..1 0..1
Type string
Summary false
Definition Element Id ResearchStudy.objective.type
Definition

Categorization The kind of study arm, e.g. experimental, active comparator, placebo comparater. objective.

Short Display primary | secondary | exploratory
Cardinality 0..1
Terminology Binding ResearchStudyObjectiveType icon ( Preferred )
Type CodeableConcept
Summary false
Definition Element Id ResearchStudy.objective.description
Definition

A succinct Free text description of the path through objective of the study. This is what the study is trying to achieve rather than how it is going to achieve it (see ResearchStudy.description).

Short Display Description of the objective
Cardinality 0..1
Type markdown
Summary false
Element Id ResearchStudy.objective.outcomeMeasure
Definition

An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.

Short Display A variable measured during the study
Cardinality 0..*
Summary false
Comments

A study may have multiple distinct outcome measures that would can be followed by used to assess the overall goal for a subject adhering study. The goal of a study is in the objective whereas the metric by which the goal is assessed is the outcomeMeasure. Examples: Time to Local Recurrence (TLR), Disease-free Survival (DFS), 30 Day Mortality, Systolic BP

Element Id ResearchStudy.objective.outcomeMeasure.name
Definition

Label for the outcome measure.

Short Display Label for the outcome measure
Cardinality 0..1
Type string
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.type
Definition

The kind of outcome measure.

Short Display primary | secondary | exploratory
Cardinality 0..1
Terminology Binding ResearchStudyObjectiveType icon ( Preferred )
Type CodeableConcept
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.description
Definition

Description of the outcome measure.

Short Display Description of the outcome measure
Cardinality 0..1
Type markdown
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.endpoint
Definition

Definition of the outcome measure.

Short Display Definition of the outcome measure
Cardinality 1..1
Type Reference ( EvidenceVariable )
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.population
Definition

Population for this arm. estimand.

Short Display Population for this estimand
Cardinality 0..1
Type Reference ( Group )
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.intervention
Definition

Comparison group of interest.

Short Display Comparison group of interest
Cardinality 0..1
Type Reference ( Group )
string Summary false
Comments

To re-use and reference a Group represented in ResearchStudy.comparisonGroup.eligibility, one may include the Group Resource in ResearchStudy.contained and then reference the same (internal) Group by its id

Element Id ResearchStudy.objective.outcomeMeasure.comparator
Definition

Comparison group for comparison.

Short Display Comparison group for comparison
Cardinality 0..1
Type Reference ( Group )
Summary false
Comments

To re-use and reference a Group represented in ResearchStudy.comparisonGroup.eligibility, one may include the Group Resource in ResearchStudy.contained and then reference the same (internal) Group by its id

Element Id ResearchStudy.objective.outcomeMeasure.summaryMeasure
Definition

Statistical measure for treatment effect estimate.

Short Display Statistical measure for treatment effect estimate
Cardinality 0..1
Terminology Binding StatisticStatisticType icon ( Example )
Type CodeableConcept
Summary false
Comments

See the Evidence Based Medicine on FHIR Implementation Guide (https://hl7.org/fhir/uv/ebm) for Extensible and Preferred value sets for evidence-related terminologies.

Element Id ResearchStudy.objective.outcomeMeasure.endpointAnalysisPlan
Definition

The planned statistical model for analysis of a single endpoint.

Short Display Statistical analysis plan for a single endpoint
Cardinality 0..1
Type Reference ( Evidence )
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.eventHandling
Definition

Handling of intercurrent event.

Short Display Handling of intercurrent event
Cardinality 0..*
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.eventHandling.event
Definition

The event.

Short Display The event
Cardinality 0..1
Type CodeableConcept
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.eventHandling.group
Definition

The group that is affected by this event handling.

Short Display The group that is affected by this event handling
Cardinality 0..1
Type CodeableConcept
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.eventHandling.handling
Definition

How the data is handled.

Short Display How the data is handled
Cardinality 0..1
Type CodeableConcept
Summary false
Element Id ResearchStudy.objective.outcomeMeasure.eventHandling.description
Definition

Text summary of event handling.

Short Display Text summary of event handling
Cardinality 0..1
Type markdown
Summary false
Element Id ResearchStudy.result
Definition

Link to one or more sets of results generated by the study. Could also link to a research registry holding the results such as ClinicalTrials.gov.

Short Display Link to results generated during the study
Cardinality 0..*
Type Reference ( Composition | DiagnosticReport | Evidence )
Summary true