ACI Documentation

Premium Codes

Executive Summary

Premium Codes lists the client billing premium codes held in AlayaCare and lets administrators set how each one is used by the integration. For each premium code an administrator can set the service type (Meals On Wheels or Transportation), the client billing premium department, and, for Meals On Wheels, the meal type, meal supplier, print values, and delivery quantity rules used on route sheets and labels. A separate OHRS tab holds the multipliers, statistical account codes, and override segment values used for OHRS reporting. The premium codes themselves come from AlayaCare and are brought in with Refresh from AlayaCare.

Key Features

  • Refresh the list of premium codes from AlayaCare (new codes are added and changed code names are updated)
  • Filter by code and service type
  • Set the service type and client billing premium department for a premium code
  • For Meals On Wheels codes, set the route sheet delivery quantity, meal type, meal supplier, print value, print value for labels, quantity multiplier, and whether the print value appears on labels
  • Set OHRS multipliers, OHRS statistical account codes (client and worker perspective), and OHRS override segment values
  • Export the displayed premium codes to Excel

Typical Workflow

  1. Click Refresh from AlayaCare to bring in new premium codes.
  2. Filter the list if needed and click Apply Filter.
  3. Click the edit icon on a row (or right-click the row and choose Edit).
  4. On the General tab click Edit, choose the Service Type and Client Billing Premium Department, fill in the Meals On Wheels fields when applicable, and click Save.
  5. On the OHRS tab click Edit, set the multiplier, statistical accounts, and overrides, and click Save.
  6. Click Close to leave the dialog, or Export to save the list to Excel.

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

AttributeWhat It Controls
ViewOpen the page

Main Grid

The grid lists the premium codes, 14 rows per page. The first three columns stay in place when scrolling sideways.

ColumnDescription
AC IDThe premium code's AlayaCare ID.
CodePremium code name from AlayaCare.
DepartmentClient billing premium department chosen for the code.
Service TypeMeals On Wheels or Transportation (blank when not set).
Meal TypeFrozen or Hot (Meals On Wheels only).
Print ValueValue printed for the premium on Meals On Wheels documents.
Meal SupplierMeal supplier code (Meals On Wheels only).
Manage RecordsEdit icon for the row.

Main Grid Filters

FilterPurpose
Filter CodeShow premium codes whose code contains the text.
Filter Service TypesMulti-select list of service types. The blank entry finds codes with no service type.

Click Apply Filter to refresh the list. Use Clear Filter to reset the filters and reload the list.

Actions

ButtonDescription
Refresh from AlayaCareReads the premium codes from AlayaCare and adds or updates them here. See Processing Overviews.
ExportSaves the displayed premium codes to Excel (columns AC Id, Code, Department, Service Type, Meal Type, Print Value, Meal Supplier). If the list is empty, "Nothing to export" is shown.
Apply Filter / Clear FilterApply or reset the filters.
Edit icon (row)Opens the Premium Code dialog.
Edit (right-click a row)Same as the edit icon.

Dialog Components

Premium Code

Opens from the edit icon or right-click Edit. The premium Code is shown at the top. Click Close to leave.

Tabs

TabPurpose
GeneralService type, department, and Meals On Wheels settings.
OHRSOHRS multiplier, statistical accounts, and overrides.
General

Shows the current values (read-only). Click Edit to open the edit dialog (titled with the premium code):

FieldDescription
CodePremium code (cannot be changed).
Service TypeBlank, Meals On Wheels, or Transportation.
Client Billing Premium DepartmentDepartment the premium bills under.
Route Sheet Delivery QuantityMeals On Wheels only. Scheduled Quantity or Scheduled Quantity With Multiplier.
Meal TypeMeals On Wheels only. Frozen or Hot.
Meal SupplierMeals On Wheels only. Choose from the meal suppliers.
Print ValueMeals On Wheels only. Text printed for the premium.
Print Value for LabelsMeals On Wheels only. Text printed on labels.
Quantity MultiplierMeals On Wheels only. Whole number, minimum 1.
Include Print Value on LabelsMeals On Wheels only. Print the value on labels.

Click Save to store or Cancel. When the service type is not Meals On Wheels, the quantity multiplier, print values, and label option are cleared on save. If the update fails, "Update Failed" is shown.

OHRS

Shows the current values (read-only). Click Edit to open the OHRS dialog:

FieldDescription
Scheduled Units MultiplierDecimal multiplier applied to scheduled units for OHRS reporting.
OHRS SA Codes - Client Perspective: UnitsOHRS statistical account for units from the client perspective. Searchable by code or description.
OHRS SA Codes - Worker Perspective: UnitsOHRS statistical account for units from the worker perspective. Searchable by code or description.
OHRS Override SA Mapping - Client Perspective: Level 1 to Level 6 (Premium Quantity)Override segment values. Level 1 allows 1 character; levels 2 to 6 allow 2 characters.
OHRS Override SA Mapping - Worker Perspective: Level 1 to Level 6 (Scheduled Units)Override segment values with the same length limits.

Click Save to store or Cancel.

Dependencies

The following tables must be configured for lookups on this view to work:

TableDescription
DepartmentsClient billing premium departments, and the department name shown in the grid.
Meal SuppliersMeal suppliers offered for Meals On Wheels codes.
OHRS Statistical AccountsAccounts offered for the OHRS statistical account fields.

Processing Overviews

This section describes what happens after you confirm a processing action.

Refresh from AlayaCare

  1. A "Refresh Premium Codes" progress panel opens.
  2. The system signs in to AlayaCare. If sign-in fails, the refresh stops without a message.
  3. It reads all premium codes from AlayaCare.
  4. For each code, in turn: a code not yet known is added with its AlayaCare ID and name; a known code whose name changed is renamed. Service type, department, and the other settings are never changed by the refresh.
  5. The list is reloaded.