Page tree
Skip to end of metadata
Go to start of metadata

Steps to Install the MDR-TB Module Version 3.0


OpenMRS 1.9 (at least 1.9.2)

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

  • Serialization XStream
  • HTML Widgets
  • Reporting 
  • Metadata Mapping
  • Metadata Sharing

All these modules can be downloaded from the OpenMRS Add-Ons 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 v1.0.9 of the Metadata Sharing module. From the "Administration" page, select "Share Metadata" from the "Metadata Sharing" section.  Click on "Import Package".

  • If you are not using the MVP dictionary, import the full package "MDR-TB MODULE 2.0 CORE" which you can down here:
    • MDR-TB Module Core Metadata
    • (Note that when importing into a fresh installation with no demo data or MVP dictionary, there will be two existing concepts for true and false.  Choosing "Merge - prefer mine" will enable the metadata package to import successfully.)
  • If you are using the MVP dictionary, import the MVP-specific package "MDR-TB MODULE 2.0 MVP" which you can download here:
MDR-TB Install 

Once that has been successfully imported, install the MDR-TB module from the OpenMRS module repository.

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

Note:  In order to successfully enter any encounters (eg. enroll a patient with an intake form), you will need to set up at least one provider in the system.  This is done by assigning a role of "Provider" to one or more users in the User Management section of Administration.

Upgrading from Version 2.0

If you upgrade your OpenMRS install from 1.6.x to 1.9.x, you will have to update your MDR-TB module from version 2.x to version 3.x.  This should be as simple as making sure you replace your 2.x omod with the latest 3.x omod, and also making sure you have upgraded the dependent modules listed in the Prerequisites section to versions that are compatible with your version of OpenMRS.  Also note that the Program Location module, a prerequiste when running version 2.x of the MDR-TB is no longer required when running version 3.0, and, in fact, should be removed (this is because starting with OpenMRS 1.8.x, the core platform supports program locations natively).

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

  • No labels

1 Comment

  1. Recently we experienced some difficulty trying to install the MDR-TB module on a 1.9.3 standalone and the MVP dictionary.  The summary is as follows:

    • You must be using version 1.1.8 of Metadatasharing or higher
    • After setting up the standalone with the MVP dictionary, but before you install the metadata package above, you need to:
      • Delete the short name for Moxifloxacin
      • Add 2 concept name tags directly via SQL:
        • insert into concept_name_tag (tag, description, creator, date_created, uuid) values ("short_en", "short_en", 1, now(), "3253f354-0370-102d-b0e3-001ec94a0cc1");
        • insert into concept_name_tag (tag, description, creator, date_created, uuid) values ("short_fr", "short_fr", 1, now(), "3253f476-0370-102d-b0e3-001ec94a0cc1");

    Following these steps, you should be able to install the Metadata package and the MDR-TB module successfully