OpenHMIS Cashier Module

Overview

The OpenHMIS Cashier Module provides a basic interface for bill creation and management.  The module aims to be simple and optimized for easy keyboard entry.  As of version 3.3, features include:

• Bill management

• Configurable payment modes (e.g. cash, credit card)

• Multiple payments per bill

• Bill adjustments

• Configurable receipt number generator

• Basic time/shift tracking for cashiers

• Cash point management

• Cashier Reports Page

• OpenMRS 2 support for all the Cashier Pages

Requirements

Cashier module dependencies for the 3.x release are as follows:

• Java 1.7

• OpenMRS 1.9.9+

• REST Web Services Module 2.1x

• Jasper Reports Module 1.5.7

• OpenHMIS Commons Module 3.x

• OpenHMIS Backbone Forms Module 2.x

• OpenHMIS Inventory Module 2.x

Download

• Module: https://addons.openmrs.org/#/show/org.openmrs.module.openhmis-cashier

• Source code: https://github.com/OpenHMIS/openmrs-module-openhmis.cashier

Version History

Module Deployment

The Cashier Module is deployed into OpenMRS the same way as all other modules

https://openmrs.atlassian.net/wiki/display/docs/Administering+Modules

Configuration - Getting Started

REST Web Services

The REST Web Services module must first be configured if this has not already been done.  

1. On the OpenMRS Administration page, click on the REST Web Services - Settings link.  

2. Update the Rest Web Services URI Prefix setting according to your OpenMRS server URI.  For example, if clients connect to the server with the following URI 'http://192.168.1.100:8080/openmrs' then the prefix should be '/openmrs'. For example see the screenshot below:

Open

Cashier Settings

• All the settings for the Cashier Module are done from the Manage Cashier Module Page located in the Cashier Module Dashboard:

Open

Cashier Dash Board

• Click on the Manage Cashier Module Above to see the list of Cashier Management Pages. The Cashier Settings page is highlighted below:

Open

• Once you click on Cashier Settings, you will see a number of options such allowing adjustments, defining rounding and rounding mode and so on:

Open

Cashier Settings

Cashier Settings Options

• Bill Adjustment: Provides an option for the cashier to edit a bill once it has been processed. Bill adjustment is useful in instances where the cashier was to give a refund.

  • There are 2 available True of False settings for Bill Adjustment:  Allow Bill Adjustment and Require Adjustment Reason.

• Autofill Payment Amount: When set to True, this option populates the Amount in the Payments Section of the Cashier Bill with the Total Amount due from the selected Line Items.

•  Timesheet: True or false setting for Cashier Time tracking. Together with the Shift Reports, this enables tracking of the cashier's logins and amount of money collected during any of the time sheets.

  • The cashier setting for enabling the timesheet is Require Timesheet while the available Time sheet reports are: Timesheet Shift Report ID, Daily Shift Summary Report ID and Shift Summary Report ID.  

• Cashier Bill Rounding: This is an important setting defining how Inventory Item Price will be rounded off in the Cashier Bill. This may be useful in situations where giving out change in very small currency denominations is difficult.

  • Round To Nearest setting defines by how many units the price is to be rounded of. The input accepts floating type numbers as well as Integers. 

  • Rounding Mode There are 4 options for this setting, Blank(meaning NO Rounding), Floor, Mid and Ceiling. This options can be seen below:

• Number of Bills on the Patient Dashboard: On OpenMRS 2.x, it is possible to view the last X number of Patient's Bills on the Patient Dashboard. The Bills are displayed in descending order that is from the Patient's Last Bill downwards. Patient Dashboard Number of Bills To Display defines how many bills to display. For example:

Open

• Defining Other Reports: There are 3 other reports that can be defined in the Settings Page that is Default Receipt Report ID, Department Collections Report ID and Department Revenue Report ID.

  • Default Receipt Report ID: Jasper Report used to Generate Receipts on the Bill Page

Open

Open

Open

NOTE:The Above Reports need to be first added to the Jasper Reports Module as explained in the Reports Administration section.

The above Settings can also be configured from the Cashier Global Options as explained below. This is especially useful incase once is using OpenMRS platform 1.9.x and can be seen in the screenshot below:

Open

Cashier Global Options

Most of the configuration for the Cashier Module is done through global options which can be accessed via the Administration / Settings page (Screenshot Above).  For detailed instructions on configuring Global Options click here

Configuring Cashier Bill Rounding

• If you are using the OpenMRS 2.x Navigate to the Cashier settings page as described above otherwise you can also navigate to the Administration / Settings page described above.

• From the Cashier Settings Page Set the Round to Nearest value e.g 5 which means round to the nearest 5 units

• Next select the Rounding Mode e.g CEILING which means always round up

Creating Rounding Department and Rounding Item

• Click on the Inventory Button on the OpenMRS Dashboard and then Click on Manage Inventory Module Page and then Click on Manage Department and then click on New Department:

Open Inventory Button

Open Manage Inventory Module

Open Manage Departments

Open Create New Department

Open Enter Dept Name and Description

• Enter the New Department's Name and Description. It's best to use the Department Name as "Rounding" for purposes of clarity and reporting:

Open Enter Rounding Dept Name

Open After Saving Rounding Dept

• Next Create a Rounding Item. From Manage Inventory Module, Click on Mange Items then Click on New Item.

Open Manage Items

Open Click on New Items

Open Enter Item Details

• Enter "Rounding as the Name of the item", Select the Department as "Rounding" and then Check the :Has Physical Inventory" Check box and Add a price of 0.00 as per the screenshot and then Save the Item:

• Using a data base client like MySQL Workbench, get the Rounding department_id and item_id using the following queries: NB: Remember the include the name of your database e.g incase your database is called openmrs then use this name in the query e.g:

  • select department_id from openmrs.inv_department where name = 'Rounding';

  • select item_id from openmrs.inv_item where name = 'Rounding';

• With this Rounding Department ID and Rounding Item ID, Navigate to System Administration -> Advanced Administration -> Maintenance and click on the Settings Link then Click on OpenHMIS:

Open System Administration	Open Advanced System Administration	Open Maintenance Settings	Open Maintenance Settings OpenHMIS	Open Maintenance Settings OpenHMIS

Open System Administration	Open Advanced System Administration	Open Maintenance Settings	Open Maintenance Settings OpenHMIS	Open Maintenance Settings OpenHMIS

• Now Enter the Rounding Department ID and Rounding Item ID in the Cashier Rounding Dept Id and Cashier Rounding Item ID text boxes in the settings page and then save as shown below:

Open

Entering Rounding Dept ID and Item ID

• After saving, you have now successfully set up Cashier Bill Rounding.

• Now go to the Cashier Settings and then enter a "Rounding Mode" and "Round To Nearest" value.

  • NB:// If you dont want any rounding, set "Round To Nearest " to "0"(zero). Just make sure "Rounding Mode" and "Round To Nearest" have some value otherwise you will get an error when trying to process a bill.

Creating Cashier User

• All Cashiers must have a User account and be assigned to the Cashier role, for more information on adding users and assigning roles click https://openmrs.atlassian.net/wiki/display/docs/Administering+Users

• Set up Cashiers as Providers. To setup cashiers as providers using the following instructions:

1. Click System Administration	Open
2. Click Advanced Administration	Open
3. Now follow from Step 2 for the Classic UI below

Classic UI

1. Click Administration	Open
2. Click on the Manage Providers link.	Open
3. Click on the Add Provider link	Open
4. (Optional) Type in an Identifier for the provider An identifier is used to generally describe the role of the provider. Eg Cashier, Clerk, Doctor, Nurse  etc	Open
5. Enter the Person or Provider Name of the user you want to set up as a cashier	Open
6. Click Save	Open

Module Administration

With the new version of OpenHMIS (that is version 2.0+), the Cashier application will appear on the OpenMRS home page as shown below:

Open

Click on the Cashier application/button and you will be redirected the Cashier Task page as shown below:

Open

At the Cashier task page, you can either Create new bill, make a Timesheet Entry/Generate Shift Report or Manage Cashier Module. 

In order to manage the cashier module, click on the Manage Cashier Module application and you will be redirected to the OpenHMIS Cashier Module page.