Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Schedule Home Visit Action

Schedule a home visit for the patient to assess the condition before scheduling the recurring visits for the patient care.

This action is available in API version 58.0 and later.

Special Access Rules

The Schedule 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/v67.0/actions/standard/scheduleHomeVisit
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
schedulingPolicyId	Type String Description Required. ID of the scheduling policy that determines the service resource and the visit time to assign to the specified service appointment.
serviceAppointmentId	Type String Description Required. ID of the service appointment that’s assigned a service resource for the home visit.

Outputs

None.

Example

POST

This sample request is for the Schedule Home Visit action.

1{ 
2  "inputs" : [
3    {
4      "schedulingPolicyId" : "7sTSG00000001H32AI",
5      "serviceAppointmentId" : "08pSG0000000QSLYA2"
6    }
7  ]
8}

This sample response is for the Schedule Home Visit action.

1[ {
2  "actionName" : "scheduleHomeVisit",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : null,
6  "version" : 1
7} ]

Agentforce Health Developer Guide