NCD Installation Guide

Owned by Sriskandarajah Suhothayan
Last updated: Dec 17, 2017 by Fawwaz YusranVersion comment
3 min read

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 instance.

Prerequisites

  1. 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
  2. MRN Generator module (mrngen)
  3. 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://addons.openmrs.org/#/show/org.openmrs.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://openmrs.atlassian.net/wiki/display/docs/Messaging+Module).

Note: as of this writing, the latest available Messaging 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 at http://svn.openmrs.org/openmrs-modules/ncd/trunk/messaging-module/messaging-0.9.0-beta.omod

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 Email Notifications
  • Sending Sms Notifications

Therefore Sms and/or Email should be configured

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

To setup Sms you will need a modem and some patience, the configuration setup is given at https://openmrs.atlassian.net/wiki/display/docs/Messaging+Module+Setup|display/docs/Messaging+Module+Setup

Install and Notifiable Condition Module (NCD)

Install the NCD 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 ncd-1.2.omod
  • Click "Open" button
  • Click "Upload" button to add the NCD module

Configure Notifiable Condition Module (NCD)

Configure Person Attribute Types

Critic Notifier in NCD to work Person Attribute Types such as Email address and/or Telephone number should be added

If the system is going to send Emails then Email address Person Attribute should be created as bellow

  • In OpenMRS, Click the "Administration" link near top of the page
  • Click the "Manage Person Attribute Types" link (under the "Person" heading)
  • Click the "Add New Person Attribute Types" link
  • Enter an appropriate name for the Email address Person Attribute in the Name field. E.g "Email Address"
  • For the Format field select java.lang.String from the drop-down
  • Enter an meaningful description in the Description field
  • Click "Save Person Attribute" button to save the configuration

Similarly is the system is going to send Sms then Telephone numbers Person Attribute should be created as bellow

  • In OpenMRS, Click the "Administration" link near top of the page
  • Click the "Manage Person Attribute Types" link (under the "Person" heading)
  • Click the "Add New Person Attribute Types" link
  • Enter an appropriate name for the Telephone number Person Attribute in the Name field. E.g "Telephone number"
  • For the Format field select java.lang.String from the drop-down
  • Enter an meaningful description in the Description field
  • Click "Save Person Attribute" button to save the configuration
Configure Settings (formerly Global Properties from 1.9 downwards)

For NCD to to use the configured Patient Attribute Type the Settings (formerly Global Properties from 1.9 downwards) should reflect this, Assign the Setting (formerly Global Property from 1.9 downwards) as follows

  • In OpenMRS, Click the "Administration" link near top of the page
  • Click the "Manage Global Properties" link (under the "Maintenance" heading)
  • Find the Setting (formerly Global Property from 1.9 downwards) with the name "ncd.emailPersonAttribute" and in the Value field enter the name for the Email address Person Attribute we configured in the previous configuration. E.g "Email Address"
  • For the Format field select java.lang.String from the drop-down
  • Enter an meaningful description in the Description field
  • Click "Save Person Attribute" button to save the configuration

Similarly configure the Setting (formerly Global Property from 1.9 downwards) for the Telephone Number by editing the value of "ncd.smsPersonAttribute" as above.