research studys

Create Research Study

post

/organizations/{organizationId}/fhir/3/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


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

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ResearchStudy	This is a ResearchStudy resource
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	string	draft\|in-progress\|suspended\|stopped\|completed\|entered-in-error	The current state of the study.
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 condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
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.
jurisdiction	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	string		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		The organization responsible for the execution of the study.
principalInvestigator	Reference		Indicates the individual who has primary oversite of the execution of the study.
site	array(Reference)		Clinic, hospital or other healthcare location that is participating in the study.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the event 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.

Response

200 400 401 404

Patch Research Study

patch

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

Request

Headers


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

Params


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

Body


resourceType*	string	ResearchStudy	This is a ResearchStudy resource
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	string	draft\|in-progress\|suspended\|stopped\|completed\|entered-in-error	The current state of the study.
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 condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
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.
jurisdiction	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	string		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		The organization responsible for the execution of the study.
principalInvestigator	Reference		Indicates the individual who has primary oversite of the execution of the study.
site	array(Reference)		Clinic, hospital or other healthcare location that is participating in the study.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the event 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.

Response

200 400 401 404 409

Read Research Study

get

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

Request

Headers


content-type*	string	application/json	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/3/ResearchStudy/{resourceId}/_history

Request

Headers


content-type*	string	application/json	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/3/ResearchStudy/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	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/3/ResearchStudy/{resourceId}

Request

Headers


content-type*	string	application/json	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/3/ResearchStudy

Request

Headers


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

Query params


_id	string
_language	string
category	string
date	string
focus	string
identifier	string
jurisdiction	string
keyword	string
partof	string
principalinvestigator	string
protocol	string
site	string
sponsor	string
status	string
title	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Research Study

get

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

Request

Headers


content-type*	string	application/json	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/3/ResearchStudy/_search

Request

Headers


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

Query params


_id	string
_language	string
category	string
date	string
focus	string
identifier	string
jurisdiction	string
keyword	string
partof	string
principalinvestigator	string
protocol	string
site	string
sponsor	string
status	string
title	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ResearchStudy	This is a ResearchStudy resource
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	string	draft\|in-progress\|suspended\|stopped\|completed\|entered-in-error	The current state of the study.
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 condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
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.
jurisdiction	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	string		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		The organization responsible for the execution of the study.
principalInvestigator	Reference		Indicates the individual who has primary oversite of the execution of the study.
site	array(Reference)		Clinic, hospital or other healthcare location that is participating in the study.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the event 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.

Response

200 401 404

Update Research Study

put

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

Request

Headers


content-type*	string	application/json	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*	string	ResearchStudy	This is a ResearchStudy resource
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	string	draft\|in-progress\|suspended\|stopped\|completed\|entered-in-error	The current state of the study.
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 condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
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.
jurisdiction	array(CodeableConcept)		Indicates a country, state or other region where the study is taking place.
description	string		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		The organization responsible for the execution of the study.
principalInvestigator	Reference		Indicates the individual who has primary oversite of the execution of the study.
site	array(Reference)		Clinic, hospital or other healthcare location that is participating in the study.
reasonStopped	CodeableConcept		A description and/or code explaining the premature termination of the study.
note	array(Annotation)		Comments made about the event 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.

Response

200 400 401 404 409