Newer Version Available

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

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()

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Account that this healthcare provider is associated with.
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).
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.
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, Sort, Update
Description
Name of the provider.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who owns this record.
PractitionerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Practitioner that this healthcare provider record is associated with.
ProviderClass
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Class of facility, such as a provider organization, provider employee, or individual provider.
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
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, 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.

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.

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.