The heart of any institution is its people, the OpenHMIS project is creating tools to help that "heart" beat more smoothly. Providing quality medical services is a challenge and, while OpenMRS is a great help toward meeting that challenge, it does not directly address the administrative needs of a medical institution. This is where the OpenHMIS modules come in: we are creating OpenMRS modules that provide the tools to help institutions run more effectively.
The OpenHMIS Inventory Module is a simple inventory management system that runs within OpenMRS. As the name implies, it is a tool to help with inventory management and is at the center of many other institutional services such as Billing, Pharmacy, and Lab. This module specifically targets small-mid sized institutions that need a simple inventory management system and thus does not (currently) provide all the features that a more full-fledged inventory management system has. The main features include:
- Item Management
- Stockroom Management
- Stock Operation Tracking
Future versions may include support for:
- Stock Operation Requests
- Automatic Item Stock Replenishment
- Supplier Management
- Support for External Inventory Systems
- OpenMRS 1.9.9+
- REST Web Services Module 2.x
- OpenHMIS Commons Module 3.x
- OpenHMIS Backbone Forms Module 2.x
- (Optional) Idgen Module: Needed to automatically generate operation numbers
- Module: https://modules.openmrs.org/modules/view.jsp?module=openhmis.inventory
- Source code: https://github.com/OpenHMIS/openmrs-module-openhmis.inventory
|1.6 - 2.0||29-Apr-2015||1.6 - 2.0 Notes|
REST Web Services
The REST Web Services module must first be configured if this has not already been done.
- On the OpenMRS Administration page, click on the REST Web Services - Settings link:
|System Administration button||Advanced System Administration button||Rest Web Services Link|
- 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'.
The configuration for the Inventory Module is done through the Inventory Settings page:
|Click on Inventory Button||Click on Manage Inventory Module||Inventory Settings|
There are three settings that can be configured:
- Auto Generate Operation Number: Set whether or not to generate an operation number when a new stock operation is created.
- Identifier Source: The Idgen module identifier source used to generate the operation number.
- Auto Complete Operations: Set where a stock operation is automatically completed and moved to the completed state or left at the pending state once creating awaiting completion.
The Settings page also includes Reports that a user can select from pre-entered Jaspers Reports.
Before the OpenMRS 2.0 release, an OpenHMIS Inventory Module section appears at the far right corner of the home page after installation of the inventory module.
With the current OpenMRS version, OpenHMIS presents the user with a more friendly user interface. After logging into the system, you will be led to the Home page with the various icons representing the different applications on OpenHMIS. The Inventory application can be accessed using the Inventory icon as shown below.
Click on the Inventory module to access the Inventory Task page. The inventory task page allows the user to either perform inventory task operations or manage the inventory task module. To manage the inventory module, click on the Manage Inventory Module icon.
This will redirect you to the Manage Inventory Module page. The manage inventory module page allows the user to either create Inventory Role, Manage Items, Manage Item Attribute Types, Manage Departments, Manage Institutions, Manage Stockrooms, Manage Operation Types, View Stock Operations, Generate Item Mappings or manage Inventory Settings.
For the previous OpenMRS versions before the Reference application e.g OpenMRS version 1.9.9, the Inventory module management can only be done on the Admin page:
Below is a table showing all the inventory module management features and a brief description of what each is responsible for:
|Inventory Role Creation||Add or remove the required privileges to use the inventory module to/from a role or create a new role with those privileges.|
|Manage Items||Add, edit, retire, and purge the items (that is, the products and services) that are used by your institution.|
|Manage Departments||Add, edit, retire, and purge the item departments.|
|Manage Institutions||Add, edit, retire, and purge the external institutions that item stock can be distributed to.|
Add, edit, retire, and purge the stockrooms and view stockroom details.
|Manage Operation Types||Add, edit and retire the stock operation types.|
|Generate Item Mappings||Generate item to concept mappings.|
Inventory Module Concepts
To effectively use the inventory module, it is important to understand the different objects and how they relate.
|Item||The information about a product or service that can be purchased or tracked at an institution.|
|Item Stock||A physical item that is located in a stockroom or distributed to an external institution or patient. This includes a quantity and an optional expiration date. Item stock can only be created for items that are marked as having physical inventory.|
|Stockroom||A location where item stock is stored.|
|Stock Operation Type|
The kind of stock operation to be performed. The module currently includes six stock operation types:
|Stock Operation||Moves one or more item stock into, within, or out from the institution, as defined by the Stock Operation Type.|
|Transaction||Records the individual changes in item stock in a given stockroom. For example, if a single item stock is transferred from the Main stockroom to the Pharmacy stockroom, two transactions would be created; one for the item stock deduction from Main and another for the item stock addition to Pharmacy.|
|Batch Operation||Refers to the Stock Operation when a given quantity of Item Stock was added into the system.|
Stock operations have a status which determines the current state:
|New||The operation has been created but not yet processed by the system.|
|Pending||The operation has been started and is currently in progress.|
|Completed||The operation has been finished.|
|Canceled||The operation was canceled and any processing that was done while pending is reversed.|
To check the operation status, click on Inventory > Inventory Tasks > Pending Operations.
You can filter your search by either the status of the operation, operation type or the stockroom.
Operation Type Status Processing
To create an inventory operation, click Create Inventory Operation. This will direct you to the create inventory operation page.
To do any stock operations;
- Click on the Operation Type drop down button and select the type of operation you want to perform. The operation type can either be an Adjustment, Disposed, Distribution, Receipt, Return or a Transfer.
- Check the operation date. If the stock operation was done on a different date than the current date, click on Change Date and choose the correct date of the stock operation.
- Select the source and destination for the item stock.
- Type the item stock and quantity and select the expiration date for items with an expiry date.
- Finally, click the Create Operation button.
As the status of the stock operation changes, the requested item stock changes are applied to the source and/or destination stockrooms as defined by the stock operation type.
|Adjustment||Item stock changes negated and applied to source||Nothing||Item stock changes reversed|
|Disposed||Item stock changes applied to source||Nothing||Item stock changes reversed|
|Distribution||Item stock changes negated and applied to source||Nothing||Item stock changes reversed|
|Initial||Nothing||Item stock changes applied to destination||Nothing|
|Receipt||Nothing||Item stock changes applied to destination||Nothing|
|Return||Nothing||Item stock changes applied to destination||Nothing|
|Transfer||Item stock changes negated and applied to source||Item stock changes applied to destination||Source item stock changes reversed|
Stockrooms and Item Stock
Much of inventory management revolves around stockrooms and item stock. The following section explains how the Inventory Module tracks changes to item stock and how to resolve data issues.
Negative Item Stock Quantities
The OpenHMIS Inventory Module is a permissive inventory system and will allow negative item stock quantities in a stockroom.
This is allowed so that the system does not get in the way of work that needs to be done. However, it is important to note that if this is allowed to go unchecked it will result in data that is meaningless. If the inventory system indicates a different item stock quantity than actually exists, there are two ways to correct this:
- An adjustment operation can be created to update the system quantites to match the actual quantities.
- The missing operations can be created to bring the item stock quantities to the expected values. This assumes that there was not some extra-system reason why the quantities are different (ie, theft or a typo).
With the new version of OpenHMIS, resolving this issue has been made easy by using the Stock Take page. The stock take page gives an overview of item stock available in different stock rooms, the item stock expiration date where applicable and the quantity of each item stock. The stock take page also provides an Actual Quantity column that allows users to do stock adjustments.
Use the drop down button to select the stockroom that you want to do a stock take on. The quantity in the system should always match the Actual quantity in the stockroom. If for any reason the system's quantity does not match the actual quantity, type the actual quantity of the item stock in the Actual Quantity text field and click on Save Stock Take. This will adjust your system quantity with the actual quantity that you have input.
Item Stock Detail
The item stock quantities that can be viewed on the stockroom detail page can be a little deceptive. The item stock quantity is actually broken down by both the item stock expiration date (if there is one) and the originating operation (called the Batch Operation), we call the the Item Stock Detail. These details are not currently visible on the Stockroom page where only the cumulative total for each item stock is visible, but the item stock details will be added in a future version.
When transferring or distributing item stock it is assumed that item stock from the oldest batch operation are moved first and then, if there is still any remaining quantity to move, the next oldest item stock batch operation is used and so on. The same logic applies for item stock with an expiration, except that the item stock that will expire the soonest is automatically chosen unless the user selects expiration when creating a new stock operation.
When Auto is selected rather than a specific expiration the system will satisfy the item stock request from the closest expiration first, then the next closest, and so on until the requested quantity has been met.
When viewing a stock operation with item stock details that were automatically selected the details will not show the specific batch or expiration, instead they will be listed as (Auto).
Step By Step Setup
Once you understand the various concepts, then you need to setup the various components so as to get a working prototype.
Rest Web Services
First setup the rest web services URI as explained in the configurations description above.
Create an Inventory Number Generator (optional)
You need to have installed the idgen module in order to use this functionality.
On the OpenMRS Administration page, click on the Manage Identifier Types – Patients link:
Then you will click on Add Patient Identifier Type link as shown:
Add the Name, description (optional) and the Number format in this example (0123456789)
and the Save Identifier Type:
After Saving the Identifier type above, you will get this page. Add Base Character set,
First Identifier set which will be the first operation number. Then add a prefix,
min and max length all optional and then Save
Navigate to the Inventory Settings page where you will check the "Auto Generate
Operation Number" check box and then choose the Inventory Generator as seen shown.
Please remember to click Save Settings to effect changes.
Create a department
Items from Pharmacy, those from Lab, Surgery and so on can be grouped under departments. So for example to create items from Pharmacy create a pharmacy department and then associate items to be created later under this department.
From Manage Inventory Module,
click on Manage Departments
|Click on New Department||Enter a name and optional description||Save Changes|
Create items and services.
From Manage Inventory Module,
click on Manage Items
|Click on New Item|
Item Name, Department, Price and
Default price are required
Create a Stockroom
Below is how to create a stockroom:
From Manage Inventory Module,
click on Manage Stockroom
|Click on New Stockroom||Enter a name and optional location||Save Changes|
Perform Inventory Operation
Now that you have created a department, item and stockroom, you are ready to start performing inventory stock operations.
Ideally the first stock operation should be a receipt or initial operation. This will put item stock that is a quantity and expiration to your item(s)
|Click on Inventory Tasks|
|Then Click on create operation|
This is the Inventory operation page from which you'll change the Operation Type
stockroom and enter the line items
Change the Operation Type to Initial and the Destination Stockroom to Main Pharmacy.
This means that you are creation an operation to be effected in Main Pharmacy for the
item that you will choose below
Search for the line item in the Operation Items section then enter a quantity and
expiration for the item
|Then save the operation|
the Status of the Operation is pending awaiting completion.
Click on the Operation in order to complete it
Click on the Button on the Top right hand of the page and you will see a complete
|Click on Complete Operation to complete it|
|The status now changes to COMPLETED|
The Inventory Dashboard is the landing page to perform inventory-related activities. From this dashboard users can view and process their stock operations as well as create new stock operations. The dashboard is accessed from the Inventory link on the right side of the OpenMRS header. For the new version, the Inventory module is accessed from the home page using the Inventory application.
The dashboard displays a list of the Pending stock operations for current user:
Clicking on a stock operation item will display the operation details:
The stock operation details section will appear below the list. In it you can view all the operation information, the item stock that is part of the operation, and process (that is, Complete or Cancel) the operation.
Clicking on the New Operation link will display a form to create a new stock operation:
To create a new operation:
- Select the Operation Type
- Select the Source and/or Destination Stockroom. These dropdown's will be enabled/disabled based on the select Operation Type
- Enter any Attributes defined for the specified Operation Type.
- Add the Item Stock for the operation, along with the Quantity and an optional Expiration
- Click the Create Operation button
Adding Item Stock works in much the same way as adding items to a bill in the Cashier Module. To search, simply start typing the name of the item you want to add and a list will display the items found:
With the autocomplete list displayed, either use the arrow keys or mouse to select the desired item and press the <Tab> or <Enter> key to add the item:
You can now enter the item stock quantity and, if the item is expirable, the expiration. Depending on the operation type, the expiration will either be a dropdown or a date entry area. Stock operations with no source stockroom (at the time of writing that is just the Receipt operation type) require the entry of the expiration for all expirable items. If a default expiration period has been defined for the item (in days), the expiration will default to that number of days from the current date.
Clicking on the Create Operation button will save the operation and set the status to Pending.
Inventory can be tracked using inventory reports. Inventory reports can be accessed from the Inventory Task page under Inventory Reports.
|Stock Take||It gives an inventory stock take for a single stockroom|
|Stock Card||It gives a report for a single item across all stockrooms within a specified date.|
|Stockroom Stock Operations||It gives a report on individual stockroom stock operations within a specified date.|
|Stockroom||It gives an inventory stockroom report of an individual stockroom within a specified date.|
|Expiring Stock||It gives a report of items that expire by a specified date.|