Trip Templates
Executive Summary
Trip Templates is the setup catalog that Transportation Planner uses when it creates client trips. Each template describes one kind of trip, identified by a resource type, request type and request sub-type, and says how the trip is billed (a single source or a single program), how the service code, facility and employee are chosen (fixed, calculated by a rule, supplied by the user, and so on), which default pickup and destination locations and times apply, which service-instruction prefixes are used, and which activity codes and premium codes are attached. Administrators add templates one at a time or load many at once from an Excel workbook, review the Validation Status of each template on the main list, and open a template to change its details or maintain its activity codes and premium codes. Several of the values refer to AlayaCare funders, service codes, facilities, employees, activity codes and premium codes.
Key Features
- Filter the list by description and validation status
- Add a template with its billing, service code, facility, employee, location and instruction settings
- Import templates in bulk from an Excel workbook, replacing any template with the same name
- See which templates passed or failed validation and why
- Open a template to change its general details
- Attach activity codes and premium codes to a template, each either fixed or calculated by a rule
- Search common locations for the default pickup and destination
- Delete templates
Typical Workflow
- Use the filters at the top and click Apply Filter to find existing templates.
- Click Add to create a template, or click Import Templates, choose the Excel file and click Process to load many templates.
- Check Validation Status and Validation Message on the list for any template that Failed.
- Open a template with the edit icon (or right-click and choose Edit).
- On General, click Edit to change the template. On Activity Codes and Premium Codes, click Add to attach codes.
- Click Close 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 add, import, edit and delete trip templates |
Main Grid
Lists the trip templates (14 rows per page). The first three columns stay in place when you scroll sideways.
| Column | Description |
|---|---|
| ID | Template number. |
| Description | Template description. For templates added or edited on screen this is built from the resource type, request type, request sub-type and funder; for imported templates it is the name from the workbook. |
| Service Code Selection Method | Calculated, Fixed or User Specified. |
| Service Code | The fixed AlayaCare service code, when the method is Fixed. |
| Service Code Rule | The rule used when the method is Calculated. |
| Facility Selection Method | Calculated, Fixed, User Specified, Not Applicable or User Specified Optional. |
| Facility | The fixed facility, when the method is Fixed. |
| Facility Rule | The rule used when the method is Calculated. |
| Employee Selection Method | Calculated, Fixed, User Specified, Vacant or User Specified Optional. |
| Employee Name | The fixed employee, when the method is Fixed. |
| Employee Rule | The rule used when the method is Calculated. |
| Row | The row of the workbook the template was imported from. |
| Validation Status | Passed or Failed, set when the template is imported. |
| Validation Message | The reason a template failed. |
| Manage Records | Delete and Edit icons. |
Main Grid Filters
| Filter | Purpose |
|---|---|
| Filter Description | Limits the list to templates whose description contains the text (not case-sensitive). |
| Filter Status | Limits the list to All, Passed or Failed templates. |
Click Apply Filter to refresh the list. Use Clear Filter to reset filters and reload all templates.
Actions
| Button | Description |
|---|---|
| Apply Filter | Applies the description and status filters. |
| Clear Filter | Clears the filters and reloads the list. |
| Add | Opens the Trip Template dialog to add a template. |
| Import Templates | Opens the Import Templates dialog. |
| Edit icon (Manage Records) | Opens the template. |
| Delete icon (Manage Records) | Deletes the template after confirmation ("Are you sure you want to delete this Trip Template?"). |
| Edit (right-click a row) | Opens the template. |
| Delete (right-click a row) | Deletes the template after confirmation. |
Dialog Components
Trip Template (add a template)
Opens from Add. Choose the options below and click Save; use Cancel to close without saving. A warning is shown naming the first missing item. Activity codes and premium codes are added afterwards by opening the template.
| Field | Purpose |
|---|---|
| Billable Using | Single Source or Single Program. Required. |
| Funder Methodology | Shown for Single Program. The only choice is Single Payor. |
| Funder | Shown for Single Source, and for Single Program with Single Payor. Required. |
| Billing Frequency | Shown for Single Program with Single Payor: 1 Week, 2 Weeks, 4 Weeks or Calendar Month. Required. |
| Resource Type | Required. |
| Request Type | Required. |
| Request Sub-Type | Required. |
| Maximum Applicable Round Trip Distance | Distance limit for applying the template. |
| Service Code Selection Method | Calculated (pick a Service Code Rule), Fixed (pick a Service Code) or User Specified. Required. |
| Facility Selection Method | Calculated (pick a Facility Rule), Fixed (pick a Facility), User Specified, Not Applicable or User Specified Optional. Required. |
| Employee Selection Method | Calculated (pick an Employee Rule), Fixed (search for an Employee), User Specified, Vacant or User Specified Optional. Required. |
| Include Default Pickup | When ticked, choose the Default Pickup Location as Home, Common Location or Other. For Common Location, type a Location, click Search, and optionally set the Default Appointment Time. |
| Include Default Destination | When ticked, choose the Default Destination Location as Home, Common Location or Other. For Common Location, type a Location, click Search, and optionally set the Default Return Time. |
| Appt Segment / Return Segment | Service Instruction Prefix Overrides for the appointment and return legs of a trip. |
When a selection method is changed, the values that belong to the other methods are cleared.
Search Common Locations
Opens from Search next to a default pickup or destination location. Type text and click Search to list matching common locations (name, number and address), click the one to use, and click Ok. A warning "Please select a location" is shown if none is chosen. When only one location matches, it is selected automatically. Users who are allowed to add common locations also see an Add button here that opens the common location entry dialog.
Import Templates
Opens from Import Templates.
| Button | Purpose |
|---|---|
| Excel file to process | Choose the workbook (.xlsx or .xls). |
| Process | Starts the import. |
| Clear | Removes the chosen file. |
| Close | Closes the dialog. |
Workbook layout
The first sheet must be named Version and cell B4 must contain 6.04.1019 (version 5.01.1010 is recognised but is no longer accepted: "Version 6.04.1019 is expected"). The second sheet must be named TripTemplates. It must have 69 columns (A to BQ), a first row of column headings exactly as below, and a second row that is a description. Data starts on row 3. Headings marked * are required.
| Columns | Headings |
|---|---|
| A to D | Name*, ResourceType*, RequestType*, RequestSubType* |
| E to I | BillableUsing*, Funder, FundingMethodology, BillingFrequency, MaxRoundTripDistance |
| J to L | ServiceCodeSelectionMethod*, ServiceCodeRule, AlayaCareServiceCode |
| M to U | ActivityCodeSelectionMethod1, ActivityCodeRule1, AlayaCareActivityName1, and the same three headings numbered 2 and 3 |
| V to AC | PremiumCodeSelectionMethod1, PremiumCodeRule1, AlayaCarePremiumCode1, PremiumQuantityMethod1, PremiumFixedQuantity1, PremiumCostCalcRate1, PremiumCostCalcMethod1, PremiumExcludeFromReturn1 |
| AD to AK | The same eight premium headings numbered 2 |
| AL to AS | The same eight premium headings numbered 3 |
| AT to BA | The same eight premium headings numbered 4 |
| BB to BD | FacilityCodeSelectionMethod, FacilityCodeRule, AlayaCareFacilityCode |
| BE to BH | IncludeDefaultPickup, DefaultPUPLocationType, DefaultPUPLocationID, DefaultPUPSegmentApptTime |
| BI to BL | IncludeDefaultDestination, DefaultDestLocationType, DefaultDestLocationID, DefaultDestSegmentReturnTime |
| BM to BO | EmployeeSelectionMethod, EmployeeRule, EmployeeUID |
| BP to BQ | ApptSegmentServiceInstructionsPrefix, ReturnSegmentServiceInstructionsPrefix |
Trip Template (template detail dialog)
Opens from the edit icon or right-click Edit. Close it with Close.
Tabs
| Tab | Purpose |
|---|---|
| General | Read-only view of the template, with an Edit button. |
| Activity Codes | The activity codes attached to the template. |
| Premium Codes | The premium codes attached to the template. |
General
Shows Resource Type, Request Type, Description, Billable Using, Funder Methodology and Billing Frequency (for Single Program), Funder, Maximum Applicable Round Trip Distance, the three selection methods with their rule, service code, facility or employee, the default pickup and destination settings, and the Appt Segment and Return Segment prefixes. Click Edit to open the edit dialog.
The edit dialog has the same fields as the Trip Template add dialog, with these differences: the Fixed service code choices are limited to service codes that belong to the selected funder, and the description is rebuilt from the resource type, request type, request sub-type and funder when you click Save. Existing values are pre-filled. Cancel closes it without saving.
Activity Codes — Grid
| Column | Description |
|---|---|
| AC ID | AlayaCare activity code ID. |
| Activity Code | Activity code name. |
| Selection Method | Calculated or Fixed. |
| Rules | The rule used when the method is Calculated. |
| Validation Status | Passed or Failed. |
| Validation Message | The reason a code failed. |
| Manage Records | Delete and Edit icons. |
Activity Codes — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Activity Code dialog. |
| Edit (icon or right-click) | Opens the Activity Code dialog for the row. |
| Delete (icon or right-click) | Deletes the activity code after confirmation. |
Premium Codes — Grid
| Column | Description |
|---|---|
| AC ID | AlayaCare premium code ID. |
| Code | Premium code. |
| Selection Method | Calculated or Fixed. |
| Rules | The rule used when the method is Calculated. |
| Quantity Method | How the quantity is determined. |
| Fixed Quantity | The quantity when the method is Fixed Quantity. |
| Cost Calc Method | How the cost is calculated. |
| Cost Rate | The rate used in the cost calculation. |
| Validation Status | Passed or Failed. |
| Validation Message | The reason a code failed. |
| Exclude on Return | Whether the premium is left off the return leg of a two-way trip. |
| Manage Records | Delete and Edit icons. |
Premium Codes — Grid Actions
| Button | Description |
|---|---|
| Add | Opens the Premium Code dialog. |
| Edit (icon or right-click) | Opens the Premium Code dialog for the row. |
| Delete (icon or right-click) | Deletes the premium code after confirmation. |
Activity Code
Opens from Add or Edit on the Activity Codes tab. Choose Calculated (pick an Activity Code Rule) or Fixed (pick an Activity Code) and click Save. A warning is shown if the rule or code is missing.
Premium Code
Opens from Add or Edit on the Premium Codes tab.
| Field | Purpose |
|---|---|
| Exlude From The Return Segment of a Two-Way Trip | Tick to leave this premium off the return leg. |
| Premium Code Selection Method | Calculated (pick a Premium Code Rule) or Fixed (pick a Premium Code). |
| Quantity Method | Shown unless the method is Calculated: Computed Distance, Computed Time or Fixed Quantity. Required for Fixed codes. |
| Fixed Quantity Value | Shown for Fixed Quantity. Must be greater than zero. |
| Rate | Rate for the cost calculation. |
| Method | Fixed Amount or Multiplied By Quantity. |
Dependencies
The following tables must be configured for lookups on this view to work:
| Table | Description |
|---|---|
| Activity Codes | Fixed activity codes on a template. |
| Common Location Types | Types offered when adding a common location from the location search. |
| Common Locations | Default pickup and destination locations. |
| Employees | Used to look up a fixed employee when templates are imported. |
| Facilities | Fixed facility on a template. |
| Funders | Funders offered for a template. |
| Premium Codes | Fixed premium codes on a template. |
| Service Codes | Fixed service codes on a template. |
| Trip Activity Code Rules | Rules for calculated activity codes. |
| Trip Employee Rules | Rules for calculated employee selection. |
| Trip Facility Rules | Rules for calculated facility selection. |
| Trip Premium Code Rules | Rules for calculated premium codes. |
| Trip Service Code Rules | Rules for calculated service code selection. |
Processing Overviews
This section describes what happens after you confirm a processing action.
Process (Import Templates)
- Checks that the workbook has a Version sheet with 6.04.1019 in cell B4, a second sheet named TripTemplates, the right number of columns and the exact column headings. If any check fails, a warning explains what is wrong and nothing is imported.
- Reads each data row from row 3. Rows with no Name are skipped.
- If a template with the same name already exists, it is deleted and replaced by the imported one.
- Creates the template from the row and marks it Passed, then checks the row. A template is marked Failed, with a message, when:
- for Single Source, the funder is missing or not found in Funders;
- for Single Program, the funding methodology is missing, or for Single Payor the billing frequency is not 1 Week, 2 Weeks, 4 Weeks or Calendar Month;
- a Calculated employee, service code or facility rule is not found;
- a Fixed employee is not found, a Fixed service code is missing or not found, or a Fixed facility is not found;
- a premium cost method is not Fixed Amount or Multiplied By Quantity while a rate is given (or a rate of zero is given with a method), or a Fixed quantity is zero or less. Only the last problem found for a template is kept as its message.
- Looks up the default pickup and destination common locations by the numbers in the workbook, and copies the default times and service-instruction prefixes.
- Adds up to three activity-code lines and up to four premium-code lines from the row. Each line is marked Failed when its fixed code or rule is not found.
- A row that cannot be read shows "Invalid Data in row n". When all rows are done, "Import Finished" is shown and the list is reloaded.