Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
Claims
Clinical Data Model
ActivityTiming
AllergyIntolerance
AuthorNote
CareObservation
CarePerformer
CareRegisteredDevice
DiagnosticSummary
ClinicalAlert
ClinicalDetectedIssue
ClinicalDetectedIssueDetail
ClinicalEncounter
ClinicalServiceRequest
CodeSet
CodeSetBundle
ContactProfile
HealthcareFacility
HealthCondition
HealthRiskEvaluation
HealthRiskEvalDetail
HealthRiskEvalOutcome
Identifier
Medication
MedicationAdministration
MedicationDispense
MedicationRequest
MedicationStatement
PatientHealthReaction
PatientImmunization
PatientMedicalProcedure
PatientMedicationDosage
PersonLanguage
PersonName
ProblemDefRelationship
Specimen
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
Health Insurance
Home Health
Integrated Care Management
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
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
API End-of-Life Policy
PDF

PersonName

Represents detailed information about a person’s name. This object is available in API version 51.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

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

Fields

Field Details
EffectiveDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from when the name is in effect.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from when the name is no longer in use.
FirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The first name of the person.
FullName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The combination of the first and last names of the person.
IsPrimary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the name is the person’s primary name.
LastName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The person’s last name. In case the person’s name has more than just a first name and a last name, this field stores the combination of all names except the first name.
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.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The system-generated name of the PersonName record.
NameUsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the usage context of the name.
Possible values are:
  • Anonymous
  • Maiden
  • Nickname
  • Official
  • Old
  • Temp
  • Usual
OwnerId
Type
Reference
Properties
Create, Defaulted on Create, Filter, Group, Sort, Update
Description
The owner of the record.
Referenced Objects
  • User
  • Group
ParentRecordId
Type
Polymorphic master-detail reference
Properties
Create, Filter, Group, Sort
Description
References the person the name belongs to.
Referenced Objects
  • Account
  • Contact
Prefix
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The prefix of the person’s name.
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The source system from where the PersonName record was brought into Health Cloud.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier of the person name record in its source system.
SourceSystemModified
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the person name record was last modified in its source system.
Suffix
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The suffix of the person’s name.

Usage

PersonName is a data type-like object that’s associated to different objects representing people. The names and name-related information of a person are associated to them by referencing their account, contact, or person account records using the ParentRecordId field on PersonName.

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.

PersonNameFeed
Feed tracking is available for the object.
PersonNameHistory
History is available for tracked fields of the object.
PersonNameOwnerSharingRule
Sharing rules are available for the object.
PersonNameShare
Sharing is available for the object.
PersonNameChangeEvent (API version 61.0)
Change events are available for the object.
◊