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

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