Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Create Referral Action
Get Data Using Context Definition Action
Get Resources for Manual Scheduling Action
Handle Resource Absence Action
Process Received Document Action
Reschedule Recurring Home Visits Action
Schedule Group Visits Action
Schedule Home Visit Action
Schedule Home Visits Manually Action
Schedule Recurring Home Visit Action
Metadata Types
API End-of-Life Policy
PDF

Schedule Home Visit Action

Schedule a home visit for the patient to assess the condition before scheduling the recurring visits for the patient care.

This action is available in API version 58.0 and later.

Special Access Rules

The Schedule Home Visit action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting.

Supported REST HTTP Methods

URI
/services/data/v64.0/actions/standard/scheduleHomeVisit
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
schedulingPolicyId
Type
String
Description

Required.

ID of the scheduling policy that determines the service resource and the visit time to assign to the specified service appointment.
serviceAppointmentId
Type
String
Description

Required.

ID of the service appointment that’s assigned a service resource for the home visit.

Outputs

None.

Example

POST

This sample request is for the Schedule Home Visit action.

{ 
  "inputs" : [
    {
      "schedulingPolicyId" : "7sTSG00000001H32AI",
      "serviceAppointmentId" : "08pSG0000000QSLYA2"
    }
  ]
}

This sample response is for the Schedule Home Visit action.

[ {
  "actionName" : "scheduleHomeVisit",
  "errors" : null,
  "isSuccess" : true,
  "outputValues" : null,
  "version" : 1
} ]