Newer Version Available

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

HealthcareProvider

Represents business-level details about the healthcare 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. This field is a relationship field.
Relationship Name
Account
Refers To
Account
Classification
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the classification of the healthcare provider. This field is available in API version 63.0 and later when Site Management is enabled.
Possible values are:
  • Key Opinion Leader
  • Novice Member
  • Previous Partner
DoesParticipateInRsrchStudy
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the healthcare provider participates in research studies (true) or not (false). This field is available in API version 63.0 and later when Site Management is enabled.
The default value is false.
DoesUseElecDataCapture
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the healthcare provider uses Electronic Data Capture (EDC) system (true) or not (false). This field is available in API version 62.0 and later when Site Management is enabled.
The default value is false.
EffectiveFrom
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the date from which the provider becomes effective.
EffectiveTo
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the date from which the 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
Specifies the date when the facility first became operational or the practitioner first began practicing.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last referenced 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. This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PractitionerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The practitioner that this healthcare provider record is associated with. This field is a relationship field.
Relationship Name
Practitioner
Refers To
Contact
ProviderClass
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The class of facility, such as an IPA, medical group, or solo practitioner.
Possible values are:
  • IPA
  • Medical Group
  • Solo Practitioner
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.
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. For example, pharmacist or ambulatory care facility.
Possible values are:
  • Ambulatory Care
  • Dentist
  • Hospital
  • Laboratory
  • Medical Director
  • Medical Doctor
  • Pharmacist
  • Pharmacy
  • Research Study Coordinator
  • Research Study Director
  • Research Study Feasibility Manager
  • Research Study Investigator
  • Research Study Nurse
  • Research Study Operations Manager
  • Research Study Sub-Investigator
  • Site Management Organization Coordinator
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.
Relationship Name
RelatedUser
Relationship Type
Lookup
Refers To
User
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system from which the record was sourced.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the system from which the record was sourced. This field is unique within your organization
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.

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.