Salesforce Health Cloud Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Creating and Importing Documents
Appointed Representative
Care Request Case
Care Request Patient
Care Authorization Request
Care Authorization Request Related Record
Care Authorization Request Result
Create or Update Care Authorization Request Result
Care Diagnosis
Care Program Enrollment Result
Care Request Drug
Care Request Item
Care Request
Care Authorization Request Response
Create Visit Output
Custom Field Value
Dispenser Address
Document Conflict Field
Document Conflict Field List
Document Management Result
Document Process Output
Error Response Output
Enrollee Product Result
Enrollment Card Result
Error Message
First Reviewer
FHIR Reference
Field Value Output
FHIR Address
FHIR Codeable Concept
FHIR Coding
FHIR Human Name
FHIR Contact Point
FHIR Identifier
FHIR Patient
General Practitioner
HPI Score Sync Output
HPI Score Sync State Output
Medication Statement Output
Medication Statement Update Output
Medical Director
Original Denial Medical Director
Object Field
Object Field List
OCR Document Scan Result
OCR Document Scan Result List
Patient Communication Language
Patient Contact Party
Patient Get
Patient Upsert
Patient Update
Process Definition Output
Process Detail Output
Program Enrollment Result
Requesting Practitioner
Servicing Facility
Servicing Practitioner
Subscriber
Search Field
Search Output
Search Result
Search Result Header
Selected Search Result Output
Transport Location
Verified Result Output
Verifier Output
Verification Context Output
Verification Process Field List Output
Verification Process Field Output
API End-of-Life
Newer Version Available
Response Bodies
A resource can return a response body in either JSON or XML format.
Refer to HTTP response code to find out whether the request was successful or not, as well as the error messages for the failed requests.
-
Appointed Representative
Person who is an appointed representative for the member. -
Care Request Case
Case related to the care request. -
Care Request Patient
The patient for whom the request is being raised. -
Care Authorization Request
Output of create or update request for care services review. -
Care Authorization Request Related Record
Care Authorization request related record output representation -
Care Authorization Request Result
Result of POST or PATCH request. -
Create or Update Care Authorization Request Result
Response to create or update care services review request. -
Care Diagnosis
Associated diagnosis including code type, name, and description. One or more care diagnoses can be associated with a care request. -
Care Program Enrollment Result
Result containing details about a single patient enrollment. -
Care Request Drug
Requested drug including name, strength, frequency, and instructions for administration. One or more drug requests can be associated with a care request. -
Care Request Item
The details of a care service request, including name, modifiers, and the effective date. One or more care service requests can be associated with a care request. -
Care Request
The general details of a care-related request including member information, admission date, decision reason, and so on. A single request can contain multiple diagnoses, services, or drugs. Care requests include prior authorizations for drugs and services, admission notifications, concurrent review of admissions, appeals, complaints, and grievances. -
Care Authorization Request Response
The response body for the Care Services Review GET request. -
Create Visit Output
Output representation of the create visit request. -
Custom Field Value
The output representation of the custom field values. -
Dispenser Address
Pharmacy address. -
Document Conflict Field
Output representation of the target object field with conflict. -
Document Conflict Field List
Output representation of the target object fields with conflicts. -
Document Management Result
Output representation of the document split request. -
Document Process Output
Output representation of the document process creation or update request. -
Error Response Output
Error response representation. -
Enrollee Product Result
Details about the enrolleeās products. -
Enrollment Card Result
Details of the enrollment care for a single enrollee. -
Error Message
A generic error message containing error code and the message text. -
First Reviewer
The name of the person who reviewed the request first. -
FHIR Reference
The output representation of the FHIR reference values. -
Field Value Output
Represents the value of a field. -
FHIR Address
The output representation of the FHIR address values. -
FHIR Codeable Concept
The output representation of the Code Set Bundle records created to represent a codeableConcept value. -
FHIR Coding
The output representation of the Code Set records created to represent a Coding value. -
FHIR Human Name
The output representation of a PersonName record created to represent a humanName value. -
FHIR Contact Point
The output representation of contact details stored as a ContactPointPhone record. -
FHIR Identifier
The output representation of the Identified records created to represent an identifier value. -
FHIR Patient
The output representation of the patient stored in Salesforce, as specified in the input request. -
General Practitioner
Member's primary or general care practitioner. -
HPI Score Sync Output
Output representation of the score synchronization request. -
HPI Score Sync State Output
Output representation of the score synchronization status request. -
Medication Statement Output
Output representation of the medication statement create request. -
Medication Statement Update Output
Output representation of medication statement update request. -
Medical Director
Name of the medical director who reviewed the request. -
Original Denial Medical Director
The name of the medical director who denied the original request. -
Object Field
Output representation of of the target object field. -
Object Field List
Output representation of the target object fields list. -
OCR Document Scan Result
Output representation of the OCR document scan result ID. -
OCR Document Scan Result List
Output representation of the list of the OCR document scan results IDs. -
Patient Communication Language
The output representation of the PersonLanguage records that represent the communication preferences of a person. -
Patient Contact Party
The output representation of contact parties associated with a patient. -
Patient Get
Output representation of details of a patient record. -
Patient Upsert
Output representation of result after a Patient FHIR resource is created. -
Patient Update
Output representation of result after a Patient FHIR resource is updated. -
Process Definition Output
Represents the Identity Verification Process Definition record. -
Process Detail Output
Represents the Identity Verification Process Detail record. -
Program Enrollment Result
Result containing details of all patient enrollment status. If there is success, it contains id of new records created for each patient. -
Requesting Practitioner
Ordering or referring practitioner for the request. -
Servicing Facility
Facility where the service is being provided. -
Servicing Practitioner
Practitioner administering the service. -
Subscriber
The primary member on the plan. -
Search Field
Output representation of the search result field. -
Search Output
Output representation of the search response. -
Search Result
Output representation of the search result. -
Search Result Header
Output representation of the search result header. -
Selected Search Result Output
Represents the selected search result. -
Transport Location
Transport Location output representation -
Verified Result Output
Represents the required and optional fields that are verified. -
Verifier Output
Represents a verifier. -
Verification Context Output
Represents the Verification Context resource output. -
Verification Process Field List Output
Represents the list of fields in the Identity Verification Process Field record. -
Verification Process Field Output
Represents the Identity Verification Process Field record.