EhrRelatedPerson__c

Represents a person who’s involved in a patient’s healthcare but isn’t the target of care and doesn’t have a formal responsibility in the process.

Supported Calls 

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

Fields 

Account__c 
  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The person account that represents the patient in Lightning Platform.

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

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

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

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

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

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

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

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

Address1Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the related person.

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

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

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

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

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

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

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

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

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

Address2Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the related person.

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

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

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

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

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

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

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

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

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

Address3Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the related person.

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

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

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

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

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

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

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

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

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

Address4Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the related person.

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

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

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

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

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

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

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

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

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

Address5Text__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: A complete address for the related person.

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

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

FamilyName1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The first name in the related person’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 related person’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 related person’s family name (Andrews in Carol Smith Rodgers Andrews).

Gender__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The related person’s gender.

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.)

IsRestricted__c 
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether or not this field has restricted visibility based on sharing rules.

IsVisibleOnPatientCard__c 
  • Type: boolean
  • Properties: Defaulted on create, Filter, Group
  • Description: Indicates whether or not this field appears on the patient card.

Language1__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A language that can be used to communicate with the related person about the patient’s health.

Language2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A language that can be used to communicate with the related person about the patient’s health.

Language3__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A language that can be used to communicate with the related person about the patient’s health.

Language4__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A language that can be used to communicate with the related person about the patient’s health.

Language5__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A language that can be used to communicate with the related person about the patient’s health.

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 time stamp that indicates when the current user last viewed a related 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: Autonumber, Defaulted on create, Filter, idLookupSort
  • Description: The EHR related person ID. Limit: 255 characters.

NameFull__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The long text description of the related person’s full name.

Patient__c 
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The patient’s name. Lookup to EhrPatient__c.

PhotoUrl__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The URL to a photo of the related person.

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

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

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

Relationship__c 
  • Type: string
  • Properties: Create, Filter, Group, NillableSort, Update
  • Description: The nature of the relationship between the patient and the related person.

Role255__c 
  • Type: string
  • Properties: Create, Filter, Group, NillableSort, Update
  • Description: The role of the related person. Limit: 255 characters.

Role__c 
  • Type: textarea
  • Properties: Create, Nillable, Sort
  • Description: The long text description of the role of the related person.

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, NillableSort, 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.

Specialty255__c 
  • Type: string
  • Properties: Create, Filter, Group, NillableSort, Update
  • Description: The related person’s specialty. Limit: 255 characters.

Specialty__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The long text description of the related person’s specialty.

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

SuffixName2__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second suffix in the related person’s name.

SuffixName3__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The third suffix in the related person’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 related person.

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 related person.

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

Telecom1Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information (for example, a phone number or email address) that can be used to contact the related person.

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 related person.

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 related person.

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 related person.

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

Telecom2Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information (for example, a phone number or email address) that can be used to contact the related person.

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 related person.

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 related person.

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 related person.

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

Telecom3Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information (for example, a phone number or email address) that can be used to contact the related person.

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 related person.

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 related person.

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 related person.

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

Telecom4Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information (for example, a phone number or email address) that can be used to contact the related person.

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 related person.

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 related person.

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 related person.

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

Telecom5Use__c 
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details such as home, office, or mobile related to contact information (for example, a phone number or email address) that can be used to contact the related person.

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 related person.

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)
Claims (Managed Package Feature)
Electronic Health Records (Managed Package)
Mapping the EHR Data Model to the Clinical Data Model
EhrAllergyIntolerance__c
EhrCarePlan__c
EhrCarePlanActivity__c
EhrCarePlanConcern__c
EhrCarePlanGoal__c
EhrCarePlanParticipant__c
EhrCondition__c
EhrConditionRelatedItem__c
EhrDevice__c
EhrDosageInstruction__c
EhrEncounter__c
EhrEncounterAccommodation__c
EhrEncounterParticipant__c
EhrImmunization__c
EhrImmunizationReaction__c
EhrMedicationPrescription__c
EhrMedicationStatement__c
EhrObservation__c
EhrPatient__c
EhrPatientCareProvider
EhrPatientContact__c
EhrPractitioner__c
EhrPractitionerIdentity__c
EhrPractitionerQualification__c
EhrPractitionerRole__c
EhrProcedure__c
EhrProcedurePerformer__c
EhrProcedureRequest__c
EhrProgram__c
EhrRelatedObservation__c
EhrRelatedPerson__c
EhrVaccinationProtocol__c
EhrVirtualDevice__c
EhrVirtualDeviceChannel__c
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