Schedule Home Visits Manually Action

Create start of care or recurring home visits and assign care resources that are manually selected by the scheduler to the visits.

This action is available in API version 61.0 and later.

Special Access Rules

Schedule Home Visits Manually 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/scheduleHomeVisitsManually
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
accountId	Type String Description Required Personal account ID of the patient for whom the visit is to be scheduled. For each API call, you can send only one account ID in the payload.
clinicalServiceRequestId	Type String Description Required ID of the clinical service request record that's associated with the home visits to be scheduled.
firstVisitEndDateTime	Type Datetime Description Date and time when the first recurring home visit ends.
firstVisitStartDateTime	Type Datetime Description Required Date and time when the first recurring home visit starts.
operatingHoursId	Type String Description ID of the operating hours record that specifies the time slots to schedule the home visit.
recurringDaysList	Type String Description Comma-delimited list of days to schedule recurring home visits. For example, `Monday`, `Thursday`, and `Saturday`. If recurrenceFrequencyType is set to `Weekly`, recurringDaysList is required.
recurrenceFrequencyType	Type String Description Type of recurring home visits. If `Weekly` is specified, recurringDaysList is required. Valid values are: `Daily` `Weekly`
resourceDetails	Type Apex defined Description Required Collection of Apex `heathcloudext__ResourceDetails` records containing resources and schedule intervals for the visit.
schedulingPolicyId	Type String Description Required ID of the home health scheduling policy that's used to identify care resources available for the home visits.
serviceTerritoryId	Type String Description Required ID of the service territory record that contains the care resources to be assigned to the visits. Available in API version 66.0 and later.
skillIds	Type String Description Collection of up to 20 record IDs of skills required for the home visits.
visitsRequired	Type Integer Description Number of recurring home visits to be scheduled.
visitSourceId	Type String Description The ID of the reference record to use as a source to schedule the home visit. Available in API version 64 and later.
visitType	Type String Description Required Type of home visit to be scheduled. Valid values are: `Start of Care` `Recurring`
workPlanTemplateIds	Type String Description Collection of IDs of work plan template records that are assigned to the service appointment and specify the care instructions to be followed during the home visit. Available in API version 66.0 and later.

Outputs

Output	Details
careServiceVisitPlanId	Type String Description ID of the care service visit plan record that’s associated with the service request for recurring home visits.
careServiceVisitId	Type String Description ID of the care service visit record that’s associated with the service request to start a care home visit.

Example

POST

This sample request is for the Schedule Home Visits Manually action when visitType is Start of Care.

1{
2    "inputs": [
3        {
4            "accountId": "001xx000003GYv7AAG",
5            "visitType": "StartOfCare",
6            "schedulingPolicyId": "a0cxx000000fzXpAAI",
7            "clinicalServiceRequestId": "0jyxx0000000001AAA",
8            "serviceTerritoryId": "0Hhxx0000004C93CAE",
9            "firstVisitStartDateTime": "2026-02-18T05:30:00Z",
10            "firstVisitEndDateTime": "2026-02-18T07:35:00Z",
11            "visitsRequired": 1,
12            "skillIds": [
13              "0C5SG0000003O930AE"
14            ],
15            "resourceDetails": [
16                
17  
18  {
19    "sequence": 1,
20    "scheduleStart": "2026-02-18T05:30:00Z",
21    "scheduleEnd": "2026-02-18T06:30:00Z",
22    "resourceId": "0Hnxx0000004C92CAE"
23  }
24
25      ]
26        }
27    ]
28}

This sample request is for the Schedule Home Visits Manually action when visitType is Recurring.

1{
2  "inputs": [
3    {
4      "accountId": "001xx000003GYv7AAG",
5      "visitType": "Recurring",
6      "schedulingPolicyId": "a0cxx000000fzXpAAI",
7      "clinicalServiceRequestId": "0jyxx0000000001AAA",
8      "recurrenceFrequencyType": "Weekly",
9      "recurringDaysList": [
10        "Monday",
11        "Tuesday"
12      ],
13      "operatingHoursId": "0OHxx0000004C93GAE__USER",
14      "serviceTerritoryId": "0Hhxx0000004C93CAE",
15      "firstVisitStartDateTime": "2026-02-23T05:30:00Z",
16      "firstVisitEndDateTime": "2026-02-23T07:35:00Z",
17      "visitsRequired": 2,
18      "skillIds": ["0C5SG0000003O930AE"],
19      "resourceDetails": [
20        {
21          "sequence": 1,
22          "scheduleStart": "2026-02-23T05:30:00Z",
23          "scheduleEnd": "2026-02-23T06:30:00Z",
24          "resourceId": "0Hnxx0000004C92CAE"
25        },
26        {
27          "sequence": 2,
28          "scheduleStart": "2026-02-24T05:30:00Z",
29          "scheduleEnd": "2026-02-24T06:30:00Z",
30          "resourceId": "0Hnxx0000004C92CAE"
31        }
32      ]
33    }
34  ]
35}

This sample response is for the Schedule Home Visits Manually action when visitType is Start of Care.

1[ {"careServiceVisitId":"0oxxx00000000WHAAY"} ]

This sample response is for the Schedule Home Visits Manually action when visitType is Recurring.

1[ {"careServiceVisitPlanId":"0qExx0000000001EAA"} ]

Salesforce Health Cloud Developer Guide