Reschedule Recurring Home Visits Action | Salesforce Health Cloud Developer Guide

This action is available in API version 60.0 and later.

Special Access Rules

The Schedule Recurring 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/v66.0/actions/standard/rescheduleRecurringHomeVisits
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
schedulingPolicyId	Type string Description Required. ID of the home health scheduling policy to be used to schedule the home visit.
firstVisitStartDateTime	Type datetime Description Required. Rescheduled date and time for the start of the first recurring home visit.
firstVisitEndDateTime	Type datetime Description Rescheduled date and time for the end of the first recurring home visit.
recurrenceFrequencyType	Type string Description Required. Days of recurring home visits. If specified, the selectedDays property is required. Valid values are: `Daily` `Weekly`
recurringDaysList	Type string Description Comma-delimited list of days to reschedule recurring home visits for the patient. For example, Monday, Thursday, Saturday. If recurrenceFrequencyType is set to Weekly, recurringDaysList is required.
operatingHoursId	Type string Description ID of the operating hours record that specifies the time slots that the patient wants to reschedule recurring visits for.
serviceAppointmentId	Type string Description Required. ID of the service appointment record that's associated with the first recurring home visit to be rescheduled.

Outputs

None.

Example

POST

This sample request is for the Reschedule Recurring Home Visit action.

1{ 
2  "inputs" : [
3    {
4      "schedulingPolicyId" : "001SG000005OtxxYA0",
5      "serviceAppointmentId" : "0jyxx0000000001AAA",
6      "firstVisitStartDateTime" : "2024-03-16T07:00:00.000Z",
7      "firstVisitEndDateTime" : "2024-03-17T01:00:00.000Z",
8      "operatingHoursId" : "0OHxx0000004CKKGA2",
9      "recurrenceFrequencyType" : "WEEKLY",
10      "recurringDaysList" : "Monday, Thursday"
11    }
12  ]
13}

This sample response is for the Reschedule Recurring Home Visit action.

1[ {
2  "actionName" : "rescheduleRecurringHomeVisits",
3  "errors" : null,
4  "isSuccess" : true,
5  "version" : 1
6} ]