Skip Navigation

Create Template of Service Appointment Action

Create a service appointment record of Cancelled status that's used as a template for creating the actual service appointment record while scheduling home visits manually.

This action is available in API version 66.0 and later for users with the Home Health enabled.

Supported REST HTTP Methods

URI: /services/data/v66.0/actions/standard/createTemplateOfServiceAppt
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
accountId	Type String Description Required. The person account ID of the patient to schedule the visits for.
clinicalServiceRequestId	Type String Description Required. The ID of the clinical service request record that's associated with the home visits to be scheduled.
firstVisitEndDateTime	Type DateTime Description The date and time when the first recurring home visit ends.
firstVisitStartDateTime	Type DateTime Description Required. The scheduled date and time for the start of the first recurring home visit.
flowInterviewId	Type String Description Required. The ID of the flow interview to set the service appointment template's Comment field to when manually scheduling home visits.
operatingHoursId	Type String Description The ID of the operating hours record that specifies the time slots to schedule the home visit for.
recurrenceFrequencyType	Type Picklist Description Required. Specifies the type of recurring home visits. If Weekly is specified, Recurring Days List is required. Valid values are Daily and Weekly.
recurringDaysList	Type String Description The comma-delimited list of days to schedule recurring home visits for the patient. For example, Monday, Thursday, and Saturday.
schedulingPolicyId	Type String Description Required. The ID of the home health scheduling policy to be used to identify care resources available for the home visits.
serviceAppointmentAddress	Type SObject Description Required. The service appointment record that contains the home visit address specified by the user and is used to create the actual service appointment.
serviceTerritoryId	Type String Description Required. The ID of the service territory record that contains the care resources to be assigned to the visits.
skillsIdsList	Type String Description The comma-delimited list of record IDs of all skills required for the home visits.
visitsRequired	Type Integer Description Required. The number of recurring home visits to be scheduled.
workTypeId	Type ID Description The ID of the work type record that's associated with the clinical service request of the home visit.