Salesforce Docs Portal

ResearchStudyCandidate

Represents the details of the research participant which includes the associated account and the status of the subject. 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

CandidateId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The candidate of the research study.

    This field is a polymorphic relationship field.

  • Relationship Name: Candidate
  • Refers To: Account

CareProgramSiteId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The location where the study happens.

    This field is a relationship field.

  • Relationship Name: CareProgramSite
  • Refers To: CareProgramSite

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.

MatchedExclusionCritCount

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of exclusion criteria fulfilled by the candidate during automatic evaluation. This field is available in API version 62.0 and later.

MatchedInclusionCritCount

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of inclusion criteria fulfilled by the candidate during automatic evaluation. This field is available in API version 62.0 and later.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The name of the research study candidate.

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

ResearchStudyId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The research study that the Candidate is a part of.

    This field is a relationship field.

  • Relationship Name: ResearchStudy
  • Refers To: ResearchStudy

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.

SourceType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the type of source from where the information about the candidate is obtained.
  • Possible values:
    • Others
    • Participant Registry
    • Referrals
    • Site Patient Pool

Status

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The status of the research study candidate.
  • Possible values:
    • Consent
    • Enrolled
    • New
    • Randomization
    • Referral Accepted
    • Rejected
    • Screening

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.

researchstudycandidateChangeEvent
Change events are available for the object.
researchstudycandidateFeed
Feed tracking is available for the object.
researchstudycandidateHistory
History is available for tracked fields of the object.
researchstudycandidateShare
Sharing is available for the object.