EhrPatient__c

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

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

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.

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.

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.

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.

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

IntegrationIsActive__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Whether integration is active (true) or not (false). The default checkbox value is selected.

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.

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.

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, idLookupSort
Description: The EHR patient ID. Limit: 255 characters.

Name__c

Type: textarea
Properties: Create, Nillable, Update
Description: The 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 the patient contact is acting, for which the patient contact is working, or that’s 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 the patient contact is acting, for which the patient contact is working, or that’s the custodian of the patient record.

PhotoUrl__c

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

PrefixName1__c

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

PrefixName2__c

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

PrefixName3__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The third prefix in the 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 the patient’s name.

SuffixName2__c

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

SuffixName3__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The third suffix in the 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 fax or phone.

Telecom1Use__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Details such as home, office, or mobile related to the patient’s contact information.

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 fax or phone.

Telecom2Use__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Details such as home, office, or mobile related to the patient’s contact information.

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 fax or phone.

Telecom3Use__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Details such as home, office, or mobile related to the patient’s contact information.

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 fax or phone.

Telecom4Use__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Details such as home, office, or mobile related to the patient’s contact information.

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 fax or phone.

Telecom5Use__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Details such as home, office, or mobile related to the patient’s contact information.

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.

Usage

A patient record is typically created and maintained by each organization providing care for a patient. A patient receiving care at multiple organizations can have information present in multiple patient resources.