CareProviderSearchableField

This object holds denormalized data from certain fields in the Provider Relationship Management 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

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

Condition

Type: textarea
Properties: Nillable
Description: The conditions represented by the problem definitions that the healthcare provider offers treatment for.

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

FacilityId

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, set this field value to 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 phone 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. The default value is false.

This field applies only to practitioners, not facilities.
Note

IsUpdateNeeded

Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether a change to data in a healthcare provider record or a related record requires a data sync (true) or not (false). The default value is false.

LanguagesSpoken

Type: textarea
Properties: Nillable
Description: The languages spoken by the person. Specified in PersonLanguage.Language.

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.

LicenseJurisdictionCountry

Type: String
Properties: Filter, Nillable
Description: The country where the license of the Healthcare Provider is registered. Specified in BusinessLicense.JurisdictionCountry.

This field is available in API version 57.0 or later.

LicenseJurisdictionRegion

Type: String
Properties: Filter, Nillable
Description: The region where the license of the Healthcare Provider is registered. Specified in BusinessLicense.JurisdictionRegion.

This field is available in API version 57.0 or later.

LicenseJurisdictionState

Type: String
Properties: Filter, Nillable
Description: The state where the license of the Healthcare Provider is registered. Specified in BusinessLicense.JurisdictionState.

This field is available in API version 57.0 or later.

LicenseName

Type: String
Properties: Filter, Nillable
Description: The name of the license associated with the Healthcare Provider. Specified in BusinessLicense.Name.

This field is available in API version 57.0 or later.

LicenseStatus

Type: String
Properties: Filter, Nillable
Description: Specifies the status of the license given to the Healthcare Provider. Specified in BusinessLicense.Status.

This field is available in API version 57.0 or later.

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.

OperatingHoursId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: Identifies a set of operating hours for this practitioner at this facility. Specified in Account.OperatingHoursId for a facility, or in HeathcarePractitionerFacility.OperatingHoursId for a practitioner-facility combination.

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

ProviderGender

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The gender of the HealthcareProvider. Specified in Contact.Gender or Account.PersonGender.

ProviderId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description: Lookup to HealthcareProvider. Represents a facility or practitioner-facility combination.

ProviderName

Type: string
Properties: Filter, Group, idLookup, 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, a pharmacist or an ambulatory care facility. Specified in HealthCareProvider.ProviderType.

Service

Type: textarea
Properties: Nillable
Description: The list of services that the healthcare provider offers.

ServiceCode

Type: textarea
Properties: Nillable
Description: The list of codes associated with the service that the healthcare provider offers.

Specialty

Type: textarea
Properties: Nillable
Description: Specialty associated with the provider. Specified in CareSpecialty.SpecialtyType.

For a facility, the Specialty is sourced from a Care Provider Facility Specialty record, which connects a facility (CareProviderFacilitySpecialty.AccountId) to a care specialty (CareProviderFacilitySpecialty.SpecialtyId).

For a practitioner, the Specialty is sourced from a Care Provider Facility Specialty record, which connects a Healthcare Practitioner Facility record (CareProviderFacilitySpecialty.PractitionerFacilityId) to a care specialty (CareProviderFacilitySpecialty.SpecialtyId). The Healthcare Practitioner Facility record then connects the facility (HealthcarePractitionerFacility.AccountId) to a practitioner (HealthcarePractitionerFacility.PractitionerId).

All source records must be active.

SubSpecialty

Type: textarea
Properties: Nillable
Description: Provider’s subspecialty. Specified in HealthcareProviderTaxonomy.TaxonomyType. Not valid for a practitioner-facility combination.

Taxonomy.TaxonomyType must also be specified.
Note

SyncLogRecord

Type: string
Properties: Filter, Group, Nillable, Sort
Description: The provider search sync log record that shows the data sync status of a healthcare provider record.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

CareProviderSearchableFieldChangeEvent (API version 60.0): Change events are available for the object.