CandidatePatient__c

Represents the demographics and other administrative information about a patient who’s receiving health-related services.

Starting Spring ‘22, the Candidate Patient object is no longer supported. Use the Lead object for patient conversion.

Note

As the Candidate Patient custom object is being retired, use the Lead object instead of the Candidate Patient object. If you need a Candidate Patient field that Lead doesn’t support, create the fields.

Note

Supported Calls 

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

Fields 

Address1City__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city in an address for the patient.

Address1Country__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country in an address for the patient.

Address1EndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when an address for the patient is valid.

Address1Line1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first line of a street address for the patient.

Address1Line2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second line of a street address for the patient.

Address1PostalCode__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of an address for the patient.

Address1StartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when an address for the patient is valid.

Address1State__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state in an address for the patient.

Address1Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the patient. Use is optional based on source data.

Address1Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home or office related to an address for the patient.

Address2City__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city in an address for the patient.

Address2Country__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country in an address for the patient.

Address2EndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when an address for the patient is valid.

Address2Line1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first line of a street address for the patient.

Address2Line2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second line of a street address for the patient.

Address2PostalCode__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of an address for the patient.

Address2StartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when an address for the patient is valid.

Address2State__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state in an address for the patient.

Address2Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the patient. Use is optional based on source data.

Address2Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home or office related to an address for the patient.

Address3City__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city in an address for the patient.

Address3Country__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country in an address for the patient.

Address3EndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when an address for the patient is valid.

Address3Line1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first line of a street address for the patient.

Address3Line2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second line of a street address for the patient.

Address3PostalCode__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of an address for the patient.

Address3StartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when an address for the patient is valid.

Address3State__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state in an address for the patient.

Address3Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the patient. Use is optional based on source data.

Address3Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home or office related to an address for the patient.

Address4City__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city in an address for the patient.

Address4Country__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country in an address for the patient.

Address4EndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when an address for the patient is valid.

Address4Line1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first line of a street address for the patient.

Address4Line2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second line of a street address for the patient.

Address4PostalCode__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of an address for the patient.

Address4StartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when an address for the patient is valid

Address4State__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state in an address for the patient.

Address4Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the patient. Use is optional based on source data.

Address4Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home or office related to an address for the patient.

Address5City__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city in an address for the patient.

Address5Country__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country in an address for the patient.

Address5EndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when an address for the patient is valid.

Address5Line1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first line of a street address for the patient.

Address5Line2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second line of a street address for the patient.

Address5PostalCode__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code of an address for the patient.

Address5StartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when an address for the patient is valid.

Address5State__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state in an address for the patient.

Address5Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the patient. Use is optional based on source data.

Address5Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home or office related to an address for the patient.

BirthDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The patient’s birth date.

Communication1Code__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents a language that can be used to communicate with the patient about his or her health.

Communication1Label__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The human-readable label that represents a language that can be used to communicate with the patient about his or her health.

Communication1System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a language that can be used to communicate with the patient about his or her health.

Communication2Code__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents a language that can be used to communicate with the patient about his or her health.

Communication2Label__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The human-readable label that represents a language that can be used to communicate with the patient about his or her health.

Communication2System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a language that can be used to communicate with the patient about his or her health.

Communication3Code__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents a language that can be used to communicate with the patient about his or her health.

Communication3Label__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The human-readable label that represents a language that can be used to communicate with the patient about his or her health.

Communication3System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a language that can be used to communicate with the patient about his or her health.

Communication4Code__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents a language that can be used to communicate with the patient about his or her health.

Communication4Label__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The human-readable label that represents a language that can be used to communicate with the patient about his or her health.

Communication4System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a language that can be used to communicate with the patient about his or her health.

Communication5Code__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents a language that can be used to communicate with the patient about his or her health.

Communication5Label__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The human-readable label that represents a language that can be used to communicate with the patient about his or her health.

Communication5System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a language that can be used to communicate with the patient about his or her health.

Deceased__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Whether the patient is deceased (true) or not (false). The default checkbox value is deselected.

FamilyName1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first name in the patient’s family name (Smith in Carol Smith Rodgers Andrews).

FamilyName2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second name in the patient’s family name (Rodgers in Carol Smith Rodgers Andrews).

FamilyName3__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The third name in the patient’s family name (Andrews in Carol Smith Rodgers Andrews).

GenderCode__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the gender that the patient is considered to have for administration and record-keeping purposes.

GenderLabel__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The human-readable label that represents the gender that the patient is considered to have for administration and record-keeping purposes.

GenderSystem__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines the gender that the patient is considered to have for administration and record-keeping purposes.

GivenName1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

GivenName2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

GivenName3__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The third name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

GivenName4__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The fourth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

GivenName5__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The fifth name in the patient’s given name. (Lisa Marie is the given name of Lisa Marie Smith.)

LastActivityDate 

  • Type: date

  • Properties: Filter, Group, Nillable, Sort

  • Description: Whichever of the following is the most recent:

    • Due date of the most recent event logged against the record.
    • Due date of the most recently closed task associated with the record.

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.

MaritalStatusCode__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the patient’s most recent civil marital status.

MaritalStatusLabel__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The human-readable label that represents the patient’s most recent civil marital status.

MaritalStatusSystem__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines the patient’s most recent civil marital status.

MedicalRecordNumber 
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The medical record number used to identify a patient.

MultipleBirth__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Whether the patient is part of a multiple birth (true) or not (false). The default checkbox value is deselected.

Name 
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The EHR ADT patient ID. Limit: 255 characters.

Name__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A long text description of a name associated with the patient.

Organization255__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The organization on behalf of which a patient contact is acting, for which the patient contact is working, or that’s acting as the custodian of the patient record. Limit: 255 characters.

Organization__c 

  • Type: textarea

  • Properties: Create, Nillable, Update

  • Description: The long text description of the organization:

    • On behalf of which a patient contact is acting
    • For which the patient contact is working
    • That’s acting as the custodian of the patient record

OwnerId 
  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the record owner.

PhotoUrl__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The URL for a photograph of the patient.

PrefixName1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first prefix in a patient’s name.

PrefixName2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second prefix in a patient’s name.

PrefixName3__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The third prefix in a patient’s name.

SourceSystem__c 
  • Type: string
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: A name that identifies the system that created the record and owns update rights to it.

SourceSystemId__c 
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: The ID of an external record. This field can’t be encrypted.

SourceSystemModified__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The most recent date when the integration system wrote the record from the source record.

SuffixName1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first suffix in a patient’s name.

SuffixName2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second prefix in a patient’s name.

SuffixName3__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The third prefix in a patient’s name.

Telecom1PeriodEndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom1PeriodStartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom1System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a contact detail that can be used to contact the patient, such as phone or fax.

Telecom1Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information that can be used to contact the patient.

Telecom1Value__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The content details, such as the phone number, that can be used to contact the patient.

Telecom2PeriodEndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom2PeriodStartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom2System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a contact detail that can be used to contact the patient, such as phone or fax.

Telecom2Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information that can be used to contact the patient.

Telecom2Value__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The content details, such as the phone number, that can be used to contact the patient.

Telecom3PeriodEndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom3PeriodStartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom3System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a contact detail that can be used to contact the patient, such as phone or fax.

Telecom3Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information that can be used to contact the patient.

Telecom3Value__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The content details, such as the phone number, that can be used to contact the patient.

Telecom4PeriodEndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom4PeriodStartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom4System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a contact detail that can be used to contact the patient, such as phone or fax.

Telecom4Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information that can be used to contact the patient.

Telecom4Value__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The content details, such as the phone number, that can be used to contact the patient.

Telecom5PeriodEndDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The last date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom5PeriodStartDate__c 
  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The first date when a contact detail (for example, a phone number or email address) can be used to contact the patient.

Telecom5System__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system that defines a contact detail that can be used to contact the patient, such as phone or fax.

Telecom5Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information that can be used to contact the patient.

Telecom5Value__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The content details, such as the phone number, that can be used to contact the patient.

Health Cloud Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Health Cloud Platform Events
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
Health Cloud FHIR APIs
MuleSoft Direct Integrations
API End-of-Life Policy
Health Cloud Managed Package
Health Cloud Managed Package Data Model
Care Management (Managed Package)
CarePlanTemplate__c
CarePlanTemplateGoal__c
CarePlanTemplateProblem__c
CarePlanTemplateTask__c
AccountAccountRelation__c
CandidatePatient__c
CardViewDropdown__c
CarePlanGoal__c
CarePlanProblem__c
ConditionToHCCCodeMapping__c
ContactContactRelation__c
CrossObjectRelationship__c
CustomFieldSets__c
CustomLabelConfig__c
FilterColumn__c
FilterCondition__c
FilterCriterion__c
PatientCardViewConfiguration__c
PersonLifeEvent
ReciprocalRole__c
ProgramPatientAffiliation__c
ProgramPatientSummary__c
Provider__c
TimelineViewConfiguration__c
Claims (Managed Package Feature)
Electronic Health Records (Managed Package)
Health Cloud Managed Package to Platform Data Model Mapping
Health Cloud Custom Metadata Types (Managed Package)
Health Cloud Empower Components for Experience Cloud Sites (Managed Package)
Working With Electronic Health Records (Managed Package)
Health Cloud Managed Package Aura Components
Previous Versions