Overview
This guide explains step by step how to install the Notifiable Condition Detector (NCD) and other components necessary to run the NCD to an already configured OpenMRS instants.
Prerequisites
- Running version of OpenMRS 1.6 or higher
If you don't have a running installation of OpenMRS please follow the OpenMRS Installation Guide to install OpenMRS - MRN Generator module (mrngen)
- Messaging Module
Install and configure MRN Generator Module (MRNGEN)
The NCD module depends on the MRN Generator Module (for reference, see: http://openmrs.org/wiki/MRNGen_Module).
You can download laterst the MRNGEN from https://modules.openmrs.org/modules/view.jsp?module=mrngen
Install the MRNGEN Module to OpenMRS per the following steps:
- In OpenMRS, Click the "Administration" link near top of the page
- Click the "Manage Modules" link (under the "Modules" heading)
- Click "Add or Update Module" button if any
- Click "Browse" button and select the module file mrngen-xx.omod
- Click "Open" button
- Click "Upload" button to add the MRNGEN module
Configure the MRN Generator module
- In OpenMRS, Click the "Administration" link near top of the page
- Click the "ID Generator Setup" link (under the "MRN Generator Module" heading)
- Enter 100000 as the "starting value for sequence" for both id types.
- Enter "Auto" (without the double quotes) as the Prefix for both id types.
- Click submit to complete the initialization.
Install the Messaging Module
The NCD module also depends on the Messaging Module (for reference, see: https://wiki.openmrs.org/display/docs/Messaging+Module).
Note: as of this writing, the latest available Meaaging Module binary does not work with the NCD Module.
Therefore a working version of Messaging Module is included as part of the NCD module sources in the OpenMRS module repository.
Install the Messaging Module to OpenMRS per the following steps:
- In OpenMRS, Click the "Administration" link near top of the page
- Click the "Manage Modules" link (under the "Modules" heading)
- Click "Add or Update Module" button if any
- Click "Browse" button and select the module file messaging-0.9.0-beta.omod
- Click "Open" button
- Click "Upload" button to add the Messaging Module
Configure the Messaging Module
NCD uses two features From the Messaging Module
- Sending Sms Notifications
- Sending Email Notifications
Therefore Sms and/or Email should be configured
To setup Sms you will need a modem and some patience, the configuration setup is given at https://wiki.openmrs.org/display/docs/Messaging+Module+Setup
To setup Email,
- In OpenMRS, Click the "Administration" link near top of the page
- Click the "Manage Messaging Gateways" link (under the "Messaging" heading)
- Add your Email configuration details in the Email window
- Click "Save Changes" button to save the configuration
- Click "Start Gateway" to enable the gateway to send Emails
Install and configure Notifiable Condition Module (NCD)
The NCD module depends on the MRN Generator Module (for reference, see: http://openmrs.org/wiki/MRNGen_Module).
You can download laterst the MRNGEN from https://modules.openmrs.org/modules/view.jsp?module=mrngen
Install the MRNGEN Module to OpenMRS per the following steps:
- In OpenMRS, Click the "Administration" link near top of the page
- Click the "Manage Modules" link (under the "Modules" heading)
- Click "Add or Update Module" button if any
- Click "Browse" button and select the module file mrngen-xx.omod
- Click "Open" button
- Click "Upload" button to add the MRNGEN module
Configure the MRN Generator module
- In OpenMRS, Click the "Administration" link near top of the page
- Click the "ID Generator Setup" link (under the "MRN Generator Module" heading)
- Enter 100000 as the "starting value for sequence" for both id types.
- Enter "Auto" (without the double quotes) as the Prefix for both id types.
- Click submit to complete the initialization.