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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringResearchStudyThis is a ResearchStudy resource
identifierarray(Identifier)Identifiers assigned to this research study by the sponsor or other systems.
titlestringA short, descriptive user-friendly label for the study.
protocolarray(Reference)The set of steps expected to be performed as part of the execution of the study.
partOfarray(Reference)A larger research study of which this particular study is a component or step.
statusstringdraft|in-progress|suspended|stopped|completed|entered-in-errorThe current state of the study.
categoryarray(CodeableConcept)Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focusarray(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.
contactarray(ContactDetail)Contact details to assist a user in learning more about or engaging with the study.
relatedArtifactarray(RelatedArtifact)Citations, references and other related documents.
keywordarray(CodeableConcept)Key terms to aid in searching for or filtering the study.
jurisdictionarray(CodeableConcept)Indicates a country, state or other region where the study is taking place.
descriptionstringA full description of how the study is being conducted.
enrollmentarray(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".
periodPeriodIdentifies the start date and the expected (or actual, depending on status) end date for the study.
sponsorReferenceThe organization responsible for the execution of the study.
principalInvestigatorReferenceIndicates the individual who has primary oversite of the execution of the study.
sitearray(Reference)Clinic, hospital or other healthcare location that is participating in the study.
reasonStoppedCodeableConceptA description and/or code explaining the premature termination of the study.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
armarray(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

Patch Research Study

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

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringResearchStudyThis is a ResearchStudy resource
identifierarray(Identifier)Identifiers assigned to this research study by the sponsor or other systems.
titlestringA short, descriptive user-friendly label for the study.
protocolarray(Reference)The set of steps expected to be performed as part of the execution of the study.
partOfarray(Reference)A larger research study of which this particular study is a component or step.
statusstringdraft|in-progress|suspended|stopped|completed|entered-in-errorThe current state of the study.
categoryarray(CodeableConcept)Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focusarray(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.
contactarray(ContactDetail)Contact details to assist a user in learning more about or engaging with the study.
relatedArtifactarray(RelatedArtifact)Citations, references and other related documents.
keywordarray(CodeableConcept)Key terms to aid in searching for or filtering the study.
jurisdictionarray(CodeableConcept)Indicates a country, state or other region where the study is taking place.
descriptionstringA full description of how the study is being conducted.
enrollmentarray(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".
periodPeriodIdentifies the start date and the expected (or actual, depending on status) end date for the study.
sponsorReferenceThe organization responsible for the execution of the study.
principalInvestigatorReferenceIndicates the individual who has primary oversite of the execution of the study.
sitearray(Reference)Clinic, hospital or other healthcare location that is participating in the study.
reasonStoppedCodeableConceptA description and/or code explaining the premature termination of the study.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
armarray(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

Read Research Study

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Research Study

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Research Study

get
/organizations/{organizationId}/fhir/3/ResearchStudy/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Research Study

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Research Study

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
datestring
focusstring
identifierstring
jurisdictionstring
keywordstring
partofstring
principalinvestigatorstring
protocolstring
sitestring
sponsorstring
statusstring
titlestring

Params

organizationId*string|stringid|slug

Response

Search History Research Study

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Research Study

post
/organizations/{organizationId}/fhir/3/ResearchStudy/_search

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
categorystring
datestring
focusstring
identifierstring
jurisdictionstring
keywordstring
partofstring
principalinvestigatorstring
protocolstring
sitestring
sponsorstring
statusstring
titlestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringResearchStudyThis is a ResearchStudy resource
identifierarray(Identifier)Identifiers assigned to this research study by the sponsor or other systems.
titlestringA short, descriptive user-friendly label for the study.
protocolarray(Reference)The set of steps expected to be performed as part of the execution of the study.
partOfarray(Reference)A larger research study of which this particular study is a component or step.
statusstringdraft|in-progress|suspended|stopped|completed|entered-in-errorThe current state of the study.
categoryarray(CodeableConcept)Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focusarray(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.
contactarray(ContactDetail)Contact details to assist a user in learning more about or engaging with the study.
relatedArtifactarray(RelatedArtifact)Citations, references and other related documents.
keywordarray(CodeableConcept)Key terms to aid in searching for or filtering the study.
jurisdictionarray(CodeableConcept)Indicates a country, state or other region where the study is taking place.
descriptionstringA full description of how the study is being conducted.
enrollmentarray(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".
periodPeriodIdentifies the start date and the expected (or actual, depending on status) end date for the study.
sponsorReferenceThe organization responsible for the execution of the study.
principalInvestigatorReferenceIndicates the individual who has primary oversite of the execution of the study.
sitearray(Reference)Clinic, hospital or other healthcare location that is participating in the study.
reasonStoppedCodeableConceptA description and/or code explaining the premature termination of the study.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
armarray(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

Update Research Study

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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringResearchStudyThis is a ResearchStudy resource
identifierarray(Identifier)Identifiers assigned to this research study by the sponsor or other systems.
titlestringA short, descriptive user-friendly label for the study.
protocolarray(Reference)The set of steps expected to be performed as part of the execution of the study.
partOfarray(Reference)A larger research study of which this particular study is a component or step.
statusstringdraft|in-progress|suspended|stopped|completed|entered-in-errorThe current state of the study.
categoryarray(CodeableConcept)Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
focusarray(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.
contactarray(ContactDetail)Contact details to assist a user in learning more about or engaging with the study.
relatedArtifactarray(RelatedArtifact)Citations, references and other related documents.
keywordarray(CodeableConcept)Key terms to aid in searching for or filtering the study.
jurisdictionarray(CodeableConcept)Indicates a country, state or other region where the study is taking place.
descriptionstringA full description of how the study is being conducted.
enrollmentarray(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".
periodPeriodIdentifies the start date and the expected (or actual, depending on status) end date for the study.
sponsorReferenceThe organization responsible for the execution of the study.
principalInvestigatorReferenceIndicates the individual who has primary oversite of the execution of the study.
sitearray(Reference)Clinic, hospital or other healthcare location that is participating in the study.
reasonStoppedCodeableConceptA description and/or code explaining the premature termination of the study.
notearray(Annotation)Comments made about the event by the performer, subject or other participants.
armarray(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