- 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://modulesaddons.openmrs.org/#/modulesshow/vieworg.openmrs.jsp?module=.openhmis.-inventory-module
- 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
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 only two 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.
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 version OpenMRS, Inventory module management 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 operation management features and a brief description of what each module 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.|
|View Stock Operations||View and process stock operations.|
|Generate Item Mappings||Generate item to concept mappings.|
Inventory Module Concepts
|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.|
|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|
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.