Schedule Recurring Home Visit Action

Create a set of recurring home healthcare visits and assign service resources to them based on the specified scheduling policy.

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

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
`accountId`	string	Required Person account ID of the patient to schedule the set of recurring visits for.
`careResourceCount`	string	The number of care resources required for the home visit.
`clinicalServiceRequestId`	string	Required ID of the clinical service request record that’s associated with the recurring home visits to be scheduled.
`firstCareResourceSkillsIdsList`	string	ID of the clinical service request record that’s associated with the recurring home visits to be scheduled.
`firstVisitEndDateTime`	datetime	Scheduled date and time for the end of the first home visit.
`flowInterviewId`	string	The ID of the flow interview to set the service appointment template’s Comment field to when manually scheduling home visits.
`recurrenceFrequencyType`	string	Required Days of recurring home visits. If specified, the `selectedDays` property is required. Valid values are: `Daily` `Weekly`
`operatingHoursId`	string	ID of the operating hours record that specifies the time slots that the patient wants to schedule visits for.
`schedulingPolicyId`	string	Required ID of the home health scheduling policy to be used to schedule the home visit.
`recurringDaysList`	string	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`	string	A comma-delimited list of skill record IDs required for the second care resource of home visits.
`serviceAppointmentAddress`	String	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`	string	Required ID of the service territory record that contains the care resources to be assigned to the visits.
`skillsIdsList`	List<String>	Comma-delimited list of record IDs of all skills required for the home visits.
`firstVisitStartDateTime`	datetime	Required Scheduled date and time for the start of the first home visit.
`usageType`	string	Specifies the method of scheduling of home visits for the action. Valid value is: Manual.
`visitsRequired`	integer	Required Number of recurring home visits to schedule.
`visitSourceId`	string	ID of the source from where visits are created.
`workTypeIdsList`	List <String>	A comma-delimited list of work type record IDs associated with the clinical service request of the home visit.

Outputs

Output	Type	Description
`careServiceVisitPlanId`	string	Required ID of the care service visit plan record that’s associated with the service request.
`serviceAppointmentId`	string	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} ]