Life Sciences Cloud Developer Guide

Life Sciences Cloud Overview
Life Sciences Cloud Data Model
Advanced Therapy Management
Adverse Events
Care Program Management
Clinical Data Model
Electronic Signatures
Financial Assistance Program
Health Insurance
Integrated Care Management
Intelligent Document Automation
Intelligent Sales
Participant Management
Patient Program Outcome Management
Pharmacy Benefits Verification
Provider Relationship Management
Site Management
Social Determinants
Timeline
Life Sciences Cloud for Customer Engagement
Account Management
Activity Plans
App Alerts
Consent Management
Field Email
General Events
Intelligent Content
Key Account Management
Life Sciences Commercial Engagement Configuration
Life Sciences Workflow Management
Lists and Filters
Medical Inquiries
Mobile Metadata
Mobile Sync
Next Best
Product Management
Visit Management
Remote Engagement
Samples Management
Segmentation
ActionableList
ActionableListFilterCriteria
HealthcareProvider
LifeSciAcctGrpAssignment
Subject Management
Surveys
System Objects
Territory Management
Life Sciences Cloud Associated Objects
Life Sciences Cloud Fields on Standard Objects
StandardValueSet Names and Standard Picklist Fields
Life Sciences Cloud Platform Events
Working With Electronic Health Records
Life Sciences Cloud Business APIs
Apex Reference
Life Sciences Cloud Standard Invocable Actions
Life Sciences Cloud Tooling API Objects
Life Sciences Cloud Metadata Types
API End-of-Life Policy
PDF

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.

Special Access Rules

In Life Sciences Cloud, the HealthCareProvider object and its fields are used by the Account Management and the Segmentation feature areas. This topic lists fields used in both features.

Supported Calls

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

Fields

Field Details
AbbreviatedName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the abbreviated name of the Japanese healthcare organization (HCO) for INS-DOC records. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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
AssociatedSampleLimit
Type
textarea
Properties
Create, Nillable, Update
Description
The JSON comprising the list of Sample Limits for the HealthcareProvider record. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
CaqhIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
This field is unique within your organization. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
DataChangeComments
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Captures comments explaining the reasons or context for changes made to the data. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
DoesDispenseMedication
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the account dispenses medication.
The default value is false. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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.
HasCarrierContract
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the provider’s contract follows a CMS model MA contract amendment, based on Centers for Medicare and Medicaid Services (CMS) guidelines.
The default value is false. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
HasSalesDataRestriction
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether access to the sales data about the healthcare provider is restricted.
The default value is false. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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.
IsNotSearchable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the provider is excluded from search results.
The default value is false. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
IsPrivacyLawEnabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the privacy law regulations are enabled.
The default value is false. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
IsSpeaker
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the provider is designated as a speaker for engagement.
The default value is false. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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.
OperatingCountryCode
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the country code of the country to which the account belongs.
Possible values are:
  • US
This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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
ParentOrganizationAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the ID of the parent account, used to establish the account hierarchy. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
Relationship Name
ParentOrganizationAccount
Refers To
Account
PhoneticName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the Japanese phonetic name, applicable to both HCP and HCO, which is used for sorting and text-based searches. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
PhoneticName2
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the Japanese phonetic name, applicable to both HCP and HCO, which is used for sorting and text-based searches. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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
ProfessionalDesignation
Type
multipicklist
Properties
Create, Filter, Nillable, Update
Description
Specifies the professional designation of the healthcare professional. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
ProfessionalTitle
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the professional title of the healthcare professional. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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
ProviderFullName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The full name of the healthcare provider. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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 Doctor
  • Pharmacist
  • Pharmacy
ReferredByContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the provider who originated the referral. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
Relationship Name
ReferredByContact
Refers To
Contact
RelatedHealthcareProviderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the HCP account associated with the INS-DOC. This field is a relationship field. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
Relationship Name
RelatedHealthcareProvider
Refers To
HealthcareProvider
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
SalesDataRstrcEffectiveDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the date when the sales data restriction becomes effective. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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
SourceSystemModifiedDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the date when the record was last updated in the source system
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the provider.
Possible values are:
  • Active
  • Inactive
  • Pending
This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.
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.
WrittenName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the Chines character name of the organization, applicable only to healthcare professionals (HCPs), which is required for INS-DOC records. This field is available with the Life Sciences Cloud for Customer Engagement Add-on license in API version 65.0 and later.

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.