Schedule Group Visits Action

Create visiting records for patient home visits by bundling them into a group and scheduling either a single start-of-care visit or a series of recurring visits associated with the bundled records.

This action is available in API version 60.0 and later.

Special Access Rules

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

Supported REST HTTP Methods

URI: /services/data/v61.0/actions/standard/scheduleGroupVisits
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 group visits.
appointmentBundlePolicyId	Type string Description Required. ID of the home health appointment bundle policy to be used to create the patient visit records.
workTypeId	Type string Description Required. ID of the work type that represents the care service that the visits are being scheduled for.
serviceTerritoryId	Type string Description Required. ID of the service territory record that contains the care resources to be assigned to the visits.
firstVisitStartDateTime	Type datetime Description Required. Scheduled date and time for the start of the first group visit.
firstVisitEndDateTime	Type datetime Description Date and time when the first group visit ends.
operatingHoursId	Type string Description ID of the operating hours record that specifies the time slots to schedule the group visit for.
skillsIdsList	Type string Description A comma-delimited list of record IDs of all skills required for the group visits.
isRecurringVisit	Type boolean Description Indicates whether recurring visits are scheduled. If false, then a single start-of-care group visit is scheduled.
recurrenceFrequencyType	Type string Description Required. Specifies the type of recurring group visits. If specified, the selectedDays property is required. Valid values are: `Daily` `Weekly`
recurringDaysList	Type string Description Comma-delimited list of days to schedule recurring group visits for patients. For example, Monday, Thursday, Saturday. If recurrenceFrequencyType is set to Weekly, recurringDaysList is required.
visitsRequired	Type integer Description The number of recurring group visits to be scheduled.
groupVisitAddress	Type Apex-defined(Input example of apex type: `1{“street":"123 Main St","city":"Cityville","state":"CA","zip":"12345"})` Description An Apex GroupVisitAddress record that specifies the address where the group visit for the selected patients is scheduled.
clinicalServiceRequestIdsList	Type string Description Comma-delimited list of record IDs of all clinical service requests of the selected patients in the group visit.

Outputs

None.

Example

POST

This sample request is for the Schedule Group Visits action.

1{ 
2  "inputs" : [
3    {
4      "schedulingPolicyId" : "001SG000005OtxxYA0",
5      "appointmentBundlePolicyId" : "0jyxx0000000001AAA",
6     ."workTypeId" : "0jyxx0000000001AAA",
7      "serviceTerritoryId" : "0HxxG00000015dZ0AQ",
8      "serviceTerritoryId" : "0HxxG00000015dZ0AQ",
9      "firstVisitStartDateTime" : "2024-03-16T07:00:00.000Z",
10      "isRecurringVisit" : "false",
11      "operatingHoursId" : "0OHxx0000004CKKGA2",
12      "recurrenceFrequencyType" : "WEEKLY",
13      "recurringDaysList" : "Monday, Thursday",
14      "clinicalServiceRequestIdsList" :["0jxxG0000000b1BYAQ","0jyxx0000000b1KYAQ"],
15      "groupVisitAddress" :{ "city" : "Hyderabad" }
16    }
17  ]
18}

This sample response is for the Schedule Group Visits action.

1[ {
2  "actionName" : "scheduleGroupVisits",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6      "careServiceVisitPlanId": "null"
7      "bundleStatusMessage": "Group visit request has been submitted"
8    },
9  "version" : 1
10} ]

Salesforce Health Cloud Developer Guide