HealthcareProvider

Represents business-level details about the provider organization or the practitioner.

Supported Calls

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

Special Access Rules

This object is available if Provider Management is 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
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Account that this healthcare provider is associated with.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
CaqhIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
Provider's unique ID assigned by the Council for Affordable Quality Healthcare (CAQH).
Available only if View Healthcare Details is enabled under Provider Management Settings.
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The description of the service provider.
EffectiveFrom
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from which this provider is effective.
EffectiveTo
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which this provider is no longer effective.
EhrSystem
Type
textarea
Properties
Create, Nillable, Update
Description
Name of the EHR system used at this facility or organization.
Available only if View Healthcare Details is enabled under Provider Management Settings.
InitialStartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date that the facility first became operational or the practitioner first started practicing.
IsNotSearchable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Exclude this provider from search results.
The default value is false.
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.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. Name of the provider.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Required. The ID of the user who owns this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PractitionerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Practitioner that this healthcare provider record is associated with.
This field is a relationship field.
Relationship Name
Practitioner
Relationship Type
Lookup
Refers To
Contact
ProviderClass
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Class of facility, such as a provider organization, provider employee, or individual provider.
Possible values are:
  • Individual Provider
  • Provider Employee
  • Provider Org
ProviderPhotoId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Content Document file that is a photo of the Healthcare Provider. This field is a relationship field.
This field is a relationship field.
Relationship Name
ProviderPhoto
Relationship Type
Lookup
Refers To
ContentDocument
ProviderType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Type of provider or facility.
Possible values are:
  • At Home Service Provider
  • Hospital
  • Medical Doctor
  • Onsite Service Provider
  • Transportation Service Provider
  • Virtual Service Provider
ReferredByContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Provider that originated the referral.
This field is a relationship field.
Relationship Name
ReferredByContact
Relationship Type
Lookup
Refers To
Contact
RelatedUserId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The User record that relates to the Healthcare Provider record. This field is a relationship field.
This field is a relationship field.
Relationship Name
RelatedUser
Relationship Type
Lookup
Refers To
User
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
System from which the record was sourced.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
ID of the system from which the record was sourced.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Current status of the provider.
Possible values are:
  • Active
  • Inactive
  • Pending
TerminationDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Termination date for this provider.
TerminationReason
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reason for termination.
TotalLicensedBeds
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Total number of licensed beds at this facility, if applicable.
Available only if View Healthcare Details is enabled under Provider Management Settings.

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.

HealthcareProviderChangeEvent (API version 59.0)
Change events are available for the object.
HealthcareProviderFeed
Feed tracking is available for the object.
HealthcareProviderHistory
History is available for tracked fields of the object.
HealthcareProviderOwnerSharingRule
Sharing rules are available for the object.
HealthcareProviderShare
Sharing is available for the object.