Salesforce Health Cloud Developer Guide

Health Cloud Developer Guide
Health Cloud Data Model
Care Management
Program Management
Claims
Clinical Data Model
Code Sets for Diagnosis and Procedure
Electronic Health Records
Health Insurance
Intelligent Appointment Management
Home Health Care
Intelligent Sales
Provider Network Management
Provider Relationship Management Overview
Access to Provider Network Management
Vlocity Health and Insurance Objects Available in Health Cloud
ApplicationCase
BusinessLicense
CareProviderAdverseAction
CareSpecialtyTaxonomy
CareTaxonomy
IndividualApplication
Insurance Policy
PersonEducation
Accreditation
Award
BoardCertification
CareProviderFacilitySpecialty
CareProviderSearchableField
CareProviderSearchConfig
CareSpecialty
HealthcareFacilityNetwork
HealthcarePayerNetwork
HealthcarePractitionerFacility
HealthcareProvider
HealthcareProviderNpi
HealthcareProviderSpecialty
HealthcareProviderTaxonomy
ProviderNetworkContract
ProviderNetworkTier
Remote Monitoring and Device Registration
Social Determinants
Utilization Management
Benefits Verification Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
HealthCloudExt Namespace
Patient Creation
Creating and Importing Documents
Intelligent Appointment Management
Working With Electronic Health Records
Emergency Response Management
Health Cloud Business APIs
Metadata Types
Health Cloud Custom Metadata Types
Health Cloud Empower Components for Experience Cloud Sites
PDF

Newer Version Available

This content describes an older version of this product. View Latest

CareProviderSearchableField

This object holds denormalized data from certain fields in the Provider data model. Provider search APIs query this object instead of multiple objects, which improves search performance. This object is available in API version 47.0 and later.

Supported Calls

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

Fields

Field Details
Address
Type
textarea
Properties
Nillable
Description
Specified in Account.ShippingAddress.
CertificationType
Type
textarea
Properties
Nillable
Description
Specified in BoardCertification.CertificationType.

BoardCertification.HealthcareProvider must also be specified.

Note
EducationLevel
Type
textarea
Properties
Nillable
Description
Specified in PersonEducation.EducationLevel. Not applicable for a facility.

Degree, Status, DegreeEarner, and HealthCareProvider must also be specified.

Note
Facility
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Represents the facility with which the practitioner is associated. Use for practitioner records only. If the provider is a facility, this should be null.
FacilityName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Specified in Account.Name.
FacilityPhone
Type
phone
Properties
Filter, Group, Nillable, Sort
Description
Facility's main contact telephone number. Specified in Account.Phone.
IsAcceptingNewPatients
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the practitioner is accepting new patients. Specified in HealthcareFacilityNetwork.PanelStatus, where PanelStatus = Open indicates Accepting New Patients = true.

This field applies only to practitioners, not facilities.

Note
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.
NationalProviderIdentifier
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Provider’s unique NPI number. Specified in HealthcareProviderNpi.Account for a facility, and HealthcareProviderNpi.Practitioner for a practitioner.
OperatingHours
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Identifies a set of operating hours for this practitioner at this facility. Specified in Account.OperatingHours for a facility, or in HeathcarePractitionerFacility.OperatingHours for a practioner-facility combination. Hours must be specified in OperatingHours.
PhotoUrl
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The URL for a photograph of the practitioner. Field is synced based on Account-PhotoUrl or Contact.PhotoUrl.
PlanType
Type
textarea
Properties
Nillable
Description
The type of plan, with the following default options:
  • PPO
  • HMO
  • Medicare
  • Medicaid
  • Workers Comp
Specified in HealthcareFacilityNetwork.Account for a facility, or HealthcareFacilityNetwork.PractitionerFacility for a practitioner-facility combination.

HealthcareFacilityNetwork.Name and PayerNetwork.Name must also be populated.

Note
Provider
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Lookup to HealthcareProvider. Represents a facility or practitioner-facility combination.
ProviderName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of the provider. Specified in Account for a facility, or in Contact for a practitioner.
ProviderType
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Type of provider or facility. For example, pharmacist or ambulatory care facility. Specified in HealthCareProvider.ProviderType.
Specialty
Type
textarea
Properties
Nillable
Description
Specialty associated with the provider. Specified in CareProviderFacilitySpecialty.Account for a facility, or CareProviderFacilitySpecialty.HealthcarePractitionerFacility for a practitioner.

Specialty.SpecialtyType must also be specified.

Note
SubSpecialty
Type
textarea
Properties
Nillable
Description
Provider's subspecialty. Specified in HealthcareProviderTaxonomy.careTaxonomy.TaxonomyType. Not valid for a practitioner-facility combination.

Taxonomy.TaxonomyType must also be specified.

Note