PartyProfile

Represents additional details related to a patient. This object is available in Health Cloud in API version 61.0 and later.

For more information related to the fields that are not used for Health Cloud, see Financial Services Cloud Developer Guide: PartyProfile.

Supported Calls

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the patient’s account record.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
BusLicIssAuthorityName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityCtryofInc
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityCtryofRgstr
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityIncDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityIncNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityPreviousNames
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityRgstrDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityRgstrNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityTradeName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
BusinessEntityType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
This field is a relationship field.
Relationship Name
Contact
Relationship Type
Lookup
Refers To
Contact
CountryOfDomicile
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
CountryofBirth
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
CreditScore
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
CreditScoreProvider
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
DateOfBirth
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
EmploymentIndustry
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
EmploymentType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
FirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
FullName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
FundSource
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Not used for Health Cloud use cases.
Gender
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
HouseholdAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
This field is a relationship field.
Relationship Name
HouseholdAccount
Relationship Type
Lookup
Refers To
Account
Industry
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
IndustryClassificationCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
IsAged
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the patient is a senior citizen.
The default value is false.
IsBusEntyListonStockExch
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Not used for Health Cloud use cases.
The default value is false.
IsDisabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the person has a disability.
The default value is false.
IsInstitutionalized
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the person receives care at a care facility.
The default value is false.
IsLowIncome
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the patient is part of a low-income household.
The default value is false.
IsMedicaidEligible
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the patient is eligible for Medicaid assistance.
The default value is false.
IsNetWorthHigh
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Not used for Health Cloud use cases.
The default value is false.
IsOffBoarded
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Not used for Health Cloud use cases.
The default value is false.
IsRecalculationRequired
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates that the patient’s risk adjust value needs recalculation.
The default value is false.
LastName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
LastProfileReviewDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the record was last referenced.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the record was last viewed.
LeadId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
This field is a relationship field.
Relationship Name
Lead
Relationship Type
Lookup
Refers To
Lead
LegalEntityIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
MiddleName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the record.
Nationality
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
NextProfileReviewDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
OffBoardingComments
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
OffBoardingReason
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the record in the system.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Prefix
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
PrimaryEmail
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
PrimaryIdentificationName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
PrimaryIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
PrimaryIdentifierType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
PrimaryPhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
RelatedPartyProfileId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
This field is a relationship field.
Relationship Name
RelatedPartyProfile
Relationship Type
Lookup
Refers To
PartyProfile
ResidentType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
ReviewDecision
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
Stage
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
StockExchangeName
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Not used for Health Cloud use cases.
Suffix
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
SurnameAtBirth
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
TaxpayerIdentificationNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Not used for Health Cloud use cases.
TaxpayerIdentificationType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Not used for Health Cloud use cases.
Possible values are:
  • Business
  • Individual