Get Resources for Manual Scheduling Action | Salesforce Health Cloud Developer Guide

This action is available in API version 61.0 and later.

Special Access Rules

The Get Resources for Manual Scheduling 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/getResourcesForMnlScheduling
Formats: JSON, XML
HTTP Methods: GET
Authentication: Authorization: Bearer token

Inputs

Input	Details
operatingHoursId	Type String Description ID of the operating hours record that specifies the time slots to schedule a home visit.
recurringDaysList	Type List <String> Description Comma-delimited list of days to schedule recurring home visits. For example, `Monday`, `Thursday`, and `Saturday`. If recurrenceFrequencyType parameter is set to `Weekly`, the recurringDaysList parameter is required.
recurrenceFrequencyCount	Type Integer Description Number of recurring home visits to be scheduled `Weekly` or `Daily`, based on the value specified in the recurrenceFrequencyType parameter. When recurrenceFrequencyType parameter value is `Weekly`, the recurrenceFrequencyCount parameter value specifies the number of home visits to schedule per week. When recurrenceFrequencyType parameter value is `Daily`, the recurrenceFrequencyCount parameter value specifies the number of home visits to schedule per day.
recurrenceFrequencyType	Type String Description Required Type of recurring home visits. Valid values are: `Daily` `Weekly` If the value is set to `Weekly`, the recurringDaysList parameter is required.
resourceRecommendationCount	Type Integer Description Required Maximum number of resource recommendations to be shown to the scheduler.
schedulingPolicyId	Type String Description Required ID of the home health scheduling policy to be used to identify care resources available for the home visits.
serviceAppointmentId	Type String Description Required ID of a service appointment record that’s used to get the eligible resources for the home visits.
visitsRequired	Type Integer Description Required Number of recurring home visits to schedule.
visitType	Type String Description Required Type of home visit to fetch the resources for. Valid values are: `Start of Care` `Recurring`
workTypeId	Type String Description ID of the work type record used to get the resources for the home visit.

Outputs

Output	Details
endDateTime	Type Datetime Description Scheduled end for the returned slot.
grade	Type Integer Description Grade for the resource recommendation.
manualSchedulingRecommendations	Type JSON Description JSON collection of the resourceRecommendations parameter that contains resource details such as resource name, resource ID, and their available time intervals.
recommendationGrade	Type Integer Description Grade for the resource and slot combination.
resourceId	Type String Description ID of the selected service resource.
resourceName	Type String Description Name of the selected service resource.
resourceRecommendations	Type JSON Description JSON collection for each resource that contains resource details such as resource name, resource ID, their available time slots, and the grade for the resource recommendation.
sequence	Type Integer Description Sequence of this interval in the returned list of resources.
startDateTime	Type Datetime Description Scheduled start for the returned slot.
scheduleIntervalRecommendations	Type JSON Description JSON that contains time interval details for the recommended resource. The details include start date, end date, grade for the time slot, and the sequence number in which the service appointment gets scheduled.
visitType	Type String Description Type of home visit to fetch the resources for. Valid values are: `Start of Care` `Recurring`

Example

GET

This sample request is for the Get Resources for Manual Scheduling action.

1{
2    "inputs": [
3        {
4            "visitType": "Recurring",
5            "schedulingPolicyId": "a0cSGxx0000CD37YAG",
6            "workTypeId": "08qSG0000004zBNYxx",
7            "recurrenceFrequencyType": "WEEKLY",
8            "recurrenceFrequencyCount": 2,
9            "visitsRequired": 2,
10            "recurringDaysList": "Monday,Tuesday",
11            "resourceRecommendationCount": 3,
12            "operatingHoursId": "0OHSG00000xxSUH4A4",
13            "serviceAppointmentId": "08pSG00000xxUrdYAG"
14        }
15    ]
16}

This sample response is for the Get Resources for Manual Scheduling action.

1
2{
3    {
4        "visitType": "Recurring",
5        "manualSchedulingRecommendations": [
6            {
7                "resourceRecommendations": [
8                    {
9                        "scheduleIntervalRecommendations": [
10                            {
11                                "startDateTime": "2024-08-05T12:59:59.000Z",
12                                "sequence": 1,
13                                "grade": "100",
14                                "endDateTime": "2024-08-05T01:00:00.000Z"
15                            },
16                            {
17                                "startDateTime": "2024-08-06T05:15:00.000Z",
18                                "sequence": 2,
19                                "grade": "0",
20                                "endDateTime": "2024-08-06T02:00:00.000Z"
21                            }
22                        ],
23                        "resourceName": "Allen Smith",
24                        "resourceId": "0HnSG00000085yb0xx"
25                    }
26                ],
27                "recommendationGrade": "85"
28            }
29        ]
30    }
31}