Project description
This project's aim is to create a UI for administering the Laboratory module. This involves designing and implementing a module installation process, that will integrate the module with an existing OpenMRS installation, as well as the creation of the actual administration pages. The admin pages will be responsible to manage all of the meta data that is required to operate the Lab module.
Technologies used to create the admin pages will be mainly JSP and JQuery in correspondence with the Spring MVC framework.
Mentor: Roger Friedman (Unlicensed)
Student: Martin Losse (Unlicensed)
Blog: http://summon-gsoc.blogspot.de/
Roadmap/Timeline: -> GDoc
Module Functionality
The JSSLab admin module aims to allow extensive configuration of metadata related to the JSS Lab. Any data required for the JSSLab frontend forms to work will be set up here. The following sections will outline the installation process and describe the options available on each page of the module.
Module Installation
Being OpenMRS module the first concern is the installation on an OpenMRS instance.
As there are significant changes between the OpenMRS versions that impact the functionality of the module, the JSSLab admin module is also offered in different version, depending on the OpenMRS version that is being used. The minimum OpenMRS version that is supported is OpenMRS 1.8. For better identification of which module version is required, the module version is locked to the OpenMRS version. Any version of the JSSLab admin module starting with 1.8 will be compatible with the latest OpenMRS 1.8 release, whereas a version of 1.9.* on the module will indicate compatibility with OpenMRS 1.9.
The module is packaged as an omod file, that can be added to an OpenMRS instance the way a module would normally be added (either via the admin interface or by dropping the omod into the appropriate folder).
New installation
When it is first installed JSSLab admin module will update the OpenMRS database, creating new tables that are specific to the module. In addition to that, default metadata, that is required for the module's operation, is added to existing OpenMRS tables.
As the user first tries to access any of the module's pages, they will be redirected to the initial setup page. This page allows the user to change the default settings for the central global properties needed to operate the module and offers the option to install sample data to better showcase the capabilities of the module. Once the necessary changes have been made, the user will have to click on Finish Setup to be redirected to the page they were planning to access. If the user desires to visit the setup page again it can be selected from the top menu when in the module's administration.
Updating JSSLab admin module
As maintenance releases to the module are released or the user chooses to migrate to a newer OpenMRS version it will become necessary to update the JSSLab admin module running on the OpenMRS instance. The update procedure, like the first installation is also OpenMRS standard. The user can choose to either upload the new version to the system or drop it in the appropriate place in the file system. As the application context is reloaded, the new module version will automatically make any necessary adjustments to the database tables. In case manual settings have to be made, the user will again be presented with the initial setup page if he tries to access any of the module's pages.
JSSLab Administration Pages
The JSSLab admin module extends the OpenMRS administration by a new section called JSSLab. In this section there are 5 (+1) pages available to work with, that will be described throughout this section.
Settings
TBD
Catalog
TBD
Templates
Not yet implemented
Instruments and Supplies
TBD
Reports
Not available in current version of the module
Initial Setup
TBD
Design
This chapter contains all relevant information on the design of the JSSLab admin module. There are three domains to be concerned here.
The first is the installation process of the module.
The other is the actual administration part on the administration pages.
Installation Process
The installation process describes the set of actions that have to be performed when the module is loaded (newly installed, updated or restarted).
These slides visualise the process as it is currently planned to be implemented.
- The database table shells required for operation of the module need to be checked for presence, altered if they are outdated or created if they do not yet exist.
- Global properties need to be created and set up
- Default Report Definitions (xml files) are installed in a default directory (filesystem), another directory will be used for custom reports for easy distinguishing
- If the module is installed for the first time the user will be given several choices
- whether they want to install base data
- whether they want to install sample data
- If the module is updated
- whether they want to update the base data
- whether they want to install new sample data (old sample data will be removed, if any)
Database setup operations will be performed using Liquibase
- the default liquibase.xml will be automatically run by OpenMRS during the module installation and create all table shells for JSSLab
- liquibase-sample.xml and liquibase-basedata.xml will be called on demand if the user chooses to have the data installed.
Admin pages
Mock-ups of the admin pages are available here
The admin section is currently planned to consist of 5 pages. In general the admin section allows administrators to configure all the meta data that drives the JSSLab module. The functionality is as follows:
- Settings
- Selection of one particular laboratory that is to be considered as "managed" within the system
- Selection of other laboratories that should be available for the creation of Lab Orders
- Creation of new laboratories
- (Creation of Global Properties)
- (Modification of code lists)
- Catalog
- Configure Investigations (Panels) that can be performed by a specific laboratory
- Configure Test Results for Investigations
- Templates
- Configure Templates that are going to be used in Investigations
- Describe/update Templates that have been used in Investigations prior to being configured on this page
- Instruments & Supplies
- Configuration of the instruments and supply items, that should be available for selection/autocomplete in forms and generally available to Lab module users
- Reports
- Management of report definitions
- Download of existing definitions
- Upload of custom definitions
Jira Tickets