ResearchStudy

Represents the details of a research study that include its design, execution, and oversight. This object is available in API version 61.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
BiospecRetention	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the retention of the collected participant samples in a biorepository. This field is available in API version 62.0 and later. Possible values are: `None Retained` `Samples With DNA` `Samples Without DNA`
BlindingTypeCodeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Blinding Type of the Care Program. This field is a polymorphic relationship field. Relationship Name BlindingTypeCode Refers To CodeSet, CodeSetBundle
CareProgramId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The care program associated with the research study. This field is a relationship field. Relationship Name CareProgram Refers To CareProgram
CareSpecialtyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The care specialty associated with the research study. This field is available in API version 62.0 and later. This field is a relationship field.
Description	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A detailed description of the research.
DiscontinuationReason	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The reason why the research was discontinued. Possible values are: `Accrual Goal Met` `Lack of Progress` `Temporarily Closed as per Study Design` `Toxicity`
EligibleGender	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the gender that's eligible for the research study. Possible values are: `Any` `Female` `Male` `Transgender`
EligibleMaximumAge	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The maximum eligibility age of a candidate for the research study.
EligibleMinimumAge	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The minimum eligibility age of a candidate for the research study.
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the research ends.
InclusionExclusionCriteria	Type textarea Properties Create, Nillable, Update Description The inclusion criteria and exclusion criteria of the research study.
IntentType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of the research, based on the intent of its activities. Possible values are: `Basic Science` `Device Feasibility` `Diagnostic Study` `Health Services Research` `Prevention` `Screening` `Supportive Care` `Treatment`
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the research study.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User
Phase	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The current phase of the research. Possible values are: `Early Phase 1` `Not Applicable` `Phase 1` `Phase 1/Phase 2` `Phase 2` `Phase 2/Phase 3` `Phase 3` `Phase 4`
PrimaryContactInformationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The primary phone number of the candidate. This field is a relationship field. Relationship Name PrimaryContactInformation Refers To ContactPointPhone
ProtocolDocumentId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The protocol content document associated with the research study. This field is a relationship field. Relationship Name ProtocolDocument Refers To ContentDocument
PublicationStatus	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The publication status of the research study's record. Possible values are: `Active` `Draft` `Retired` `Unknown`
ResearchStudyNumber	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the research study.
ShouldAcptHealthyCandidates	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the research study should accept healthy candidates (`true`) or not (`false`). The default value is `false`.
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the external system that generated the record.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description The ID of the record in the external system.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date on which this item was last changed in the source system.
StartDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the research starts.
Summary	Type textarea Properties Create, Nillable, Update Description A brief summary of the research.
Title	Type textarea Properties Create, Nillable, Update Description The human-readable name of the research study.
Type	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the type of research study. Possible values are: `Interventional` `Observational`
UniformResourceIdentifier	Type url Properties Create, Filter, Group, Nillable, Sort, Update Description The canonical identifier of the research study.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ResearchStudyChangeEvent: Change events are available for the object.
ResearchStudyFeed: Feed tracking is available for the object.
ResearchStudyHistory: History is available for tracked fields of the object.
ResearchStudyShare: Sharing is available for the object.

Life Sciences Cloud Developer Guide

ResearchStudy

Supported Calls

Fields

Associated Objects