Schedule Recurring Home Visit Action | Salesforce Health Cloud Developer Guide

This action is available in API version 58.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/scheduleRecurringHomeVisit
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
accountId	Type string Description Required Person account ID of the patient to schedule the set of recurring visits for.
careResourceCount	Type string Description The number of care resources required for the home visit.
clinicalServiceRequestId	Type string Description Required ID of the clinical service request record that's associated with the recurring home visits to be scheduled.
firstCareResourceSkillsIdsList	Type string Description ID of the clinical service request record that's associated with the recurring home visits to be scheduled.
firstVisitEndDateTime	Type datetime Description Scheduled date and time for the end of the first home visit.
flowInterviewId	Type string Description The ID of the flow interview to set the service appointment template's Comment field to when manually scheduling home visits.
recurrenceFrequencyType	Type string Description Required Days of recurring home visits. If specified, the selectedDays property is required. Valid values are: `Daily` `Weekly`
operatingHoursId	Type string Description ID of the operating hours record that specifies the time slots that the patient wants to schedule visits for.
schedulingPolicyId	Type string Description Required ID of the home health scheduling policy to be used to schedule the home visit.
recurringDaysList	Type string Description Comma-delimited list of days to schedule recurring home visits for the patient. For example, Monday, Thursday, Saturday. Required if the frequencyType property is set to `Weekly`.
secondCareResourceSkillsIdsList	Type string Description A comma-delimited list of skill record IDs required for the second care resource of home visits.
serviceAppointmentAddress	Type String Description Service appointment record that contains the home visit address specified by the user and is used to create the actual service appointment. Available in API version 66.0 and later.
serviceTerritoryId	Type string Description Required ID of the service territory record that contains the care resources to be assigned to the visits.
skillsIdsList	Type List<String> Description Comma-delimited list of record IDs of all skills required for the home visits.
firstVisitStartDateTime	Type datetime Description Required Scheduled date and time for the start of the first home visit.
usageType	Type string Description Specifies the method of scheduling of home visits for the action. Valid value is Manual.
visitsRequired	Type integer Description Required Number of recurring home visits to schedule.
visitSourceId	Type string Description ID of the source from where visits are created.
workTypeIdsList	Type List <String> Description A comma-delimited list of work type record IDs associated with the clinical service request of the home visit.

Outputs

Output	Details
careServiceVisitPlanId	Type string Description Required ID of the care service visit plan record that’s associated with the service request.
serviceAppointmentId	Type string Description The ID of the service appointment that was used as a template to manually schedule home visits.

Example

POST

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

1{
2  "inputs": [
3    {
4      "schedulingPolicyId":"a0cSG0000002RlxxAE",
5      "firstVisitStartDateTime":"2024-07-14T07:00:00.000Z",
6      "firstVisitStartEndTime" : "2024-07-15T07:00:00.000Z",
7      "visitsRequired" : 2,
8      "frequencyType" : "DAILY",
9      "selectedDays" : "Monday, Thursday",
10      "clinicalServiceRequestId": "0jySG0000000VFxxAM",
11      "skillsIdList": ["0C5xx0000004C92, 0C5xx0000004C93"],
12      "operatingHoursId": "0OHxx0000004CKKGA2",
13      "accountId": "001SG00000LNllxxAT",
14      "serviceTerritoryId": "0HxxG00000047xN0AQ",
15      "firstCareResourceSkillsIdsList": [0D2xx0000008DC91, 0D2xx0000008DC91],
16      "secondCareResourceSkillsIdsList": [0P5xx0000004F16, 0P5xx0000004F16],
17      "careResourceCount" : 1,
18      "workTypeIdsList": ["08qSG0000002b1xxAA"],
19      "visitSourceId": ["0Q0SG000000821R0xx"]
20    }
21  ]
22}

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

1[ {
2  "actionName" : "scheduleRecurringHomeVisit",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6      "careServiceVisitPlanId": "0qExx00000000WHEAY"
7      "serviceAppointmentId": "0bZxx00000000yKEDB"
8    },
9  "version" : 1
10} ]