Reschedule Recurring Home Visits Action

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/vXX.X/actions/standard/rescheduleRecurringHomeVisits

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
schedulingPolicyId	string	Required. ID of the home health scheduling policy to be used to schedule the home visit.
firstVisitStartDateTime	datetime	Required. Rescheduled date and time for the start of the first recurring home visit.
firstVisitEndDateTime	datetime	Rescheduled date and time for the end of the first recurring home visit.
recurrenceFrequencyType	string	Required. Days of recurring home visits. If specified, the selectedDays property is required. Valid values are: `Daily` `Weekly`
recurringDaysList	string	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	string	ID of the operating hours record that specifies the time slots that the patient wants to reschedule recurring visits for.
serviceAppointmentId	string	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.

{ 
  "inputs" : [
    {
      "schedulingPolicyId" : "001SG000005OtxxYA0",
      "serviceAppointmentId" : "0jyxx0000000001AAA",
      "firstVisitStartDateTime" : "2024-03-16T07:00:00.000Z",
      "firstVisitEndDateTime" : "2024-03-17T01:00:00.000Z",
      "operatingHoursId" : "0OHxx0000004CKKGA2",
      "recurrenceFrequencyType" : "WEEKLY",
      "recurringDaysList" : "Monday, Thursday"
    }
  ]
}

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

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