research studys

Create Research Study

post

/organizations/{organizationId}/fhir/4/ResearchStudy

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.

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a ResearchStudy resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifiers assigned to this research study by the sponsor or other systems.
title	string		A short, descriptive user-friendly label for the study.
protocol	array(Reference)		The set of steps expected to be performed as part of the execution of the study.
partOf	array(Reference)		A larger research study of which this particular study is a component or step.
status		active\|administratively-completed\|approved\|closed-to-accrual\|closed-to-accrual-and-intervention\|completed\|disapproved\|in-review\|temporarily-closed-to-accrual\|temporarily-closed-to-accrual-and-intervention\|withdrawn	The current state of the study.
primaryPurposeType	CodeableConcept		The type of study based upon the intent of the study's activities. A classification of the intent of the study.
phase	CodeableConcept		The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
category	array(CodeableConcept)		Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focus	array(CodeableConcept)		The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
condition	array(CodeableConcept)		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.
contact	array(ContactDetail)		Contact details to assist a user in learning more about or engaging with the study.
relatedArtifact	array(RelatedArtifact)		Citations, references and other related documents.
keyword	array(CodeableConcept)		Key terms to aid in searching for or filtering the study.
location	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	markdown		A full description of how the study is being conducted.
enrollment	array(Reference)		Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
period	Period		Identifies the start date and the expected (or actual, depending on status) end date for the study.
sponsor	Reference		An organization that initiates the investigation and is legally responsible for the study.
principalInvestigator	Reference		A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
site	array(Reference)		A facility in which study activities are conducted.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the study by the performer, subject or other participants.
arm	array(ResearchStudy_Arm)		Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
objective	array(ResearchStudy_Objective)		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.

Response

200 400 401 404

Patch Research Study

patch

/organizations/{organizationId}/fhir/4/ResearchStudy/{resourceId}

Request

Headers

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a ResearchStudy resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifiers assigned to this research study by the sponsor or other systems.
title	string		A short, descriptive user-friendly label for the study.
protocol	array(Reference)		The set of steps expected to be performed as part of the execution of the study.
partOf	array(Reference)		A larger research study of which this particular study is a component or step.
status		active\|administratively-completed\|approved\|closed-to-accrual\|closed-to-accrual-and-intervention\|completed\|disapproved\|in-review\|temporarily-closed-to-accrual\|temporarily-closed-to-accrual-and-intervention\|withdrawn	The current state of the study.
primaryPurposeType	CodeableConcept		The type of study based upon the intent of the study's activities. A classification of the intent of the study.
phase	CodeableConcept		The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
category	array(CodeableConcept)		Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focus	array(CodeableConcept)		The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
condition	array(CodeableConcept)		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.
contact	array(ContactDetail)		Contact details to assist a user in learning more about or engaging with the study.
relatedArtifact	array(RelatedArtifact)		Citations, references and other related documents.
keyword	array(CodeableConcept)		Key terms to aid in searching for or filtering the study.
location	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	markdown		A full description of how the study is being conducted.
enrollment	array(Reference)		Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
period	Period		Identifies the start date and the expected (or actual, depending on status) end date for the study.
sponsor	Reference		An organization that initiates the investigation and is legally responsible for the study.
principalInvestigator	Reference		A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
site	array(Reference)		A facility in which study activities are conducted.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the study by the performer, subject or other participants.
arm	array(ResearchStudy_Arm)		Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
objective	array(ResearchStudy_Objective)		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.

Response

200 400 401 404 409

Read Research Study

get

/organizations/{organizationId}/fhir/4/ResearchStudy/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Research Study

get

/organizations/{organizationId}/fhir/4/ResearchStudy/{resourceId}/_history

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Research Study

get

/organizations/{organizationId}/fhir/4/ResearchStudy/{resourceId}/_history/{versionId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Research Study

delete

/organizations/{organizationId}/fhir/4/ResearchStudy/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404 409

Search Get Research Study

get

/organizations/{organizationId}/fhir/4/ResearchStudy

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Research Study

get

/organizations/{organizationId}/fhir/4/ResearchStudy/_history

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Research Study

post

/organizations/{organizationId}/fhir/4/ResearchStudy/_search

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a ResearchStudy resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifiers assigned to this research study by the sponsor or other systems.
title	string		A short, descriptive user-friendly label for the study.
protocol	array(Reference)		The set of steps expected to be performed as part of the execution of the study.
partOf	array(Reference)		A larger research study of which this particular study is a component or step.
status		active\|administratively-completed\|approved\|closed-to-accrual\|closed-to-accrual-and-intervention\|completed\|disapproved\|in-review\|temporarily-closed-to-accrual\|temporarily-closed-to-accrual-and-intervention\|withdrawn	The current state of the study.
primaryPurposeType	CodeableConcept		The type of study based upon the intent of the study's activities. A classification of the intent of the study.
phase	CodeableConcept		The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
category	array(CodeableConcept)		Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focus	array(CodeableConcept)		The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
condition	array(CodeableConcept)		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.
contact	array(ContactDetail)		Contact details to assist a user in learning more about or engaging with the study.
relatedArtifact	array(RelatedArtifact)		Citations, references and other related documents.
keyword	array(CodeableConcept)		Key terms to aid in searching for or filtering the study.
location	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	markdown		A full description of how the study is being conducted.
enrollment	array(Reference)		Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
period	Period		Identifies the start date and the expected (or actual, depending on status) end date for the study.
sponsor	Reference		An organization that initiates the investigation and is legally responsible for the study.
principalInvestigator	Reference		A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
site	array(Reference)		A facility in which study activities are conducted.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the study by the performer, subject or other participants.
arm	array(ResearchStudy_Arm)		Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
objective	array(ResearchStudy_Objective)		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.

Response

200 401 404

Update Research Study

put

/organizations/{organizationId}/fhir/4/ResearchStudy/{resourceId}

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*			This is a ResearchStudy resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifiers assigned to this research study by the sponsor or other systems.
title	string		A short, descriptive user-friendly label for the study.
protocol	array(Reference)		The set of steps expected to be performed as part of the execution of the study.
partOf	array(Reference)		A larger research study of which this particular study is a component or step.
status		active\|administratively-completed\|approved\|closed-to-accrual\|closed-to-accrual-and-intervention\|completed\|disapproved\|in-review\|temporarily-closed-to-accrual\|temporarily-closed-to-accrual-and-intervention\|withdrawn	The current state of the study.
primaryPurposeType	CodeableConcept		The type of study based upon the intent of the study's activities. A classification of the intent of the study.
phase	CodeableConcept		The stage in the progression of a therapy from initial experimental use in humans in clinical trials to post-market evaluation.
category	array(CodeableConcept)		Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focus	array(CodeableConcept)		The medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
condition	array(CodeableConcept)		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.
contact	array(ContactDetail)		Contact details to assist a user in learning more about or engaging with the study.
relatedArtifact	array(RelatedArtifact)		Citations, references and other related documents.
keyword	array(CodeableConcept)		Key terms to aid in searching for or filtering the study.
location	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	markdown		A full description of how the study is being conducted.
enrollment	array(Reference)		Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. " 200 female Europeans between the ages of 20 and 45 with early onset diabetes".
period	Period		Identifies the start date and the expected (or actual, depending on status) end date for the study.
sponsor	Reference		An organization that initiates the investigation and is legally responsible for the study.
principalInvestigator	Reference		A researcher in a study who oversees multiple aspects of the study, such as concept development, protocol writing, protocol submission for IRB approval, participant recruitment, informed consent, data collection, analysis, interpretation and presentation.
site	array(Reference)		A facility in which study activities are conducted.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the study by the performer, subject or other participants.
arm	array(ResearchStudy_Arm)		Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
objective	array(ResearchStudy_Objective)		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.

Response

200 400 401 404 409