Transportation Planner
Executive Summary
Transportation Planner is the coordinator's workspace for client transportation. For a chosen service day, staff load the transportation visits that are scheduled in AlayaCare, review each trip's pickup, appointment and return details, and then act on them: assign a driver and facility, cancel or delete visits, correct the employee on a single visit, open a visit for editing, or plot selected trips on a map. The same screen creates new transportation requests through a guided three-step Add Transportation Request wizard that builds the AlayaCare client services, visits (single or weekly recurring), activity codes and premiums from a trip template, and it can look up (and discharge) a client's existing services.
Key Features
- Load transportation visits for a service date, optionally limited to vacant visits, one employee, one client, or client groups
- Refine the loaded list by segment (appointment or return), facility, employee, client, pickup city, destination city and service code, and sort it six ways
- Choose which grid columns are shown and in what order (page settings)
- Assign selected visits to an employee, a facility, or both; cancel selected visits with a cancel code; delete selected visits (with permission)
- Handle recurring visits with a choice to change or delete only the selected visits, all future visits, or all future unmodified visits
- Edit the employee on a single visit, optionally carrying the change to the linked return visit
- Open a visit to view it, edit it (employee, facility, service code, date and time, duration, service instructions, tags and forms), cancel it or copy it
- Plot the pickup and drop-off of selected trips on a map, with route lines and a time window for the markers
- Create new transportation requests (appointment, return or two-way, single or weekly recurring) from a trip template, with pickup and destination locations, calculated distance and travel time, service code, facility, employee, visit tags, activity codes, premiums and billing contact
- Re-use a client's existing transportation service instead of creating a new one
- Look up a client's active services and discharge selected services
Typical Workflow
Review and manage existing trips
- Enter a Service Date (and any employee, client or group limits) and click Apply.
- Narrow the list with the Segments To Show options and the Filter ... drop-downs, choose a Sort Option, and click the second Apply.
- Tick the visits you want to work on, then use Assign Selected To Employee, Assign Selected To Facility, Assign Selected To Facility/Employee, Cancel Selected, Delete Selected or Map Selected.
- Right-click a single row and choose Edit Employee or Edit Visit to change just that visit.
- Use Previous Day, Next Day or Refresh to move through the schedule; use Clear to start a new lookup.
Create a new transportation request
- Click Add.
- On Request: choose the client and click Load Client; pick the Trip Segments and Trip Template; enter the service date, times and any weekly recurrence; choose Create New or Use Existing under Services Option; click Next.
- On Locations: confirm the pickup and destination, click Calculate Distance And Time, then click Next.
- On Finish: confirm the service code, facility, employee, tags, activity codes, premiums and billing contact, then click Finish.
Configurable Settings
Open View Settings or Edit Settings from this screen (when permitted) to change these options.
| Group | Setting | Type | Purpose |
|---|---|---|---|
| General | Grid Height In Pixels | Dropdown (a value can also be typed) | Height of the main trip grid on screen, in pixels. |
| Grid Columns | Column list (Column / Show) | Grid | Tick Show to display a column in the main grid. Drag rows to change the column order. Both are saved with the settings. |
| Grid Columns | Form Context Tag #1 to Form Context Tag #4 | Text | AlayaCare form context fields whose client values are shown (read-only) on the Request tab of the Add Transportation Request wizard. |
| Grid Columns | Care Provider Note Subject | Text | Subject of the client's care provider note shown on the Request tab (the most recent note with this subject is displayed). |
| Grid Columns | Appt Segment Prefix | Text | Text added to the front of the name of each new appointment-segment service created in AlayaCare. Add will not open unless this and the return prefix are filled in. |
| Grid Columns | Return Segment Prefix | Text | Text added to the front of the name of each new return-segment service. |
| Grid Columns | Time Format | Dropdown | Whether times in the Add Transportation Request wizard are entered and shown in 12-hour or 24-hour format. |
| Update Visit Overrides | Overlapping Visits | Yes/No | Allows new visits to be created even if they overlap another visit. |
| Update Visit Overrides | Service Instructions | Yes/No | Bypasses the AlayaCare service-instructions validation when creating visits. |
| Update Visit Overrides | Reason Code | Yes/No | Bypasses the AlayaCare reason-code validation when creating visits. |
| Update Visit Overrides | Locked Visit | Yes/No | Allows changes to visits that are locked in AlayaCare. |
| Update Visit Overrides | Blocked Employee | Yes/No | Allows an employee who is blocked for the client to be chosen on the Finish tab and used on new visits. |
| Update Visit Overrides | Unavailable Employee | Yes/No | Allows an employee who is unavailable at the visit time. |
| Update Visit Overrides | Blocked Facility | Yes/No | Allows a facility that is blocked for scheduling. |
| Update Visit Overrides | Authorization | Yes/No | Bypasses AlayaCare authorization checks when creating visits. |
| Data Entry | Require Pickup Time | Yes/No | Makes Pickup Time mandatory on the Request tab (the field label changes to "Pickup Time (required)"). |
| Data Entry | Allow Ad-Hoc Entry Of Activity Codes | Yes/No | Shows Add on the Finish tab so staff can add activity codes by hand. The Add button for premium codes follows this same setting. |
| Data Entry | Allow Ad-Hoc Entry Of Visit Tags | Yes/No | Shows the Visit Tags section on the Finish tab. |
| Data Entry | Allow Ad-Hoc Entry Of Visit Premiums | Yes/No | Intended to allow premiums to be added by hand. |
| Routing | Routing Mode | Dropdown | How driving directions are calculated: Fastest Time or Shortest Trip. |
| Routing | Avoid Toll Roads | Yes/No | Route calculation avoids toll roads. |
| Routing | Avoid Highways | Yes/No | Route calculation avoids highways. |
| Routing | Map Provider | Dropdown | Map used for the route preview on the Locations tab (Here or Google). |
Settings that affect this screen but are maintained outside this dialog include the client address-directions field shown on the Request tab, and the facility-scheduling rules that can stop a visit from being changed (for example visits that are already approved or started more than 24 hours ago).
Available Permissions
The following permissions are available to be assigned to AlayaCare Roles:
| Attribute | What It Controls |
|---|---|
| View | Open the page |
| Delete | Show Delete Selected (button and right-click menu) |
| Settings View | Open View Settings to see the page configuration |
| Settings Edit | Open Edit Settings and change the page configuration |
| Client Visit Cancel | Show Cancel in the visit dialog opened by Edit Visit |
| Client Visit Copy | Show Copy Visit in the visit dialog |
| Client Visit Edit Employee | Allow Edit Employee inside the visit editor |
| Client Visit Edit Service Code | Allow the service code to be changed inside the visit editor |
| Client Visit Edit Service Instructions | Allow service instructions to be changed inside the visit editor |
| Client Visit Edit Start/End Times | Contributes to showing Edit Visit |
| Client Visit Manage Forms | Contributes to showing Edit Visit |
| Client Visit Move | Allow Edit Facility inside the visit editor |
| Client Visit View In AlayaCare | Show View Client in AlayaCare in the visit dialog |
Edit Visit is shown in the visit dialog when the user holds at least one of Client Visit Edit Employee, Edit Service Code, Edit Service Instructions, Edit Start/End Times or Manage Forms.
Main Grid
The page opens with only the lookup controls. After you click Apply, the grid lists the transportation visits for the service day, one row per visit segment (20 columns can be shown; the first four stay frozen when you scroll sideways). A tick box on each row selects it for the bulk actions.
Cancelled visits and visits with no client are left out. A visit is included when its service code is a transportation service code and it carries a trip segment, or when its service code is a transportation service type.
The columns below are the defaults. Which ones show, and their order, are set in the page settings.
| Column | Description |
|---|---|
| Pickup Time | Visit start time as four digits, for example 0830. |
| Segment | Appt (outbound) or Return. |
| Appt Time | Appointment arrival time (the end time of an Appt segment). |
| Return Time | Start time of the linked return visit, for an Appt segment that has one. |
| Driver | Employee on the visit (last name, first name), or [Vacant Visit]. |
| Facility | Facility on the visit. |
| Client | Client last name, first name. |
| Phone | Client main phone, or the other phone when there is no main phone. |
| Pickup Location | "Home" for a home pickup, otherwise the location name. |
| Pickup Address | Pickup street address. |
| Pickup City | Pickup city. |
| Pickup Postal Code | Pickup postal code. |
| Destination Location | "Home" for a home drop-off, otherwise the location name. |
| Destination Address | Destination street address. |
| Destination City | Destination city. |
| Destination Postal Code | Destination postal code. |
| Service Code | Service code on the visit. |
| Service Instructions | Full service instructions from AlayaCare. |
| Custom Instructions | The text between the markers [ and ] in the service instructions (the free-text entered when the trip was created). |
| Distance | Trip distance in kilometres, recorded when the trip was created. |
| Premiums | Premium codes and quantities on the visit, for example "KM-12". |
Main Grid Filters
Lookup (before visits are loaded)
These controls are locked once visits are loaded. Click Clear to change them.
| Filter | Purpose |
|---|---|
| Service Date | Day whose transportation visits are loaded. Required. |
| Employee Type Selection | All (every visit), Vacant (visits with no driver assigned) or Specified (one employee). |
| Find an Employee | Shown when Specified is chosen; the employee to load. Required in that case. |
| Client | Optional; load only this client's visits. |
| Filter Groups | Optional; load only visits for clients in the chosen transportation groups. |
Click Apply to load the visits. Use Clear to reset the lookup.
Refinement (after visits are loaded)
| Filter | Purpose |
|---|---|
| Segments To Show | Appt, Return or All. |
| Filter Facilities | Show only the chosen facilities. |
| Filter Employees | Show only the chosen drivers. |
| Filter Clients | Show only the chosen clients. |
| Filter Pickup Cities | Show only the chosen pickup cities. |
| Filter Dest Cities | Show only the chosen destination cities. |
| Filter Service Codes | Show only the chosen service codes. |
| Sort Option | Pickup Time, Client, Employee, Facility, Pickup Location (pickup city, then pickup time) or Destination Location (destination city, then pickup time). |
Click the second Apply (next to Sort Option) to refresh the list with these choices.
Actions
| Button | Description |
|---|---|
| Add | Opens the Add Transportation Request wizard. A warning is shown if the appointment and return segment prefixes are not set in the page settings. |
| Client Services | Opens Client Services to look up a client's active services. |
| View Settings / Edit Settings | Opens the page settings read-only or for editing (when permitted). |
| Apply (lookup) | Loads the visits for the service date. Available before visits are loaded. |
| Clear | Clears the lookup, refinement filters and grid. Available after visits are loaded. |
| Map Selected | Plots the ticked visits on a map (see Route Map). A warning is shown if none is ticked or none has both locations geocoded. |
| Refresh | Reloads the visits for the current date and lookup. |
| Previous Day / Next Day | Moves the service date by one day and reloads. |
| Apply (refinement) | Applies the segment, filter and sort choices. |
| Cancel Selected | Cancels the ticked visits in AlayaCare after you choose a cancel code. |
| Delete Selected | Deletes the ticked visits. Shown only with the Delete permission. |
| Assign Selected To Facility | Opens Assign Facility for the ticked visits. |
| Assign Selected To Employee | Opens Assign Employee for the ticked visits. |
| Assign Selected To Facility/Employee | Opens Assign Facility and Employee for the ticked visits. |
| Edit Visit (right-click a row) | Opens the visit dialog for the right-clicked row. |
| Edit Employee (right-click a row) | Opens Edit Employee for the right-clicked row. |
| Cancel Selected, Delete Selected, Assign Selected To Facility, Assign Selected To Employee, Assign Selected To Facility/Employee (right-click a row) | Same as the buttons; they act on the ticked rows. Delete Selected is hidden without the Delete permission. |
All bulk actions need at least one ticked row ("Please select at least one visit").
Dialog Components
Add Transportation Request
Opens from Add. Work through the three tabs with Next (use Previous to go back), then click Finish. Cancel closes the wizard without saving. Once a client is chosen, Open Client In AlayaCare (Schedule) and Open Client In AlayaCare (Services) appear in the header and open the client in AlayaCare in a new browser tab.
Tabs
| Tab | Purpose |
|---|---|
| Request | Who is travelling, which trip template applies, when, and whether to create new services or reuse an existing one. |
| Locations | Pickup and destination, with calculated distance and travel time. |
| Finish | Service code, facility, employee, tags, activity codes, premiums and billing contact. |
Request — Fields
| Field | Description |
|---|---|
| Client and Load Client | Pick the client, then load their details. Choosing a different client clears the dates, times and services option. |
| Address, City | The client's home address and city (read-only). |
| Form context fields | Up to four read-only client values, labelled from the Form Context Tag settings. |
| Address directions | The client's address-directions value, when that field is configured. |
| Care provider note | The most recent note matching the Care Provider Note Subject setting (read-only). |
| Risks | The client's recorded risks, grouped as General, Allergy, Pets, Environment, Infectious Diseases and Funder (read-only). |
| Trip Segments | Appt Segment (outbound only), Return Segment (return only) or Two Way. |
| Trip Template and Search | The template that supplies the service code, facility, employee, activity codes, premiums, funder and default locations. Search opens a template search (type text, Search, select a template, Ok). Templates that failed validation are not offered. |
| Service Date | Day of the trip. |
| Appointment Time | Shown for Appt Segment and Two Way. Pre-filled from the template's default when it has one. |
| Pickup Time (optional) / Pickup Time (required) | Shown for Appt Segment and Two Way. When left blank, pickup is calculated as the appointment time minus the travel time minus 10 minutes. It cannot be after the appointment time. |
| Return Time | Shown for Return Segment and Two Way. Pre-filled from the template's default when it has one. |
| Service Instructions | Free text added to the new service's instructions. |
| Frequency Type | None for a single trip or Weekly. |
| Every N Weeks | For weekly trips: 1 or 2. |
| End Date | For weekly trips: last date of the recurrence. |
| Weekday boxes Su to Sa | For weekly trips: the days of the week the trip repeats. Choosing Weekly ticks the weekday of the service date. At least one is required. |
| Split Recurrences | Shown when more than one weekday is ticked; creates a separate recurring series for each weekday. |
| Services Option | Create New builds new AlayaCare services for the trip. Use Existing reuses a service chosen in the Prior Trips grid. |
Request — Client Services Grid
Lists the client's active services, six per page, once the client is loaded.
| Column | Description |
|---|---|
| Service Name | AlayaCare service name. |
| Service Code | Service code. |
| Service Status | Service status. |
| Start Date | Service start date. |
| End Date | Service end date. |
| Funder | Funder name. |
| Billing Contact | Billing contact of the service funder breakdown. |
Request — Prior Trips Grid
Lists the client's existing transportation services that match the Trip Segments choice (appointment services with no linked return for Appt Segment, return services with no linked appointment for Return Segment, appointment services that have a linked return for Two Way). Six rows per page. When Use Existing is chosen, exactly one row must be selected.
| Column | Description |
|---|---|
| Service Name | Service name. |
| Instructions | Service instructions (shortened). |
| Service Code | Service code. |
| Segment | Appt or Return. |
| Funder | Funder name. |
| Billing Contact | Billing contact. |
| Pickup At | Pickup location type. |
| Address (first) | Pickup address. |
| Drop-Off At | Destination location type. |
| Address (second) | Destination address. |
Request — Next
Click Next to continue. The wizard warns if any of the following is missing: client, template, service date, trip segments, a valid appointment time or return time for the chosen segments, pickup time when required, weekly details, a Services Option, or (for Use Existing) the selected service. For Two Way with Use Existing, the linked return service must be found among the client's services. For Use Existing, the pickup and destination are copied from the chosen service, distance and time are calculated automatically, and the wizard goes straight to the Locations tab.
Locations — Fields
The Starting Location (Pickup) and Destination Location (Dropoff) panels are identical. When the template has default locations they are pre-filled (for Return Segment, the template's defaults are swapped).
| Field | Description |
|---|---|
| Home / Common Location / Other | Type of location. Home uses the client's address. |
| Location and Search | For Common Location: type text and click Search to open Search Common Locations, then select a location and Ok. Only geocoded locations are offered. Add appears there for users who may add common locations. |
| Name/Location, Address, City, province/state, postal code | Editable for Other; read-only otherwise. The province/state and postal labels follow the tenant's country settings. |
| Country | Read-only. |
| Latitude, Longitude | Read-only coordinates. |
| GEO Code | For Other: looks up the coordinates from the address. |
| Calculate Distance And Time | Calculates the driving route between pickup and destination. |
| Distance (KM), Time (Minutes) | Results of the calculation (read-only). |
| Route map | Preview of the calculated route. |
Both locations must be geocoded to calculate ("Please select a geocoded pickup location" / "destination location"). Next is blocked until a distance and time have been calculated.
Finish — Fields
| Section | Description |
|---|---|
| Service Code | Service Code Selection Method (Fixed, Calculated or User Specified), Service Code Calculation Rule, and the Service Code: shown for Fixed and Calculated, chosen from a dropdown for User Specified. |
| Facility | Facility Selection Method (Fixed, Calculated, User Specified, User Specified Optional or Not Applicable), Facility Calculation Rule (Calculated), and Facility (shown, or chosen from a dropdown). Only transportation facilities are offered. |
| Employee | Employee Selection Method (Vacant when the template names none, Fixed, Calculated, User Specified, User Specified Optional), Employee Rule (Calculated) and Employee (shown, or chosen with a type-ahead). |
| Visit Tags | Visit Tags Appointment and Visit Tags Return multi-selects. Shown only when ad-hoc visit tags are allowed in the settings. |
| Activity Codes | Grid of activity codes that will go on the visits (see below). |
| Premium Codes | Grid of premium codes (see below) with a read-only Estimated Cost. |
| Funder | Shown only when the template's funder invoices individually and Create New was chosen: Billing Contact dropdown, pre-filled with the client (if a billing contact) or the first billing contact. |
Finish — Activity Codes Grid
| Column | Description |
|---|---|
| Selection Method | How the code was chosen (blank for codes added by hand). |
| Rule | Template rule, when calculated. |
| Activity Code Id | AlayaCare activity code ID. |
| Name | Activity code. |
| for Appt | Applies to the appointment visit. |
| for Return | Applies to the return visit. |
| Manage Records | Edit and delete icons. |
Finish — Activity Codes Actions
| Button | Description |
|---|---|
| Add | Opens the activity code editor. Shown only when ad-hoc activity codes are allowed in the settings. |
| Edit / Delete icons, or right-click Edit / Delete | Edit or delete a code you added. Codes that came from the template cannot be edited or deleted ("Activity codes from templates cannot be edited / deleted"). Delete asks "Are you sure you want to delete this Activity Code?". |
Finish — Premium Codes Grid
| Column | Description |
|---|---|
| Selection Method | How the premium was chosen. |
| Rule | Template rule, when calculated. |
| Premium Code Id | AlayaCare premium code ID. |
| Code | Premium code. |
| Quantity Method | Computed Distance, Computed Time or Fixed Quantity. |
| Quantity | Quantity that will be posted. |
| Rate | Cost rate. |
| for Appt / for Return | Which visits receive the premium. |
| Appt Cost / Return Cost | Estimated cost for each visit. |
| Manage Records | Edit and delete icons. |
Finish — Premium Codes Actions
| Button | Description |
|---|---|
| Add | Opens the premium code editor. It appears under the same setting as the activity-code Add button. |
| Edit / Delete icons, or right-click Edit / Delete | Same rules as activity codes; template premiums cannot be edited or deleted. |
Finish — Buttons
| Button | Description |
|---|---|
| Previous | Back one tab. |
| Next | Forward one tab. |
| Finish | Creates the transportation request (see Processing Overviews). Disabled while it runs. |
| Cancel | Closes the wizard. |
Before creating anything, Finish warns about: a two-way round trip longer than the template's maximum applicable round-trip distance; a missing employee, service code or facility; an employee who is blocked for the client (unless the Blocked Employee override is on), whose department does not match the service code's department, or who is unavailable at the appointment or return time; and premium codes that cannot be found in AlayaCare.
Search Trip Templates
Opens from Search next to Trip Template. Type text and click Search; the list shows matching templates. If only one matches it is selected automatically. Select one and click Ok ("Please select a trip template" if none).
Activity Code Editor
Opens from Add or Edit in the Activity Codes grid.
| Field | Description |
|---|---|
| Activity Code | Activity code to add. |
| Use On Appointment / Use On Return | Which visit(s) get the code. At least one must be ticked. |
Click Save or Cancel.
Premium Code Editor
Opens from Add or Edit in the Premium Codes grid.
| Field | Description |
|---|---|
| Premium Code | Premium code to add. |
| Quantity Method | Computed Distance, Computed Time or Fixed Quantity. |
| Fixed Quantity Value | Shown for Fixed Quantity. |
| Rate | Cost rate. |
| Method | Fixed Amount or Multiplied By Quantity. |
| Use On Appointment / Use On Return | Which visit(s) get the premium. At least one must be ticked. |
Click Save or Cancel.
Transportation Plan Result
Opens automatically only when something fails while creating the request. It lists the Services (Segment, Result, Message) and Visits (Segment, Result, Message) that were attempted, followed by All Errors.
Route Map
Opens from Map Selected. Each ticked visit that has valid pickup and destination coordinates becomes a route.
| Control | Description |
|---|---|
| Show Markers From / Show Markers To | Time window; stops outside the window are drawn as small dots. "To Time must be after from time" if reversed. |
| Show Route Lines | Turns the route lines on or off. |
| Clear Times | Clears the time window. |
| Update Map | Redraws the map with the time window. |
| Route list (Client) | Each route with its colour, trip info such as "(2W, Appt. 08:30)" and, when expanded, its stops (number, Start, Location with name, address and coordinates). Right-click a route and choose Show or Hide. |
| Close | Closes the map. |
Edit Employee
Opens from Edit Employee (right-click a row). Current Employee On Visit shows the present driver (or [Vacant Visit]). Choose the new employee. When the visit is an Appt segment with a linked return visit, Update Employee On Return Visit? is offered. Click Save; warnings are shown if no employee is chosen or the employee has not changed. The grid reloads afterwards.
Assign Employee, Assign Facility, Assign Facility and Employee
Open from the Assign Selected To ... buttons or right-click items. Choose an employee, a facility, or both, and click Save (or Cancel). A warning is shown if a required choice is missing. The change is applied to each ticked visit in turn and stops at the first failure. If any ticked visit is part of a recurrence, Modify Visit(s) opens next.
Modify Visit(s)
"You are modifying at least one visit that is part of a recurrence." Choose Modify only the visits selected, Modify all future visits or Modify all future unmodified visits, then Ok (or Cancel).
Delete Visit(s)
Opens when Delete Selected includes a recurring visit. Choose Delete only the visits selected, Delete all future visits or Delete all future unmodified visits, then Ok (or Cancel). When no ticked visit is recurring, you are asked "Do you want to delete the selected visits?" instead.
Cancel Code
Opens from Cancel Selected. If a ticked visit is part of a recurrence you are first asked whether to continue ("Cancelling will only cancel the selected occurrence"). Select a Select A Cancel Code value (only codes marked for transportation are listed) and click Ok ("Please select a code" if none). Each ticked visit is cancelled in AlayaCare and the grid reloads.
Visit Dialog (Edit Visit)
Opens from Edit Visit (right-click a row). The header shows Visit ID and these buttons:
| Button | Description |
|---|---|
| Cancel | Opens Cancel Booking (Client Visit Cancel permission). |
| Copy Visit | Opens Copy Booking (Client Visit Copy permission). |
| Edit Visit | Opens Edit Visit ID (see above for the permissions). |
Cancel, Edit Visit and the editing actions are hidden when facility-scheduling rules lock the visit (approved visits, or visits that started more than 24 hours ago, when those rules are on). The body shows (read-only) a note for recurring visits, Current Employee, Current Client with View Client in AlayaCare (Client Visit View In AlayaCare permission), Service, Service Code, Current Facility, Start At, End At, Service Instructions, a Tags grid and a Forms grid. Each form shows its name, last submitted date (or "Not submitted yet"), "Required" when required, and View Definition and Fill In buttons that open AlayaCare in a new tab. Click Close to leave.
Edit Visit ID
| Field | Description |
|---|---|
| Current Employee and Edit Employee | Employee on the visit. Edit Employee needs Client Visit Edit Employee. It opens Edit Employee, where you pick Vacant Employee (when vacant visits are allowed), Find Employee (type-ahead or Employee Lookup with Search) or Select A Scheduled Facility Employee, then Save. The change is held until you save the visit. |
| Service Code | Editable dropdown (service codes in the same department) with Client Visit Edit Service Code; otherwise read-only. |
| Current Facility and Edit Facility | Edit Facility (Client Visit Move) opens Change Facility, where you choose a facility, then Save. The change is held until you save the visit. |
| Move To New Date/Time | New start date and time (5-minute steps). |
| Duration (Minutes) | Visit length; End Time is calculated (read-only). |
| Service Instructions | Editable with Client Visit Edit Service Instructions. |
| Tags | Visit tags. |
| Other Forms / Required Forms | Forms attached to the visit as optional or required. |
| Save / Close | Save writes the visit to AlayaCare. If the visit is recurring you first choose to change only this visit, all future visits or all future unmodified visits. Close asks "Changes Exist. Do you want to close without saving?" when you have made changes. |
Cancel Booking
Shows the client, service code, from and to times, and a Select A Cancel Code drop-down. Click Save to cancel the visit in AlayaCare ("Please select a valid Cancel Code" if none), or Cancel.
Copy Booking
Creates copies of the visit. Each row has a Date/Time, Clinic and Chair (a trash icon removes a row; at least one is required). Add Another Date adds a row. Click Save: each copy keeps the same employee, client, service, service code and length. The message reports how many visits were created or failed.
Client Services
Opens from Client Services. Choose a Client and click Apply (the button becomes Refresh, and Clear appears so another client can be chosen). "No active services found for this client." is shown when there are none.
Grid
| Column | Description |
|---|---|
| (tick box) | Select services to discharge. |
| Service Name | Service name. |
| Start Date | Service start date. |
| Service Code | Service code. |
| Service Status | Service status. |
| End Date | Service end date. |
| Funder | Funder name. |
| Billing Contact | Billing contact. |
| Pickup | Pickup location text saved on the service. |
| Destination | Destination location text saved on the service. |
| Custom Instructions | The free text recorded when the trip was created. |
Filters and Actions
| Control | Description |
|---|---|
| Transportation Services | Tick to show only services that belong to a transportation trip. |
| Discharge Selected | Enabled when services are ticked. Opens Discharge Selected Services: choose a Status Reason (reasons for discharge) and click Discharge. Each ticked service is discharged in AlayaCare as of now and the list reloads. |
| Close | Closes the dialog. |
Dependencies
The following tables must be configured for lookups on this view to work:
| Table | Description |
|---|---|
| Activity Codes | Activity codes offered when adding one by hand and used to find calculated codes. |
| Cancel Codes | Cancel codes shown when cancelling visits (transportation codes for Cancel Selected, facility-scheduling codes in the visit dialog). |
| Common Locations | Pickup and destination locations, and office locations used when a template includes an office stop. |
| Facilities | Transportation facilities offered on the Finish tab, and facilities for Change Facility and Copy Booking. |
| Form Context Fields | Descriptions for the optional client fields on the Request tab. |
| Forms | Forms that can be attached to a visit. |
| Funders | Funder details (invoicing model) for the template's funder. |
| Groups | Client groups of type Transportation offered in Filter Groups. |
| Premium Codes | Premium codes offered when adding one by hand and used to find calculated premiums. |
| Service Codes | Transportation service codes used to choose visits and to select a service code. |
| Status Reasons | Discharge reasons offered in Client Services. |
| Tags | Visit tags. |
| Trip Service Code Rules | Rules used when a template calculates the service code. |
| Trip Templates | Templates (service code, facility, employee, funder, locations, activity codes and premiums). |
Processing Overviews
This section describes what happens after you confirm a processing action.
Apply / Refresh / Previous Day / Next Day
- Requires a service date, and an employee when Specified is chosen.
- Loads the day's visits from AlayaCare (midnight to 23:59 in the tenant time zone), limited by any employee, client and group choice. Vacant loads visits assigned to the vacant employee.
- Drops cancelled visits, visits with no client, and visits whose service code is not a transportation service code.
- For each remaining visit, loads the visit details, premiums, client service, client and employee, and reads the trip information stored on the service (segment, linked return service, pickup, destination, distance).
- Keeps visits that have a segment or a transportation service type, fills the grid and the filter lists, and links each appointment to its return time.
Calculate Distance And Time
- Requires geocoded pickup and destination.
- When the template calls for it, adds the nearest office location before the pickup.
- Asks the mapping provider for a driving route using the routing settings.
- Stores the distance (km) and travel time (minutes) and draws the route.
Finish (Add Transportation Request)
- Checks the template's round-trip limit and the employee, service code, facility and premium choices (see above).
- Saves a request log in the integration database.
- For Create New, creates the appointment service and, for Two Way, the return service in AlayaCare (named with the segment prefix, the pickup and destination and the funder, with the trip details saved on the service), and links the two. For Use Existing, uses the chosen service(s).
- Works out the visit times. Appointment visit: from the pickup time (or the appointment time minus the travel time and 10 minutes) to the appointment time. Return visit: from the return time to the return time plus the travel time and 10 minutes.
- Creates the visit(s) in AlayaCare with the service instructions, tags, activity codes and the Update Visit Overrides. A weekly recurrence creates a repeating series to the end date (one series per weekday when Split Recurrences is on).
- Adds the premiums, either to each new visit or to the recurring series.
- Saves the created visit, premium and activity code details in the request log.
- On success, closes the wizard and shows "Transportation Request(s) Successfully Added"; the grid reloads if the request is for the date on screen. On failure, shows Transportation Plan Result.
Assign Selected / Edit Employee
- Signs in to AlayaCare.
- For each visit, updates the employee and/or facility; for recurring visits updates the series according to your Modify Visit(s) choice.
- Stops at the first failure with a warning, then reloads the grid on success.
Cancel Selected
- Signs in to AlayaCare and requests a cancel token for each visit.
- Cancels each visit with the chosen cancel code and writes an action-log entry.
- Reloads the grid.
Delete Selected
- Signs in to AlayaCare.
- A single visit (or a recurring visit with Delete only the visits selected) is deleted. For a recurring visit with all future or all future unmodified, the future visits are cleared or reset, the recurrence rule is deleted, and an action-log entry is written.
- Reloads the grid.
Discharge Selected (Client Services)
- Requires a Status Reason and at least one ticked service.
- Sets each ticked service to discharged in AlayaCare with the current date and the chosen reason.
- Reloads the client's services.