BenefitPrvdSearchableFld

Represents a collection of denormalized data from certain fields in the Provider Management data model. Provider search queries this object instead of multiple objects, which improves search performance. This object is available in API version 59.0 and later.

Supported Calls

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

Special Access Rules

This object is available if Provider Management, Benefit Management, and Criteria-Based Search and Filter are enabled in your org. To access the object, you need the Provider Management Access permission set or the Provider Management permission set license. Partner users need the Provider Management for Partner permission set or permission set license.

Fields

Field Details
BenefitId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The benefit associated with the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProviderSpecialty.Specialty.BenefitSpecialty.Benefit.Id.
This field is a relationship field.
Relationship Name
Benefit
Relationship Type
Lookup
Refers To
Benefit
BenefitName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the benefit associated with the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to Benefit.Name.
BenefitTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The benefit type associated with the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProviderSpecialty.Specialty.BenefitSpecialty.Benefit.BenefitType.Id.
This field is a relationship field.
Relationship Name
BenefitType
Relationship Type
Lookup
Refers To
BenefitType
BenefitTypeName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the benefit type associated with the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to BenefitType.Type.
FacilityAddress
Type
location
Properties
Nillable
Description
The address of the service provider facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareFacility.Account.ShippingAddress.
FacilityAddressLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with facility address longitude to specify the precise geolocation of the service provider facility. Acceptable values are numbers between –90 and 90 with up to 14 decimal places.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareFacility.Account.ShippingLatitude.
FacilityAddressLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with facility address latitude to specify the precise geolocation of the service provider facility. Acceptable values are numbers between –90 and 90 with up to 14 decimal places.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareFacility.Account.ShippingLongitude.
FacilityGeoLocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The geolocation ID of the facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareFacility.Location.
This field is a relationship field.
Relationship Name
FacilityGeoLocation
Relationship Type
Lookup
Refers To
Location
FacilityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The facility ID associated with the practitioner.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProvider.HealthcarePractitionerFacility.Id.
This field is a relationship field.
Relationship Name
Facility
Relationship Type
Lookup
Refers To
HealthcarePractitionerFacility
FacilityName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the facility where the service is being provided.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareFacility.Name.
FacilityPhone
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The primary phone number of the facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareFacility.Account.Phone.
GenderRestriction
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gender preference specified by the physician for their patients.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcarePractitionerFacility.GenderRestriction.
HighestAgeServed
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The highest age of patients that the practitioner sees at the facility.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
LicenseJurisdictionCountry
Type
textarea
Properties
Create, Nillable, Update
Description
The country where the license of the provider is registered.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProvider.BusinessLicense.JurisdictionCountry.
LicenseJurisdictionRegion
Type
textarea
Properties
Create, Nillable, Update
Description
The region where the license of the provider is registered.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProvider.BusinessLicense.JurisdictionOther.
LicenseJurisdictionState
Type
textarea
Properties
Create, Nillable, Update
Description
The state where the license of the provider is registered.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProvider.BusinessLicense.JurisdictionState.
LicenseName
Type
textarea
Properties
Create, Nillable, Update
Description
The name of the license given to the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProvider.BusinessLicense.Name.
LicenseStatus
Type
textarea
Properties
Create, Nillable, Update
Description
The status of the license given to the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProvider.BusinessLicense.Status.
LowestAgeServed
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The lowest age of patients that the practitioner sees at the facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcarePractitionerFacility.LowestValidAge.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of this benefit provider searchable field record.
NationalProviderIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier for a provider from the National Plan and Provider Enumeration System.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProvider.HealthcareProviderNpi.Npi.
OperatingDaysList
Type
textarea
Properties
Create, Nillable, Update
Description
The list of days when the practitioner is available at the facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to OperatingHours.TimeSlot.DayOfWeek.
OperatingHoursId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Identifies a set of operating hours for the practitioner at a facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HeathcarePractitionerFacility.OperatingHoursId.
This field is a relationship field.
Relationship Name
OperatingHours
Relationship Type
Lookup
Refers To
OperatingHours
OperatingTimeSlotList
Type
textarea
Properties
Create, Nillable, Update
Description
The list of time slots when the practitioner is available at the facility on the operating days of the week.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the owner of this object.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PractitionerCertificationType
Type
textarea
Properties
Create, Nillable, Update
Description
The type of certification obtained by the practitioner.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthCareProvider.BoardCertification.CertificationType.
ProviderEducationLevel
Type
textarea
Properties
Create, Nillable, Update
Description
The education level of a person in a provider role.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthCareProvider.PersonEducation.EducationLevel.
ProviderGender
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The gender of the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthCareProvider.Contact.Gender or HealthCareProvider.Account.PersonGenderIdentity.
ProviderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The provider or practitioner facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthCareProvider.Id.
This field is a relationship field.
Relationship Name
Provider
Relationship Type
Lookup
Refers To
HealthcareProvider
ProviderName
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Name of the provider.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthCareProvider.Name.
ProviderPhotoUrl
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The URL for the photograph of the provider or practitioner.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareFacility.Account.PhotoUrl or HealthcareProvider.Practitioner.PhotoUrl.
ProviderSpeciality
Type
textarea
Properties
Create, Nillable, Update
Description
Specialty of the provider. Available in API version 59.0 only.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthcareProviderSpecialty.Specialty.SpecialtyType.
ProviderType
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of the provider or facility.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to HealthCareProvider.ProviderType.
SpecialtyId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
A specialty offered at the provider facility that's associated with the benefit provider searchable field.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to CareSpecialty.Id.
Available in API version 60.0 and later.
This field is a relationship field.
Relationship Name
Specialty
Relationship Type
Lookup
Refers To
CareSpecialty
SpecialtyName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Name of the specialty offered at the provider facility that's associated with the benefit provider searchable field.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records maps this field to CareSpecialty.Name.
Available in API version 60.0 and later.
UniqueKey
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
A unique identifier for the benefit provider searchable field record.
The Data Processing Engine definition Upsert Benefit Provider Searchable Field Records concatenates ProviderId, FacilityId, and BenefitId to generate the key.

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.

BenefitPrvdSearchableFldFeed
Feed tracking is available for the object.
BenefitPrvdSearchableFldHistory
History is available for tracked fields of the object.
BenefitPrvdSearchableFldOwnerSharingRule
Sharing rules are available for the object.
BenefitPrvdSearchableFldShare
Sharing is available for the object.