research subjects

Create Research Subject

post
/organizations/{organizationId}/fhir/3/ResearchSubject

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*stringResearchSubjectThis is a ResearchSubject resource
identifierIdentifierIdentifiers assigned to this research study by the sponsor or other systems.
statusstringcandidate|enrolled|active|suspended|withdrawn|completedThe current state of the subject.
periodPeriodThe dates the subject began and ended their participation in the study.
study*ReferenceReference to the study the subject is participating in.
individual*ReferenceThe record of the person or animal who is involved in the study.
assignedArmstringThe name of the arm in the study the subject is expected to follow as part of this study.
actualArmstringThe name of the arm in the study the subject actually followed as part of this study.
consentReferenceA record of the patient's informed agreement to participate in the study.

Response

Patch Research Subject

patch
/organizations/{organizationId}/fhir/3/ResearchSubject/{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*stringResearchSubjectThis is a ResearchSubject resource
identifierIdentifierIdentifiers assigned to this research study by the sponsor or other systems.
statusstringcandidate|enrolled|active|suspended|withdrawn|completedThe current state of the subject.
periodPeriodThe dates the subject began and ended their participation in the study.
study*ReferenceReference to the study the subject is participating in.
individual*ReferenceThe record of the person or animal who is involved in the study.
assignedArmstringThe name of the arm in the study the subject is expected to follow as part of this study.
actualArmstringThe name of the arm in the study the subject actually followed as part of this study.
consentReferenceA record of the patient's informed agreement to participate in the study.

Response

Read Research Subject

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

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

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

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

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
identifierstring
individualstring
patientstring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Research Subject

get
/organizations/{organizationId}/fhir/3/ResearchSubject/_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 Subject

post
/organizations/{organizationId}/fhir/3/ResearchSubject/_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
datestring
identifierstring
individualstring
patientstring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringResearchSubjectThis is a ResearchSubject resource
identifierIdentifierIdentifiers assigned to this research study by the sponsor or other systems.
statusstringcandidate|enrolled|active|suspended|withdrawn|completedThe current state of the subject.
periodPeriodThe dates the subject began and ended their participation in the study.
study*ReferenceReference to the study the subject is participating in.
individual*ReferenceThe record of the person or animal who is involved in the study.
assignedArmstringThe name of the arm in the study the subject is expected to follow as part of this study.
actualArmstringThe name of the arm in the study the subject actually followed as part of this study.
consentReferenceA record of the patient's informed agreement to participate in the study.

Response

Update Research Subject

put
/organizations/{organizationId}/fhir/3/ResearchSubject/{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*stringResearchSubjectThis is a ResearchSubject resource
identifierIdentifierIdentifiers assigned to this research study by the sponsor or other systems.
statusstringcandidate|enrolled|active|suspended|withdrawn|completedThe current state of the subject.
periodPeriodThe dates the subject began and ended their participation in the study.
study*ReferenceReference to the study the subject is participating in.
individual*ReferenceThe record of the person or animal who is involved in the study.
assignedArmstringThe name of the arm in the study the subject is expected to follow as part of this study.
actualArmstringThe name of the arm in the study the subject actually followed as part of this study.
consentReferenceA record of the patient's informed agreement to participate in the study.

Response