Salesforce Health Cloud Developer Guide

Health Cloud Developer Guide
Health Cloud Objects
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Patient Creation
Creating and Importing Documents
Working With Electronic Health Records
Emergency Response Management
Health Cloud Business APIs
Create Patient
Create Provider
Use Cases
Prerequisites
Supported Fields
Resources
Code Samples
Error Handling
Care Program Enrollments
Care Services Review and Response
Contact Encounter
REST Reference
Health Cloud Metadata APIs
Health Cloud Custom Metadata Types
Health Cloud Empower Components for Experience Cloud Sites
PDF

Newer Version Available

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

Resources

Details and JSON samples
Resource
1/connect/health/providers
Available version
49.0 and later
Authentication
Authorization: Bearer token

The Lightning Platform REST API supports OAuth 2.0 (an open protocol to allow secure API authorization). See Authorize Apps with OAuth in Salesforce Help for more details.

Note

HTTP methods
POST

Supported Objects

Object Required Auto-filled Name field Required Fields Input/Output JSON key name
Account (for facility) or Contact (for practitioner) No NA account/contact
Accreditation No Yes Name accreditations
Award No Yes Name awards
BoardCertification No Yes Name boardCertifications
BusinessLicense No Yes Name businessLicenses
CareProviderAdverseAction No Yes Name careProviderAdverseActions
CareProviderFacilitySpecialty No Yes Name facilitySpecialties
HealthcareFacilityNetwork No Yes Name facilityNetworks
HealthcarePractitionerFacility No Yes Name practitionerFacilities
HealthcareProvider Yes Yes Name healthcareProvider
HealthcareProviderNpi No Yes Name npi
HealthcareProviderSpecialty No Yes Name specialties
HealthcareProviderTaxonomy No Yes Name taxonomies
Identifier No
OperatingHours No Yes Name, TimeZone operatingHours
PersonEducation (Practioner only) Yes Name personEducations
PersonEmployment (Practitioner only) Yes Name, RelatedPerson (Account/Contact) personEmployments
TimeSlots No No OperatingHours, StartTime, EndTime, DayOfWeek TimeSlots