MDR-TB Module Installation and Configuration Guide - Version 2.0

Owned by Cordt Byrne
Last updated: Aug 23, 2012 by Mark GoodrichVersion comment
3 min read

Steps to Install the MDR-TB Module Version 2.0

Also note that the steps below will not function as a upgrade path from Version 1.0.  You should only follow the steps below if you don't have MDR-TB Version 1.0 running on your system, as the Core Metadata you import will conflict with the existing metadata for Version 1.0.

Prerequisites

Version 2.0 of the module requires the latest version of OpenMRS 1.6 (currently 1.6.3).  It will not run on 1.5 or earlier, and currently does not work on 1.7 or above. 

The following modules must be installed for the MDR-TB module to operate:

  • Serialization XStream

  • HTML Widgets

  • Program Location

  • Reporting (v0.6 or greater)

  • Metadata Sharing (v0.10.0.1)

All these modules can be downloaded from the OpenMRS module repository.

Also note that module only supports Firefox.  There are a few issues when using the module with Chrome; it has not been tested at all in IE.

Core MDR-TB Metadata

Once you've got these modules installed, you will need to import the core concepts, encounter types, and workflows used by the MDR-TB module. If you are using the MVP dictionary, you should already have the core concepts, but will still need to import the encounter types and workflows.

Importing is done via the Metadata Sharing module. Make sure you are using v0.10.0.1 of the Metadata Sharing module. From the "Administration" page, select "Share Metadata" from the "Metadata Sharing" section.  Click on "Import Package". Note that you will need to update to the latest maintenance build of OpenMRS 1.6.x for these metadata imports to work. Imports in version 1.6.3 may be affected by a bug (https://tickets.openmrs.org/browse/TRUNK-2428) that has been corrected in the maintenance build.

If you are not using the MVP dictionary, import the full package "MDR-TB MODULE 2.0 CORE METADATA.zip" which you can download here:

MDR-TB Module Core Metadata

If you are using the MVP dictionary, import the MVP-specific package "MDR-TB MODULE 2.0 MVP METADATA.zip" which you can download here:

MDR-TB Module MVP Metadata

Note that you will need a recent version of the MVP dictionary, as the required mapping codes for MDR-TB were only recently added to the MVP dictionary.

MDR-TB Install 

Once that has been successfully imported, install the MDR-TB module itself. The module is not currently found in the module repository, but can be found here:

mdrtb-2.2.7.omod

Once it has been installed successfully, click on the "MDR-TB Homepage" tag to go to the MDR-TB Homepage.

Troubleshooting

The regimen component of the MDR-TB module requires that the OpenMRS instance be configured with the standard OpenMRS order types. These order types *should* be created by default when installing a  new OpenMRS instance, but it looks like, as of this writing (January 24, 2011), the order type table is only populated with data if you chose the install "demo data" installation option.

If the order_type table in your database is empty, you will need to apply the following SQL script to your DB to add the necessary data:

orderType.sql

(You should be able to apply these changes by executing the following command from the command line: mysql --u [your_user_name] --p openmrs < orderType.sql) 

Older Versions

mdrtb-2.1.1.omod which requires: MDR-TB_MODULE_2.0_CORE_METADATA_V1.1.5_adc585d5-dddf-457d-9359-945fb20274fa.zip

Adding Your Own Intake and Followup Forms

The Visits section of the MDR-TB module comes with very simple intake and followup forms that just collect the basic details of the encounter, vitals, and clinician notes.  It is possible, however, to include your own custom HTML Forms here.  To do so, simply associate an HTML Form you create with the MDR-TB Intake or MDR-TB Followup encounter type (via Manage HTML Forms).  Then, when you add a new Intake or Followup encounter for a patient, you will be asked to chose whether you want to use the "simple" form, or the custom HTML Form you have installed.

More Information

MDR-TB Module User Guide

MDR-TB Module Report Guide

Release Notes

Version 2.1.8

  • Replaced "Drug Sensitive" program outcome with "Treatment Not Needed"

  • Misc. small bug fixes