This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0:
R5
-
STU
).
The
This
is
the
current
published
version
which
supercedes
in
it's
permanent
home
(it
will
always
be
available
at
this
version
is
5.0.0
.
URL).
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R5
R4B
R4
R3
Biomedical
Research
and
Regulation
Work
Group
|
Maturity
Level
:
|
Trial Use | Security Category : Business |
Compartments
:
|
A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future.
This resource is a definition resource from a FHIR workflow perspective - see Workflow .
A
process
where
a
researcher
or
organization
plans
and
then
executes
a
series
of
steps
intended
to
increase
the
field
of
healthcare-related
knowledge.
This
includes
studies
of
safety,
efficacy,
comparative
effectiveness
and
other
information
about
medications,
devices,
therapies
and
other
interventional
and
investigative
techniques.
A
ResearchStudy
involves
the
gathering
of
information
about
human
or
animal
subjects.
8.22.1
Scope
and
Usage
This
resource
is
an
definition
resource
from
a
FHIR
workflow
perspective
-
see
Workflow
.
subjects
or
stability
data
about
drug
products
or
drug
substances.
For clinical trials -- A research study is a scientific way to improve or develop new methods of health care. Studies are designed to answer specific questions on how to prevent, diagnose, or treat diseases and disorders. The ResearchStudy resource describes essential information about the study, including the purpose, objective, sponsor, investigator, therapy, condition being studied, schedule of activities, and other key items.
Uses for the ResearchStudy resource include:
ResearchStudy is aimed at all forms of studies. For some study types specific extensions have been defined
Extension: SiteRecruitment
Some studies need to find sites according to specific criteria - for example site has a freezer capable of very low temperatures and a centrifuge.
Extension: StudyRegistration
Used to separate study registration activities from study progress status.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Investigation
to
increase
healthcare-related
patient-independent
knowledge
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..1 | uri |
Canonical
identifier
for
this
study
resource
| |
![]() ![]() | Σ | 0..* | Identifier |
Business
Identifier
for
study
|
| 0..1 | string |
The
business
version
for
the
study
record
| |
|
0..1 | string |
Name
for
this
study
(computer
friendly)
| |
![]() ![]() | Σ | 0..1 | string |
Human
readable
name
of
the
study
|
![]() ![]() | 0..* |
|
Additional
names
for
|
|
| 0..1 | CodeableConcept |
primary
|
official
|
scientific
|
plain-language
|
subtitle
|
short-title
|
acronym
|
earlier-title
|
language
|
auto-translated
|
human-use
|
machine-use
|
duplicate-uid
Binding: Title Type ( Extensible ) | |
![]() ![]() ![]() | 0..1 | string |
The
name
| |
|
Σ | 0..* | Reference ( PlanDefinition ) |
Steps
followed
in
executing
study
|
|
Σ | 0..* | Reference ( ResearchStudy ) |
Part
of
larger
study
|
| 0..* | RelatedArtifact |
References,
URLs,
and
attachments
| |
![]() ![]() | 0..1 | dateTime |
Date
the
resource
last
changed
| |
|
?! Σ | 1..1 | code |
|
|
Σ | 0..1 | CodeableConcept |
treatment
|
prevention
|
diagnostic
|
supportive-care
|
screening
|
health-services-research
|
basic-science
|
device-feasibility
Binding: |
|
Σ | 0..1 | CodeableConcept |
n-a
|
early-phase-1
|
phase-1
|
phase-1-phase-2
|
phase-2
|
phase-2-phase-3
|
phase-3
|
phase-4
Binding: |
|
Σ | 0..* | CodeableConcept |
Classifications
|
|
0..* |
|
Drugs,
devices,
etc.
under
study
|
|
|
Σ | 0..* | CodeableConcept |
Condition
being
studied
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
Σ | 0..* |
|
Binding: ResearchStudyKeyword ( Example ) |
|
Σ | 0..* |
|
Binding: Jurisdiction ValueSet ( Extensible ) |
|
|
|
|
|
|
|
|
|
|
|
Σ | 0..1 |
|
|
|
Σ | 0..* |
Reference
(
|
|
|
0..* | Annotation |
|
|
|
0..* | CodeableConcept |
Classification
for
the
study
Binding: Research Study Classifiers ( Example ) | |
![]() ![]() | 0..* | BackboneElement |
Sponsors,
collaborators,
and
|
|
|
0..1 |
|
|
|
| 1..1 | CodeableConcept |
sponsor
|
lead-sponsor
|
sponsor-investigator
|
primary-investigator
|
collaborator
|
funding-source
|
general-contact
|
recruitment-contact
|
sub-investigator
|
study-director
|
study-chair
Binding: Research Study Party Role ( |
|
|
| Period |
When
active
in
the
|
|
|
0..* | CodeableConcept |
nih
|
fda
|
government
|
nonprofit
|
academic
|
industry
Binding: Research Study Party Organization Type ( Example ) | |
![]() ![]() ![]() | 0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Individual
or
organization
associated
with
study
(use
practitionerRole
to
specify
their
organisation)
| |
![]() ![]() |
| BackboneElement |
Status
of
|
|
|
1..1 | CodeableConcept |
Binding: Research Study Status ( Extensible ) |
|
|
0..1 | boolean |
Actual
if
true
else
anticipated
| |
![]() ![]() ![]() |
| Period |
Date
range
|
|
|
Σ | 0..1 | CodeableConcept |
accrual-goal-met
|
closed-due-to-toxicity
|
closed-due-to-lack-of-study-progress
|
temporarily-closed-per-study-design
Binding: |
| Σ | 0..1 | BackboneElement |
Target
or
actual
group
of
participants
enrolled
in
study
|
|
0..1 | unsignedInt |
Estimated
total
number
of
participants
to
be
enrolled
| |
![]() ![]() ![]() |
0..1 | unsignedInt |
| |
![]() ![]() ![]() | 0..1 | Reference ( Group | EvidenceVariable ) |
Inclusion
and
exclusion
criteria
| |
![]() ![]() ![]() |
|
| Reference ( Group ) |
Group
of
participants
who
were
enrolled
in
study
|
|
0..* | BackboneElement |
Defined
path
through
the
study
for
a
subject
|
|
|
0..1 | id |
Allows
the
comparisonGroup
for
the
study
and
the
comparisonGroup
for
the
subject
to
be
linked
easily
| |
![]() ![]() ![]() | 1..1 | string |
Label
for
study
|
|
|
0..1 | CodeableConcept |
Categorization
of
study
Binding: Research Study Arm Type ( Extensible ) |
|
|
0..1 |
|
Short
explanation
of
study
path
|
|
|
0..* | Reference ( EvidenceVariable ) |
Interventions
or
exposures
in
this
comparisonGroup
or
cohort
| |
![]() ![]() ![]() |
0..1 | Reference ( Group ) |
Group
of
participants
who
were
enrolled
in
study
comparisonGroup
| |
![]() ![]() | 0..* | BackboneElement |
A
goal
for
the
study
|
|
|
0..1 | string |
Label
for
the
objective
|
|
|
0..1 | CodeableConcept |
primary
|
secondary
|
exploratory
Binding: Research Study Objective Type ( Preferred ) | |
![]() ![]() ![]() | 0..1 | markdown |
Description
of
the
objective
| |
![]() ![]() | 0..* | BackboneElement |
A
variable
measured
during
the
study
| |
![]() ![]() ![]() | 0..1 | string |
Label
for
the
outcome
| |
![]() ![]() ![]() | 0..* | CodeableConcept |
primary
|
secondary
|
exploratory
Binding: |
|
| 0..1 | markdown |
Description
of
the
outcome
| |
![]() ![]() ![]() | 0..1 | Reference ( EvidenceVariable ) |
Structured
outcome
definition
| |
![]() ![]() | Σ | 0..* | Reference ( EvidenceReport | Citation | DiagnosticReport ) |
Link
to
results
generated
during
the
study
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<<ResearchStudy xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this study resource --> <identifier><!-- 0..* Identifier Business Identifier for study --></identifier>
<<version value="[string]"/><!-- 0..1 The business version for the study record --> <name value="[string]"/><!-- 0..1 Name for this study (computer friendly) --> <title value="[string]"/><!-- 0..1 Human readable name of the study --> <label> <!-- 0..* Additional names for the study --> <type><!-- 0..1 CodeableConcept primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid --></type> <value value="[string]"/><!-- 0..1 The name --> </label> <protocol><!-- 0..* Reference(PlanDefinition) Steps followed in executing study --></protocol> <partOf><!-- 0..* Reference(ResearchStudy) Part of larger study --></partOf>< <</primaryPurposeType><relatedArtifact><!-- 0..* RelatedArtifact References, URLs, and attachments --></relatedArtifact> <date value="[dateTime]"/><!-- 0..1 Date the resource last changed --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <primaryPurposeType><!-- 0..1 CodeableConcept treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility --></primaryPurposeType> <phase><!-- 0..1 CodeableConcept n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 --></phase><</category> <</focus><studyDesign><!-- 0..* CodeableConcept Classifications of the study design characteristics --></studyDesign> <focus><!-- 0..* CodeableReference(EvidenceVariable|Medication| MedicinalProductDefinition|SubstanceDefinition) Drugs, devices, etc. under study --></focus> <condition><!-- 0..* CodeableConcept Condition being studied --></condition><</contact> <</relatedArtifact><keyword><!-- 0..* CodeableConcept Used to search for the study --></keyword><</location> < <</enrollment><region><!-- 0..* CodeableConcept Geographic area for the study --></region> <descriptionSummary value="[markdown]"/><!-- 0..1 Brief text explaining the study --> <description value="[markdown]"/><!-- 0..1 Detailed narrative of the study --> <period><!-- 0..1 Period When the study began and ended --></period><</sponsor> <</principalInvestigator> <</site> <</reasonStopped><site><!-- 0..* Reference(Location|Organization|ResearchStudy) Facility where study activities are conducted --></site> <note><!-- 0..* Annotation Comments made about the study --></note>< < <</type> < </arm><classifier><!-- 0..* CodeableConcept Classification for the study --></classifier> <associatedParty> <!-- 0..* Sponsors, collaborators, and other parties --> <name value="[string]"/><!-- 0..1 Name of associated party --> <role><!-- 1..1 CodeableConcept sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair --></role> <period><!-- 0..* Period When active in the role --></period> <classifier><!-- 0..* CodeableConcept nih | fda | government | nonprofit | academic | industry --></classifier> <party><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Individual or organization associated with study (use practitionerRole to specify their organisation) --></party> </associatedParty> <progressStatus> <!-- 0..* Status of study with time for that status --> <state><!-- 1..1 CodeableConcept Label for status or state (e.g. recruitment status) --></state> <actual value="[boolean]"/><!-- 0..1 Actual if true else anticipated --> <period><!-- 0..1 Period Date range --></period> </progressStatus> <whyStopped><!-- 0..1 CodeableConcept accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design --></whyStopped> <recruitment> <!-- 0..1 Target or actual group of participants enrolled in study --> <targetNumber value="[unsignedInt]"/><!-- 0..1 Estimated total number of participants to be enrolled --> <actualNumber value="[unsignedInt]"/><!-- 0..1 Actual total number of participants enrolled in study --> <eligibility><!-- 0..1 Reference(EvidenceVariable|Group) Inclusion and exclusion criteria --></eligibility> <actualGroup><!-- 0..1 Reference(Group) Group of participants who were enrolled in study --></actualGroup> </recruitment> <comparisonGroup> <!-- 0..* Defined path through the study for a subject --> <linkId value="[id]"/><!-- 0..1 Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily --> <name value="[string]"/><!-- 1..1 Label for study comparisonGroup --> <type><!-- 0..1 CodeableConcept Categorization of study comparisonGroup --></type> <description value="[markdown]"/><!-- 0..1 Short explanation of study path --> <intendedExposure><!-- 0..* Reference(EvidenceVariable) Interventions or exposures in this comparisonGroup or cohort --></intendedExposure> <observedGroup><!-- 0..1 Reference(Group) Group of participants who were enrolled in study comparisonGroup --></observedGroup> </comparisonGroup> <objective> <!-- 0..* A goal for the study --> <name value="[string]"/><!-- 0..1 Label for the objective --> <type><!-- 0..1 CodeableConcept primary | secondary | exploratory --></type> <description value="[markdown]"/><!-- 0..1 Description of the objective --> </objective> <outcomeMeasure> <!-- 0..* A variable measured during the study --> <name value="[string]"/><!-- 0..1 Label for the outcome --> <type><!-- 0..* CodeableConcept primary | secondary | exploratory --></type> <description value="[markdown]"/><!-- 0..1 Description of the outcome --> <reference><!-- 0..1 Reference(EvidenceVariable) Structured outcome definition --></reference> </outcomeMeasure> <result><!-- 0..* Reference(Citation|DiagnosticReport|EvidenceReport) Link to results generated during the study --></result> </ResearchStudy>
JSON Template
{
"resourceType" : "",
"resourceType" : "ResearchStudy",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this study resource
"identifier" : [{ Identifier }], // Business Identifier for study
"
"version" : "<string>", // The business version for the study record
"name" : "<string>", // Name for this study (computer friendly)
"title" : "<string>", // Human readable name of the study
"label" : [{ // Additional names for the study
"type" : { CodeableConcept }, // primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid
"value" : "<string>" // The name
}],
"protocol" : [{ Reference(PlanDefinition) }], // Steps followed in executing study
"partOf" : [{ Reference(ResearchStudy) }], // Part of larger study
"
"
"relatedArtifact" : [{ RelatedArtifact }], // References, URLs, and attachments
"date" : "<dateTime>", // Date the resource last changed
"status" : "<code>", // R! draft | active | retired | unknown
"primaryPurposeType" : { CodeableConcept }, // treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
"phase" : { CodeableConcept }, // n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
"
"
"studyDesign" : [{ CodeableConcept }], // Classifications of the study design characteristics
"focus" : [{ CodeableReference(EvidenceVariable|Medication|
MedicinalProductDefinition|SubstanceDefinition) }], // Drugs, devices, etc. under study
"condition" : [{ CodeableConcept }], // Condition being studied
"
"
"keyword" : [{ CodeableConcept }], // Used to search for the study
"
"
"
"region" : [{ CodeableConcept }], // Geographic area for the study
"descriptionSummary" : "<markdown>", // Brief text explaining the study
"description" : "<markdown>", // Detailed narrative of the study
"period" : { Period }, // When the study began and ended
"
"
"
"
"site" : [{ Reference(Location|Organization|ResearchStudy) }], // Facility where study activities are conducted
"note" : [{ Annotation }], // Comments made about the study
"
"
"
"
"classifier" : [{ CodeableConcept }], // Classification for the study
"associatedParty" : [{ // Sponsors, collaborators, and other parties
"name" : "<string>", // Name of associated party
"role" : { CodeableConcept }, // R! sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair
"period" : [{ Period }], // When active in the role
"classifier" : [{ CodeableConcept }], // nih | fda | government | nonprofit | academic | industry
"party" : { Reference(Organization|Practitioner|PractitionerRole) } // Individual or organization associated with study (use practitionerRole to specify their organisation)
}],
"progressStatus" : [{ // Status of study with time for that status
"state" : { CodeableConcept }, // R! Label for status or state (e.g. recruitment status)
"actual" : <boolean>, // Actual if true else anticipated
"period" : { Period } // Date range
}],
"whyStopped" : { CodeableConcept }, // accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
"recruitment" : { // Target or actual group of participants enrolled in study
"targetNumber" : "<unsignedInt>", // Estimated total number of participants to be enrolled
"actualNumber" : "<unsignedInt>", // Actual total number of participants enrolled in study
"eligibility" : { Reference(EvidenceVariable|Group) }, // Inclusion and exclusion criteria
"actualGroup" : { Reference(Group) } // Group of participants who were enrolled in study
},
"comparisonGroup" : [{ // Defined path through the study for a subject
"linkId" : "<id>", // Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily
"name" : "<string>", // R! Label for study comparisonGroup
"type" : { CodeableConcept }, // Categorization of study comparisonGroup
"description" : "<markdown>", // Short explanation of study path
"intendedExposure" : [{ Reference(EvidenceVariable) }], // Interventions or exposures in this comparisonGroup or cohort
"observedGroup" : { Reference(Group) } // Group of participants who were enrolled in study comparisonGroup
}],
"objective" : [{ // A goal for the study
"name" : "<string>", // Label for the objective
"
}]
"type" : { CodeableConcept }, // primary | secondary | exploratory
"description" : "<markdown>" // Description of the objective
}],
"outcomeMeasure" : [{ // A variable measured during the study
"name" : "<string>", // Label for the outcome
"type" : [{ CodeableConcept }], // primary | secondary | exploratory
"description" : "<markdown>", // Description of the outcome
"reference" : { Reference(EvidenceVariable) } // Structured outcome definition
}],
"result" : [{ Reference(Citation|DiagnosticReport|EvidenceReport) }] // Link to results generated during the study
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:ResearchStudy; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtensionfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: ], ...;fhir:url [ uri ] ; # 0..1 Canonical identifier for this study resource fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifier for study fhir:version [ string ] ; # 0..1 The business version for the study record fhir:name [ string ] ; # 0..1 Name for this study (computer friendly) fhir:title [ string ] ; # 0..1 Human readable name of the study fhir:label ( [ # 0..* Additional names for the study fhir:type [ CodeableConcept ] ; # 0..1 primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid fhir:value [ string ] ; # 0..1 The name ] ... ) ; fhir:protocol ( [ Reference(PlanDefinition) ] ... ) ; # 0..* Steps followed in executing study fhir:partOf ( [ Reference(ResearchStudy) ] ... ) ; # 0..* Part of larger study fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* References, URLs, and attachments fhir:date [ dateTime ] ; # 0..1 Date the resource last changed fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:primaryPurposeType [ CodeableConcept ] ; # 0..1 treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility fhir:phase [ CodeableConcept ] ; # 0..1 n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 fhir:studyDesign ( [ CodeableConcept ] ... ) ; # 0..* Classifications of the study design characteristics fhir:focus ( [ CodeableReference(EvidenceVariable|Medication|MedicinalProductDefinition|SubstanceDefinition) ] ... ) ; # 0..* Drugs, devices, etc. under study fhir:condition ( [ CodeableConcept ] ... ) ; # 0..* Condition being studied fhir:keyword ( [ CodeableConcept ] ... ) ; # 0..* Used to search for the study fhir:region ( [ CodeableConcept ] ... ) ; # 0..* Geographic area for the study fhir:descriptionSummary [ markdown ] ; # 0..1 Brief text explaining the study fhir:description [ markdown ] ; # 0..1 Detailed narrative of the study fhir:period [ Period ] ; # 0..1 When the study began and ended fhir:site ( [ Reference(Location|Organization|ResearchStudy) ] ... ) ; # 0..* Facility where study activities are conducted fhir:note ( [ Annotation ] ... ) ; # 0..* Comments made about the study fhir:classifier ( [ CodeableConcept ] ... ) ; # 0..* Classification for the study fhir:associatedParty ( [ # 0..* Sponsors, collaborators, and other parties fhir:name [ string ] ; # 0..1 Name of associated party fhir:role [ CodeableConcept ] ; # 1..1 sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair fhir:period ( [ Period ] ... ) ; # 0..* When active in the role fhir:classifier ( [ CodeableConcept ] ... ) ; # 0..* nih | fda | government | nonprofit | academic | industry fhir:party [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Individual or organization associated with study (use practitionerRole to specify their organisation) ] ... ) ; fhir:progressStatus ( [ # 0..* Status of study with time for that status fhir:state [ CodeableConcept ] ; # 1..1 Label for status or state (e.g. recruitment status) fhir:actual [ boolean ] ; # 0..1 Actual if true else anticipated fhir:period [ Period ] ; # 0..1 Date range ] ... ) ; fhir:whyStopped [ CodeableConcept ] ; # 0..1 accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design fhir:recruitment [ # 0..1 Target or actual group of participants enrolled in study fhir:targetNumber [ unsignedInt ] ; # 0..1 Estimated total number of participants to be enrolled fhir:actualNumber [ unsignedInt ] ; # 0..1 Actual total number of participants enrolled in study fhir:eligibility [ Reference(EvidenceVariable|Group) ] ; # 0..1 Inclusion and exclusion criteria fhir:actualGroup [ Reference(Group) ] ; # 0..1 Group of participants who were enrolled in study ] ; fhir:comparisonGroup ( [ # 0..* Defined path through the study for a subject fhir:linkId [ id ] ; # 0..1 Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily fhir:name [ string ] ; # 1..1 Label for study comparisonGroup fhir:type [ CodeableConcept ] ; # 0..1 Categorization of study comparisonGroup fhir:description [ markdown ] ; # 0..1 Short explanation of study path fhir:intendedExposure ( [ Reference(EvidenceVariable) ] ... ) ; # 0..* Interventions or exposures in this comparisonGroup or cohort fhir:observedGroup [ Reference(Group) ] ; # 0..1 Group of participants who were enrolled in study comparisonGroup ] ... ) ; fhir:objective ( [ # 0..* A goal for the study fhir:name [ string ] ; # 0..1 Label for the objective fhir:type [ CodeableConcept ] ; # 0..1 primary | secondary | exploratory fhir:description [ markdown ] ; # 0..1 Description of the objective ] ... ) ; fhir:outcomeMeasure ( [ # 0..* A variable measured during the study fhir:name [ string ] ; # 0..1 Label for the outcome fhir:type ( [ CodeableConcept ] ... ) ; # 0..* primary | secondary | exploratory fhir:description [ markdown ] ; # 0..1 Description of the outcome fhir:reference [ Reference(EvidenceVariable) ] ; # 0..1 Structured outcome definition ] ... ) ; fhir:result ( [ Reference(Citation|DiagnosticReport|EvidenceReport) ] ... ) ; # 0..* Link to results generated during the study ]
Changes
since
from
both
R4
and
R4B
| ResearchStudy | |
| ResearchStudy.url |
|
| ResearchStudy.version |
|
| ResearchStudy.name |
|
| ResearchStudy.label |
|
| ResearchStudy.label.type |
|
| ResearchStudy.label.value |
|
| ResearchStudy.date |
|
| ResearchStudy.status |
|
| ResearchStudy.primaryPurposeType |
|
| ResearchStudy.studyDesign |
|
| ResearchStudy.focus |
|
| ResearchStudy.region |
|
| ResearchStudy.descriptionSummary |
|
| ResearchStudy.site |
|
| ResearchStudy.classifier |
|
| ResearchStudy.associatedParty |
|
| ResearchStudy.associatedParty.name |
|
| ResearchStudy.associatedParty.role |
|
| ResearchStudy.associatedParty.period |
|
| ResearchStudy.associatedParty.classifier |
|
| ResearchStudy.associatedParty.party |
|
| ResearchStudy.progressStatus |
|
| ResearchStudy.progressStatus.state |
|
| ResearchStudy.progressStatus.actual |
|
| ResearchStudy.progressStatus.period |
|
| ResearchStudy.whyStopped |
|
| ResearchStudy.recruitment |
|
| ResearchStudy.recruitment.targetNumber |
|
| ResearchStudy.recruitment.actualNumber |
|
| ResearchStudy.recruitment.eligibility |
|
| ResearchStudy.recruitment.actualGroup |
|
| ResearchStudy.comparisonGroup |
|
| ResearchStudy.comparisonGroup.linkId |
|
| ResearchStudy.comparisonGroup.name |
|
| ResearchStudy.comparisonGroup.type |
|
| ResearchStudy.comparisonGroup.description |
|
| ResearchStudy.comparisonGroup.intendedExposure |
|
| ResearchStudy.comparisonGroup.observedGroup |
|
| ResearchStudy.objective.description |
|
| ResearchStudy.outcomeMeasure |
|
| ResearchStudy.outcomeMeasure.name |
|
| ResearchStudy.outcomeMeasure.type |
|
| ResearchStudy.outcomeMeasure.description |
|
| ResearchStudy.outcomeMeasure.reference |
|
| ResearchStudy.result |
|
| ResearchStudy.category |
|
| ResearchStudy.contact |
|
| ResearchStudy.location |
|
| ResearchStudy.enrollment |
|
| ResearchStudy.sponsor |
|
| ResearchStudy.principalInvestigator |
|
| ResearchStudy.reasonStopped |
|
| ResearchStudy.arm |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
Conversions
between
R3
and
R4
for
R4B
as
XML
or
JSON
.
See
R3
<-->
R4
<-->
R5
Conversion
Maps
(status
=
1
test
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.)
See
Conversions
Summary
.)
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
Investigation
to
increase
healthcare-related
patient-independent
knowledge
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
0..1 | uri |
Canonical
identifier
for
this
study
resource
| |
![]() ![]() | Σ | 0..* | Identifier |
Business
Identifier
for
study
|
| 0..1 | string |
The
business
version
for
the
study
record
| |
|
0..1 | string |
Name
for
this
study
(computer
friendly)
| |
![]() ![]() | Σ | 0..1 | string |
Human
readable
name
of
the
study
|
![]() ![]() |
| BackboneElement |
Additional
names
for
|
|
| 0..1 | CodeableConcept |
primary
|
official
|
scientific
|
plain-language
|
subtitle
|
short-title
|
acronym
|
earlier-title
|
language
|
auto-translated
|
human-use
|
machine-use
|
duplicate-uid
Binding: Title Type ( Extensible ) | |
![]() ![]() ![]() | 0..1 | string |
The
name
| |
|
Σ | 0..* | Reference ( PlanDefinition ) |
Steps
followed
in
executing
study
|
|
Σ | 0..* | Reference ( ResearchStudy ) |
Part
of
larger
study
|
| 0..* | RelatedArtifact |
References,
URLs,
and
attachments
| |
![]() ![]() | 0..1 | dateTime |
Date
the
resource
last
changed
| |
|
?! Σ | 1..1 | code |
|
|
Σ | 0..1 | CodeableConcept |
treatment
|
prevention
|
diagnostic
|
supportive-care
|
screening
|
health-services-research
|
basic-science
|
device-feasibility
Binding: |
|
Σ | 0..1 | CodeableConcept |
n-a
|
early-phase-1
|
phase-1
|
phase-1-phase-2
|
phase-2
|
phase-2-phase-3
|
phase-3
|
phase-4
Binding: |
|
Σ | 0..* | CodeableConcept |
Classifications
|
|
0..* |
|
Drugs,
devices,
etc.
under
study
|
|
|
Σ | 0..* | CodeableConcept |
Condition
being
studied
Binding: Condition/Problem/Diagnosis Codes ( Example ) |
|
Σ | 0..* |
|
Binding: ResearchStudyKeyword ( Example ) |
|
Σ | 0..* |
|
Binding: Jurisdiction ValueSet ( Extensible ) |
|
|
|
|
|
|
|
|
|
|
|
Σ | 0..1 |
|
|
|
Σ | 0..* |
Reference
(
|
|
|
0..* | Annotation |
|
|
|
0..* | CodeableConcept |
Classification
for
the
study
Binding: Research Study Classifiers ( Example ) | |
![]() ![]() | 0..* | BackboneElement |
Sponsors,
collaborators,
and
|
|
|
0..1 | string |
|
|
| 1..1 | CodeableConcept |
sponsor
|
lead-sponsor
|
sponsor-investigator
|
primary-investigator
|
collaborator
|
funding-source
|
general-contact
|
recruitment-contact
|
sub-investigator
|
study-director
|
study-chair
Binding: Research Study Party Role ( |
|
| 0..* |
|
When
active
in
the
|
|
|
0..* | CodeableConcept |
nih
|
fda
|
government
|
nonprofit
|
academic
|
industry
Binding: Research Study Party Organization Type ( Example ) | |
![]() ![]() ![]() | 0..1 | Reference ( Practitioner | PractitionerRole | Organization ) |
Individual
or
organization
associated
with
study
(use
practitionerRole
to
specify
their
organisation)
| |
![]() ![]() |
| BackboneElement |
Status
of
|
|
|
1..1 |
|
Binding: Research Study Status ( Extensible ) |
|
|
0..1 | boolean |
Actual
if
true
else
anticipated
|
|
|
| Period |
Date
range
|
|
|
Σ | 0..1 | CodeableConcept |
accrual-goal-met
|
closed-due-to-toxicity
|
closed-due-to-lack-of-study-progress
|
temporarily-closed-per-study-design
Binding: |
| Σ | 0..1 | BackboneElement |
Target
or
actual
group
of
participants
enrolled
in
study
|
|
0..1 | unsignedInt |
Estimated
total
number
of
participants
to
be
enrolled
| |
![]() ![]() ![]() | 0..1 | unsignedInt |
| |
![]() ![]() ![]() | 0..1 | Reference ( Group | EvidenceVariable ) |
Inclusion
and
exclusion
criteria
| |
![]() ![]() ![]() |
|
| Reference ( Group ) |
Group
of
participants
who
were
enrolled
in
study
|
|
0..* | BackboneElement |
Defined
path
through
the
study
for
a
subject
|
|
|
0..1 | id |
Allows
the
comparisonGroup
for
the
study
and
the
comparisonGroup
for
the
subject
to
be
linked
easily
| |
![]() ![]() ![]() | 1..1 | string |
Label
for
study
|
|
|
0..1 | CodeableConcept |
Categorization
of
study
Binding: Research Study Arm Type ( Extensible ) |
|
|
0..1 |
|
Short
explanation
of
study
path
|
|
|
0..* | Reference ( EvidenceVariable ) |
Interventions
or
exposures
in
this
comparisonGroup
or
cohort
| |
![]() ![]() ![]() | 0..1 | Reference ( Group ) |
Group
of
participants
who
were
enrolled
in
study
comparisonGroup
| |
![]() ![]() | 0..* | BackboneElement |
A
goal
for
the
study
|
|
|
0..1 | string |
Label
for
the
objective
|
|
|
0..1 | CodeableConcept |
primary
|
secondary
|
exploratory
Binding: Research Study Objective Type ( Preferred ) | |
![]() ![]() ![]() | 0..1 | markdown |
Description
of
the
objective
| |
![]() ![]() | 0..* | BackboneElement |
A
variable
measured
during
the
study
| |
![]() ![]() ![]() |
0..1 | string |
Label
for
the
outcome
| |
![]() ![]() ![]() | 0..* | CodeableConcept |
primary
|
secondary
|
exploratory
Binding: |
|
| 0..1 | markdown |
Description
of
the
outcome
| |
![]() ![]() ![]() | 0..1 | Reference ( EvidenceVariable ) |
Structured
outcome
definition
| |
![]() ![]() | Σ | 0..* | Reference ( EvidenceReport | Citation | DiagnosticReport ) |
Link
to
results
generated
during
the
study
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<<ResearchStudy xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Canonical identifier for this study resource --> <identifier><!-- 0..* Identifier Business Identifier for study --></identifier>
<<version value="[string]"/><!-- 0..1 The business version for the study record --> <name value="[string]"/><!-- 0..1 Name for this study (computer friendly) --> <title value="[string]"/><!-- 0..1 Human readable name of the study --> <label> <!-- 0..* Additional names for the study --> <type><!-- 0..1 CodeableConcept primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid --></type> <value value="[string]"/><!-- 0..1 The name --> </label> <protocol><!-- 0..* Reference(PlanDefinition) Steps followed in executing study --></protocol> <partOf><!-- 0..* Reference(ResearchStudy) Part of larger study --></partOf>< <</primaryPurposeType><relatedArtifact><!-- 0..* RelatedArtifact References, URLs, and attachments --></relatedArtifact> <date value="[dateTime]"/><!-- 0..1 Date the resource last changed --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <primaryPurposeType><!-- 0..1 CodeableConcept treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility --></primaryPurposeType> <phase><!-- 0..1 CodeableConcept n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 --></phase><</category> <</focus><studyDesign><!-- 0..* CodeableConcept Classifications of the study design characteristics --></studyDesign> <focus><!-- 0..* CodeableReference(EvidenceVariable|Medication| MedicinalProductDefinition|SubstanceDefinition) Drugs, devices, etc. under study --></focus> <condition><!-- 0..* CodeableConcept Condition being studied --></condition><</contact> <</relatedArtifact><keyword><!-- 0..* CodeableConcept Used to search for the study --></keyword><</location> < <</enrollment><region><!-- 0..* CodeableConcept Geographic area for the study --></region> <descriptionSummary value="[markdown]"/><!-- 0..1 Brief text explaining the study --> <description value="[markdown]"/><!-- 0..1 Detailed narrative of the study --> <period><!-- 0..1 Period When the study began and ended --></period><</sponsor> <</principalInvestigator> <</site> <</reasonStopped><site><!-- 0..* Reference(Location|Organization|ResearchStudy) Facility where study activities are conducted --></site> <note><!-- 0..* Annotation Comments made about the study --></note>< < <</type> < </arm><classifier><!-- 0..* CodeableConcept Classification for the study --></classifier> <associatedParty> <!-- 0..* Sponsors, collaborators, and other parties --> <name value="[string]"/><!-- 0..1 Name of associated party --> <role><!-- 1..1 CodeableConcept sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair --></role> <period><!-- 0..* Period When active in the role --></period> <classifier><!-- 0..* CodeableConcept nih | fda | government | nonprofit | academic | industry --></classifier> <party><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Individual or organization associated with study (use practitionerRole to specify their organisation) --></party> </associatedParty> <progressStatus> <!-- 0..* Status of study with time for that status --> <state><!-- 1..1 CodeableConcept Label for status or state (e.g. recruitment status) --></state> <actual value="[boolean]"/><!-- 0..1 Actual if true else anticipated --> <period><!-- 0..1 Period Date range --></period> </progressStatus> <whyStopped><!-- 0..1 CodeableConcept accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design --></whyStopped> <recruitment> <!-- 0..1 Target or actual group of participants enrolled in study --> <targetNumber value="[unsignedInt]"/><!-- 0..1 Estimated total number of participants to be enrolled --> <actualNumber value="[unsignedInt]"/><!-- 0..1 Actual total number of participants enrolled in study --> <eligibility><!-- 0..1 Reference(EvidenceVariable|Group) Inclusion and exclusion criteria --></eligibility> <actualGroup><!-- 0..1 Reference(Group) Group of participants who were enrolled in study --></actualGroup> </recruitment> <comparisonGroup> <!-- 0..* Defined path through the study for a subject --> <linkId value="[id]"/><!-- 0..1 Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily --> <name value="[string]"/><!-- 1..1 Label for study comparisonGroup --> <type><!-- 0..1 CodeableConcept Categorization of study comparisonGroup --></type> <description value="[markdown]"/><!-- 0..1 Short explanation of study path --> <intendedExposure><!-- 0..* Reference(EvidenceVariable) Interventions or exposures in this comparisonGroup or cohort --></intendedExposure> <observedGroup><!-- 0..1 Reference(Group) Group of participants who were enrolled in study comparisonGroup --></observedGroup> </comparisonGroup> <objective> <!-- 0..* A goal for the study --> <name value="[string]"/><!-- 0..1 Label for the objective --> <type><!-- 0..1 CodeableConcept primary | secondary | exploratory --></type> <description value="[markdown]"/><!-- 0..1 Description of the objective --> </objective> <outcomeMeasure> <!-- 0..* A variable measured during the study --> <name value="[string]"/><!-- 0..1 Label for the outcome --> <type><!-- 0..* CodeableConcept primary | secondary | exploratory --></type> <description value="[markdown]"/><!-- 0..1 Description of the outcome --> <reference><!-- 0..1 Reference(EvidenceVariable) Structured outcome definition --></reference> </outcomeMeasure> <result><!-- 0..* Reference(Citation|DiagnosticReport|EvidenceReport) Link to results generated during the study --></result> </ResearchStudy>
JSON Template
{
"resourceType" : "",
"resourceType" : "ResearchStudy",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Canonical identifier for this study resource
"identifier" : [{ Identifier }], // Business Identifier for study
"
"version" : "<string>", // The business version for the study record
"name" : "<string>", // Name for this study (computer friendly)
"title" : "<string>", // Human readable name of the study
"label" : [{ // Additional names for the study
"type" : { CodeableConcept }, // primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid
"value" : "<string>" // The name
}],
"protocol" : [{ Reference(PlanDefinition) }], // Steps followed in executing study
"partOf" : [{ Reference(ResearchStudy) }], // Part of larger study
"
"
"relatedArtifact" : [{ RelatedArtifact }], // References, URLs, and attachments
"date" : "<dateTime>", // Date the resource last changed
"status" : "<code>", // R! draft | active | retired | unknown
"primaryPurposeType" : { CodeableConcept }, // treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility
"phase" : { CodeableConcept }, // n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4
"
"
"studyDesign" : [{ CodeableConcept }], // Classifications of the study design characteristics
"focus" : [{ CodeableReference(EvidenceVariable|Medication|
MedicinalProductDefinition|SubstanceDefinition) }], // Drugs, devices, etc. under study
"condition" : [{ CodeableConcept }], // Condition being studied
"
"
"keyword" : [{ CodeableConcept }], // Used to search for the study
"
"
"
"region" : [{ CodeableConcept }], // Geographic area for the study
"descriptionSummary" : "<markdown>", // Brief text explaining the study
"description" : "<markdown>", // Detailed narrative of the study
"period" : { Period }, // When the study began and ended
"
"
"
"
"site" : [{ Reference(Location|Organization|ResearchStudy) }], // Facility where study activities are conducted
"note" : [{ Annotation }], // Comments made about the study
"
"
"
"
"classifier" : [{ CodeableConcept }], // Classification for the study
"associatedParty" : [{ // Sponsors, collaborators, and other parties
"name" : "<string>", // Name of associated party
"role" : { CodeableConcept }, // R! sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair
"period" : [{ Period }], // When active in the role
"classifier" : [{ CodeableConcept }], // nih | fda | government | nonprofit | academic | industry
"party" : { Reference(Organization|Practitioner|PractitionerRole) } // Individual or organization associated with study (use practitionerRole to specify their organisation)
}],
"progressStatus" : [{ // Status of study with time for that status
"state" : { CodeableConcept }, // R! Label for status or state (e.g. recruitment status)
"actual" : <boolean>, // Actual if true else anticipated
"period" : { Period } // Date range
}],
"whyStopped" : { CodeableConcept }, // accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design
"recruitment" : { // Target or actual group of participants enrolled in study
"targetNumber" : "<unsignedInt>", // Estimated total number of participants to be enrolled
"actualNumber" : "<unsignedInt>", // Actual total number of participants enrolled in study
"eligibility" : { Reference(EvidenceVariable|Group) }, // Inclusion and exclusion criteria
"actualGroup" : { Reference(Group) } // Group of participants who were enrolled in study
},
"comparisonGroup" : [{ // Defined path through the study for a subject
"linkId" : "<id>", // Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily
"name" : "<string>", // R! Label for study comparisonGroup
"type" : { CodeableConcept }, // Categorization of study comparisonGroup
"description" : "<markdown>", // Short explanation of study path
"intendedExposure" : [{ Reference(EvidenceVariable) }], // Interventions or exposures in this comparisonGroup or cohort
"observedGroup" : { Reference(Group) } // Group of participants who were enrolled in study comparisonGroup
}],
"objective" : [{ // A goal for the study
"name" : "<string>", // Label for the objective
"
}]
"type" : { CodeableConcept }, // primary | secondary | exploratory
"description" : "<markdown>" // Description of the objective
}],
"outcomeMeasure" : [{ // A variable measured during the study
"name" : "<string>", // Label for the outcome
"type" : [{ CodeableConcept }], // primary | secondary | exploratory
"description" : "<markdown>", // Description of the outcome
"reference" : { Reference(EvidenceVariable) } // Structured outcome definition
}],
"result" : [{ Reference(Citation|DiagnosticReport|EvidenceReport) }] // Link to results generated during the study
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:ResearchStudy; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtensionfhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: ], ...;fhir:url [ uri ] ; # 0..1 Canonical identifier for this study resource fhir:identifier ( [ Identifier ] ... ) ; # 0..* Business Identifier for study fhir:version [ string ] ; # 0..1 The business version for the study record fhir:name [ string ] ; # 0..1 Name for this study (computer friendly) fhir:title [ string ] ; # 0..1 Human readable name of the study fhir:label ( [ # 0..* Additional names for the study fhir:type [ CodeableConcept ] ; # 0..1 primary | official | scientific | plain-language | subtitle | short-title | acronym | earlier-title | language | auto-translated | human-use | machine-use | duplicate-uid fhir:value [ string ] ; # 0..1 The name ] ... ) ; fhir:protocol ( [ Reference(PlanDefinition) ] ... ) ; # 0..* Steps followed in executing study fhir:partOf ( [ Reference(ResearchStudy) ] ... ) ; # 0..* Part of larger study fhir:relatedArtifact ( [ RelatedArtifact ] ... ) ; # 0..* References, URLs, and attachments fhir:date [ dateTime ] ; # 0..1 Date the resource last changed fhir:status [ code ] ; # 1..1 draft | active | retired | unknown fhir:primaryPurposeType [ CodeableConcept ] ; # 0..1 treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility fhir:phase [ CodeableConcept ] ; # 0..1 n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 fhir:studyDesign ( [ CodeableConcept ] ... ) ; # 0..* Classifications of the study design characteristics fhir:focus ( [ CodeableReference(EvidenceVariable|Medication|MedicinalProductDefinition|SubstanceDefinition) ] ... ) ; # 0..* Drugs, devices, etc. under study fhir:condition ( [ CodeableConcept ] ... ) ; # 0..* Condition being studied fhir:keyword ( [ CodeableConcept ] ... ) ; # 0..* Used to search for the study fhir:region ( [ CodeableConcept ] ... ) ; # 0..* Geographic area for the study fhir:descriptionSummary [ markdown ] ; # 0..1 Brief text explaining the study fhir:description [ markdown ] ; # 0..1 Detailed narrative of the study fhir:period [ Period ] ; # 0..1 When the study began and ended fhir:site ( [ Reference(Location|Organization|ResearchStudy) ] ... ) ; # 0..* Facility where study activities are conducted fhir:note ( [ Annotation ] ... ) ; # 0..* Comments made about the study fhir:classifier ( [ CodeableConcept ] ... ) ; # 0..* Classification for the study fhir:associatedParty ( [ # 0..* Sponsors, collaborators, and other parties fhir:name [ string ] ; # 0..1 Name of associated party fhir:role [ CodeableConcept ] ; # 1..1 sponsor | lead-sponsor | sponsor-investigator | primary-investigator | collaborator | funding-source | general-contact | recruitment-contact | sub-investigator | study-director | study-chair fhir:period ( [ Period ] ... ) ; # 0..* When active in the role fhir:classifier ( [ CodeableConcept ] ... ) ; # 0..* nih | fda | government | nonprofit | academic | industry fhir:party [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Individual or organization associated with study (use practitionerRole to specify their organisation) ] ... ) ; fhir:progressStatus ( [ # 0..* Status of study with time for that status fhir:state [ CodeableConcept ] ; # 1..1 Label for status or state (e.g. recruitment status) fhir:actual [ boolean ] ; # 0..1 Actual if true else anticipated fhir:period [ Period ] ; # 0..1 Date range ] ... ) ; fhir:whyStopped [ CodeableConcept ] ; # 0..1 accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design fhir:recruitment [ # 0..1 Target or actual group of participants enrolled in study fhir:targetNumber [ unsignedInt ] ; # 0..1 Estimated total number of participants to be enrolled fhir:actualNumber [ unsignedInt ] ; # 0..1 Actual total number of participants enrolled in study fhir:eligibility [ Reference(EvidenceVariable|Group) ] ; # 0..1 Inclusion and exclusion criteria fhir:actualGroup [ Reference(Group) ] ; # 0..1 Group of participants who were enrolled in study ] ; fhir:comparisonGroup ( [ # 0..* Defined path through the study for a subject fhir:linkId [ id ] ; # 0..1 Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily fhir:name [ string ] ; # 1..1 Label for study comparisonGroup fhir:type [ CodeableConcept ] ; # 0..1 Categorization of study comparisonGroup fhir:description [ markdown ] ; # 0..1 Short explanation of study path fhir:intendedExposure ( [ Reference(EvidenceVariable) ] ... ) ; # 0..* Interventions or exposures in this comparisonGroup or cohort fhir:observedGroup [ Reference(Group) ] ; # 0..1 Group of participants who were enrolled in study comparisonGroup ] ... ) ; fhir:objective ( [ # 0..* A goal for the study fhir:name [ string ] ; # 0..1 Label for the objective fhir:type [ CodeableConcept ] ; # 0..1 primary | secondary | exploratory fhir:description [ markdown ] ; # 0..1 Description of the objective ] ... ) ; fhir:outcomeMeasure ( [ # 0..* A variable measured during the study fhir:name [ string ] ; # 0..1 Label for the outcome fhir:type ( [ CodeableConcept ] ... ) ; # 0..* primary | secondary | exploratory fhir:description [ markdown ] ; # 0..1 Description of the outcome fhir:reference [ Reference(EvidenceVariable) ] ; # 0..1 Structured outcome definition ] ... ) ; fhir:result ( [ Reference(Citation|DiagnosticReport|EvidenceReport) ] ... ) ; # 0..* Link to results generated during the study ]
Changes
since
Release
4
from
both
R4
and
R4B
| ResearchStudy | |
| ResearchStudy.url |
|
| ResearchStudy.version |
|
| ResearchStudy.name |
|
| ResearchStudy.label |
|
| ResearchStudy.label.type |
|
| ResearchStudy.label.value |
|
| ResearchStudy.date |
|
| ResearchStudy.status |
|
| ResearchStudy.primaryPurposeType |
|
| ResearchStudy.studyDesign |
|
| ResearchStudy.focus |
|
| ResearchStudy.region |
|
| ResearchStudy.descriptionSummary |
|
| ResearchStudy.site |
|
| ResearchStudy.classifier |
|
| ResearchStudy.associatedParty |
|
| ResearchStudy.associatedParty.name |
|
| ResearchStudy.associatedParty.role |
|
| ResearchStudy.associatedParty.period |
|
| ResearchStudy.associatedParty.classifier |
|
| ResearchStudy.associatedParty.party |
|
| ResearchStudy.progressStatus |
|
| ResearchStudy.progressStatus.state |
|
| ResearchStudy.progressStatus.actual |
|
| ResearchStudy.progressStatus.period |
|
| ResearchStudy.whyStopped |
|
| ResearchStudy.recruitment |
|
| ResearchStudy.recruitment.targetNumber |
|
| ResearchStudy.recruitment.actualNumber |
|
| ResearchStudy.recruitment.eligibility |
|
| ResearchStudy.recruitment.actualGroup |
|
| ResearchStudy.comparisonGroup |
|
| ResearchStudy.comparisonGroup.linkId |
|
| ResearchStudy.comparisonGroup.name |
|
| ResearchStudy.comparisonGroup.type |
|
| ResearchStudy.comparisonGroup.description |
|
| ResearchStudy.comparisonGroup.intendedExposure |
|
| ResearchStudy.comparisonGroup.observedGroup |
|
| ResearchStudy.objective.description |
|
| ResearchStudy.outcomeMeasure |
|
| ResearchStudy.outcomeMeasure.name |
|
| ResearchStudy.outcomeMeasure.type |
|
| ResearchStudy.outcomeMeasure.description |
|
| ResearchStudy.outcomeMeasure.reference |
|
| ResearchStudy.result |
|
| ResearchStudy.category |
|
| ResearchStudy.contact |
|
| ResearchStudy.location |
|
| ResearchStudy.enrollment |
|
| ResearchStudy.sponsor |
|
| ResearchStudy.principalInvestigator |
|
| ResearchStudy.reasonStopped |
|
| ResearchStudy.arm |
|
See the Full Difference for further information
This
analysis
is
available
for
R4
as
XML
or
JSON
.
Conversions
between
R3
and
R4
for
R4B
as
XML
or
JSON
.
See
R3
<-->
R4
<-->
R5
Conversion
Maps
(status
=
1
test
that
all
execute
ok.
All
tests
pass
round-trip
testing
and
all
r3
resources
are
valid.)
See
Conversions
Summary
.)
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path |
|
Type |
|
|---|---|---|---|
| ResearchStudy.label.type | TitleType | Extensible | Used to express the reason and specific aspect for the variant title, such as language and specific language. |
| ResearchStudy.status | PublicationStatus | Required |
The lifecycle status of an artifact. |
| ResearchStudy.primaryPurposeType | ResearchStudyPrimaryPurposeType (a valid code from ResearchStudy Primary Purpose Type Code System ) |
|
Codes for the main intent of the study. |
| ResearchStudy.phase | ResearchStudyPhase (a valid code from ResearchStudy Phase Code System ) | Example |
Codes for the stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation. |
| ResearchStudy.studyDesign | StudyDesign |
|
This is a set of terms for study design characteristics. |
| ResearchStudy.focus | ResearchStudyFocusType (a valid code from ResearchStudy Focus Type Code System ) | Example |
Codes for the main intent of the study. |
| ResearchStudy.condition | ConditionProblemDiagnosisCodes | Example |
Example value set for Condition/Problem/Diagnosis codes. |
| ResearchStudy.keyword | ?? | Example |
|
| ResearchStudy.region | JurisdictionValueSet | Extensible |
This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.
Note:
The
codes
for
countries
and
country
subdivisions
are
taken
from
ISO
3166
|
| ResearchStudy.classifier | ResearchStudyClassifiers (a valid code from ResearchStudy Classifiers Code System ) | Example | Codes that convey the type of label that is provided. |
| ResearchStudy.associatedParty.role | ResearchStudyPartyRole | Extensible | This is a ResearchStudy's party role. |
| ResearchStudy.associatedParty.classifier | ResearchStudyPartyOrgType (a valid code from ResearchStudy Party Organization Type Code System ) | Example |
This is a ResearchStudy's party organization type. |
| ResearchStudy.progressStatus.state | ResearchStudyStatus | Extensible | Codes that convey the current status of the research study. |
| ResearchStudy.whyStopped | ResearchStudyReasonStopped (a valid code from ResearchStudy Reason Stopped Code System ) | Example | Codes for why the study ended prematurely. |
| ResearchStudy.comparisonGroup.type | ResearchStudyArmType (a valid code from ResearchStudy Arm Type Code System ) | Extensible | Codes for the main intent of the study. |
| ResearchStudy.objective.type | ResearchStudyObjectiveType (a valid code from ResearchStudy Objective Type Code System ) | Preferred |
Codes for the kind of study objective. |
| ResearchStudy.outcomeMeasure.type | ResearchStudyObjectiveType (a valid code from ResearchStudy Objective Type Code System ) | Preferred | Codes for the kind of study objective. |
The following diagram reflects the "typical" state machine for ResearchStudy.
Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
|
|
token |
|
| |
| condition | token | Condition being studied | ResearchStudy.condition | |
| date | date | When the study began and ended | ResearchStudy.period | |
|
| string | Detailed narrative of the study | ResearchStudy.description | |
| eligibility | reference | Inclusion and exclusion criteria |
ResearchStudy.recruitment.eligibility
( Group , EvidenceVariable ) | |
| focus-code | token |
Drugs,
devices,
etc.
under
|
| |
| focus-reference | reference | Drugs, devices, etc. under study, as a reference | ResearchStudy.focus.reference | |
| identifier | token | Business Identifier for study | ResearchStudy.identifier | |
| keyword | token | Used to search for the study | ResearchStudy.keyword | |
|
| string | Name for this study | ResearchStudy.name | |
| objective-description | string | Free text description of the objective of the study | ResearchStudy.objective.description | |
| objective-type | token |
|
|
|
|
|
reference | Part of larger study |
ResearchStudy.partOf
( ResearchStudy ) |
|
|
|
|
|
| |
| progress-status-state-actual | composite | Status of study by state and actual |
On
ResearchStudy.progressStatus:
actual: actual | |
|
| composite | Status of study by state and period |
On
ResearchStudy.progressStatus:
state: state period: period | |
| progress-status-state-period-actual | composite | Status of study by state, period and actual |
On
ResearchStudy.progressStatus:
state: state period: period actual: actual |
|
| protocol | reference | Steps followed in executing study |
ResearchStudy.protocol
( PlanDefinition ) |
|
|
|
|
|
| |
|
| number | Target number of participants enrolled in study across all groups | ResearchStudy.recruitment.targetNumber | |
|
|
|
|
| |
| site | reference | Facility where study activities are conducted |
ResearchStudy.site
( Organization , Location , ResearchStudy ) |
|
| status | token | active | active-but-not-recruiting | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | enrolling-by-invitation | in-review | not-yet-recruiting | recruiting | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | terminated | withdrawn | ResearchStudy.status | |
| study-design | token | Classifications of the study design characteristics | ResearchStudy.studyDesign | |
| title | string |
|
ResearchStudy.title |