Travel Premium Rules
Executive Summary
Travel Premium Rules is the setup screen where administrators define the rules used to calculate travel premiums for employees. A rule says how travel time is valued, whether travel to the first visit, between middle visits, from the last visit and back home qualifies, where travel is measured from (the employee's address or the nearest office location), the distance that must be exceeded, and which AlayaCare premium codes are used for travel distance and travel time. Each rule also lists the service codes it applies to, with the visit statuses and cancel reasons that qualify. A rule and its service codes can be exported to Excel.
Key Features
- Review the list of travel premium rules
- Add a new rule with travel time, first visit, middle visit, last visit and return allowance settings
- Open a rule to review its settings and change them
- Choose the AlayaCare premium code used for each travel distance and travel time premium
- Assign service codes to a rule, with the visit statuses and cancel reason codes that qualify
- Filter a rule's service codes by name
- Export a rule and its service codes to Excel
- Delete a rule or a service code from a rule
Typical Workflow
- Click Add, enter a File As name and the travel settings, and click Save.
- Click the edit icon on the rule (or right-click it and choose Edit) to open it.
- On the Service Codes tab, click Add to assign each service code the rule applies to, tick the visit statuses that qualify, optionally choose cancel codes, and click Save.
- On the General tab, click Edit to change the rule's settings.
- Click Export for a spreadsheet copy, or the back arrow to return to the list.
Available Permissions
The following permissions are available to be assigned to AlayaCare Roles:
| Attribute | What It Controls |
|---|---|
| View | Open the page and use all of its actions, including adding, editing and deleting rules |
Main Grid
The grid lists the travel premium rules (14 rows per page).
| Column | Description |
|---|---|
| File As | Name of the rule. |
| Manage Records | Edit and delete icons. |
Actions
| Button | Description |
|---|---|
| Add | Opens the Travel Premium Rule dialog to create a rule. Also available on the right-click menu. |
| Edit (row icon, or right-click a row) | Opens the rule's detail page. |
| Delete (row icon, or right-click a row) | After you confirm "Are you sure you want to delete this rule?", deletes the rule and shows "Rule Deleted". "Error deleting Rule" is shown if it cannot be deleted. |
Dialog Components
Travel Premium Rule (Add)
Opens from Add. File As is required ("Please enter a File As" is shown otherwise). Click Save to create the rule, or Cancel. The same fields are used when editing a rule from its detail page.
| Field | Purpose |
|---|---|
| File As | Name of the rule. |
| Value Determination (Travel Time) | Calculated or Fixed Amount. |
| Time per Visit (fractions of Hours) | Travel time allowed per visit, in hours. |
| Maximum Daily Limit (in Hours) | Most travel time that can be paid in a day. |
| Include Travel To First Visit | Pays travel to the first visit of the day. |
| Location To Use (First Visit) | Employee Address or Nearest Office Location. |
| Type (First Visit) | Type of office location to use. Shown when the location is Nearest Office Location. |
| Threshold Distance (First Visit) | Distance that must be exceeded before a premium applies. |
| Travel Distance Premium Code (First Visit) | Premium code for the distance. |
| Travel Time Premium Code (First Visit) | Premium code for the time. |
| Include Travel On Middle Visit | Pays travel between visits during the day. |
| Threshold Distance (Middle Visit) | Distance that must be exceeded. |
| Travel Distance Premium Code (Middle Visit) | Premium code for the distance. |
| Travel Time Premium Code (Middle Visit) | Premium code for the time. |
| Include Travel From Last Visit | Pays travel from the last visit of the day. |
| Location To Use (Last Visit) | Employee Address or Nearest Office Location. |
| Type (Last Visit) | Type of office location to use. |
| Threshold Distance (Last Visit) | Distance that must be exceeded. |
| Travel Distance Premium Code (Last Visit) | Premium code for the distance. |
| Travel Time Premium Code (Last Visit) | Premium code for the time. |
| Include Return Allowance | Pays a return allowance. |
| Location To Use (Return Allowance) | Employee Address or Nearest Office Location. |
| Type (Return Allowance) | Type of office location to use. Shown when the location is Nearest Office Location. |
| Qualifying Time Between Visits (Mins) | Minimum gap between visits for the allowance to qualify. |
| Return Allowance From Visit Premium | Premium code for the return allowance from the visit. |
| Return Allowance To Visit Premium | Premium code for the return allowance to the visit. |
Travel Premium Rule (Detail Page)
Opens from the edit icon or Edit on the right-click menu. The page shows the rule's File As and an Export button. Use the back arrow next to the heading to return to the list.
Tabs
| Tab | Purpose |
|---|---|
| Service Codes | The service codes the rule applies to. |
| General | The rule's settings, read-only, with an Edit button. |
Service Codes — Grid
| Column | Description |
|---|---|
| AC ID | AlayaCare ID of the service code. |
| Service Code Name | Service code name. |
| Service Code Description | Service code description. |
| Scheduled | Checked when scheduled visits qualify. |
| Completed | Checked when completed visits qualify. |
| Approved | Checked when approved visits qualify. |
| On Hold | Checked when visits on hold qualify. |
| Cancelled | Checked when cancelled visits qualify. |
| Cancel Reason Codes | AlayaCare IDs of the cancel codes that qualify. |
| Manage Records | Edit and delete icons. |
Service Codes — Grid Filters
| Filter | Purpose |
|---|---|
| Filter Service Code | Shows service codes whose name contains the text entered (not case-sensitive). |
Click Apply Filter to refresh the list. Use Clear Filter to reset.
Service Codes — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Service Code dialog to add a service code to the rule. Also on the right-click menu. |
| Edit (row icon, or right-click a row) | Opens the Service Code dialog for that row. |
| Delete (row icon, or right-click a row) | After you confirm "Are you sure you want to delete this service code?", removes the service code from the rule. |
General Tab
Shows the settings listed above for the Add dialog, read-only, in the groups First Visit, Middle Visit, Last Visit and Return Allowance. Premium codes are shown as the code with its AlayaCare ID. Click Edit to open the rule for editing (same fields as the Add dialog, plus the Travel Time group). Save stores the changes and Cancel closes without saving.
Service Code
Opens from Add or Edit on the Service Codes tab. Click Save to store, or Cancel.
| Field | Purpose |
|---|---|
| Select A Service Code | The service code, listed as AlayaCare ID and name. |
| Scheduled | Scheduled visits qualify. |
| Completed | Completed visits qualify. |
| Approved | Approved visits qualify. |
| Cancelled | Cancelled visits qualify. |
| On Hold | Visits on hold qualify. |
| Cancel Codes | One or more cancel codes that qualify when cancelled visits are included (with Select All). |
Dependencies
The following tables must be configured for lookups on this view to work:
| Table | Description |
|---|---|
| CancelCodes | Cancel codes that can be chosen for a service code on a rule. |
| CommonLocationTypes | Office location types offered when the location to use is Nearest Office Location. |
| PremiumCodes | Premium codes offered for the travel distance, travel time and return allowance premiums. |
| ServiceCodes | Service codes that can be assigned to a rule. |
Processing Overviews
This section describes what happens after you confirm a processing action.
Export
- Builds a workbook with two sheets. The first, ActivityCodeRules, lists the rule's settings as label and value pairs (File As, the include options, locations, threshold distances and premium AlayaCare IDs for first, middle and last visits, and the return allowance settings).
- The second sheet, Service Codes, lists each service code on the rule with AC ID, Service Code Name, Service Code Description, Scheduled, Completed, Approved, Cancelled and Cancel Reason Codes.
- Downloads the file, named TravelPremiumRules_{date and time}.xlsx, and shows "Exported Successfully".