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*	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	ResearchSubject	This is a ResearchSubject resource
identifier	Identifier		Identifiers assigned to this research study by the sponsor or other systems.
status	string	candidate\|enrolled\|active\|suspended\|withdrawn\|completed	The current state of the subject.
period	Period		The dates the subject began and ended their participation in the study.
study*	Reference		Reference to the study the subject is participating in.
individual*	Reference		The record of the person or animal who is involved in the study.
assignedArm	string		The name of the arm in the study the subject is expected to follow as part of this study.
actualArm	string		The name of the arm in the study the subject actually followed as part of this study.
consent	Reference		A record of the patient's informed agreement to participate in the study.

Response

200 400 401 404

Patch Research Subject

patch

/organizations/{organizationId}/fhir/3/ResearchSubject/{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	ResearchSubject	This is a ResearchSubject resource
identifier	Identifier		Identifiers assigned to this research study by the sponsor or other systems.
status	string	candidate\|enrolled\|active\|suspended\|withdrawn\|completed	The current state of the subject.
period	Period		The dates the subject began and ended their participation in the study.
study*	Reference		Reference to the study the subject is participating in.
individual*	Reference		The record of the person or animal who is involved in the study.
assignedArm	string		The name of the arm in the study the subject is expected to follow as part of this study.
actualArm	string		The name of the arm in the study the subject actually followed as part of this study.
consent	Reference		A record of the patient's informed agreement to participate in the study.

Response

200 400 401 404 409

Read Research Subject

get

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

get

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

get

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

delete

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

get

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

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
date	string
identifier	string
individual	string
patient	string
status	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Research Subject

get

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

post

/organizations/{organizationId}/fhir/3/ResearchSubject/_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
date	string
identifier	string
individual	string
patient	string
status	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	ResearchSubject	This is a ResearchSubject resource
identifier	Identifier		Identifiers assigned to this research study by the sponsor or other systems.
status	string	candidate\|enrolled\|active\|suspended\|withdrawn\|completed	The current state of the subject.
period	Period		The dates the subject began and ended their participation in the study.
study*	Reference		Reference to the study the subject is participating in.
individual*	Reference		The record of the person or animal who is involved in the study.
assignedArm	string		The name of the arm in the study the subject is expected to follow as part of this study.
actualArm	string		The name of the arm in the study the subject actually followed as part of this study.
consent	Reference		A record of the patient's informed agreement to participate in the study.

Response

200 401 404

Update Research Subject

put

/organizations/{organizationId}/fhir/3/ResearchSubject/{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	ResearchSubject	This is a ResearchSubject resource
identifier	Identifier		Identifiers assigned to this research study by the sponsor or other systems.
status	string	candidate\|enrolled\|active\|suspended\|withdrawn\|completed	The current state of the subject.
period	Period		The dates the subject began and ended their participation in the study.
study*	Reference		Reference to the study the subject is participating in.
individual*	Reference		The record of the person or animal who is involved in the study.
assignedArm	string		The name of the arm in the study the subject is expected to follow as part of this study.
actualArm	string		The name of the arm in the study the subject actually followed as part of this study.
consent	Reference		A record of the patient's informed agreement to participate in the study.

Response

200 400 401 404 409