/openmrs-module-hip

HIP module for exposing HIP specific features from OpenMRS.

Primary LanguageJavaMIT LicenseMIT

openmrs-module-hipmodule

HIP module for exposing HIP specific features from OpenMRS.

Description

This module is supporting the HIP service with all necessary endpoints exposed that are required by the HIP service.

Building from Source

You will need to have Java 1.6+ and Maven 2.x+ installed. You need to install the OpenMrs module SDK from https://github.com/openmrs/openmrs-sdk (see Readme for installation instructions)

Use the command mvn clean install to build the module, the .omod file will be in the omod/target folder.

Installation

  1. Build the module to produce the .omod file.
  2. Use the OpenMRS Administration > Manage Modules screen to upload and install the .omod file.

If uploads are not allowed from the web (changable via a runtime property), you can drop the omod into the ~/.OpenMRS/modules folder. (Where ~/.OpenMRS is assumed to be the Application Data Directory that the running openmrs is currently using.) After putting the file in there simply restart OpenMRS/tomcat and the module will be loaded and started.

Configure values

Vagrant setup

You can configure values like, say location, concept and attribute names. you can check api/src/main/java/org/bahmni/module/hip/Config.java to know what are the values you can configure and default values.

One time setup

  1. create a file. For example, created env_file in /etc/openmrs/ directory.
  2. To create conf file for openmrs service,systemctl edit openmrs. It will open blank file. paste the following lines in it
[Service]
EnvironmentFile=/etc/openmrs/env_file

Note: You need to specify your created file path from 1st step in EnvironmentFile variable

To configure values

You need to add values to the env_file. For example, if you need to specify custom values for Location and Phone Number attribute.

LOCATION=your_location
PHONE_NUMBER=your_phoneNumber_attribute_name

Note: Attribute Name should be exactly same as enum keys from api/src/main/java/org/bahmni/module/hip/Config.java

Docker setup

You can add values to the openmrs Environment variables, specifying same attribute name.