Kenya EMR Example Add-on Module

This is an example of a add-on module for the Kenya EMR which shows how to add various things to the EMR.

Adding a new app

It uses the appframework module to define an app of its own. The Kenya EMR module will show this app's icon on its homepage along with its own apps.

To register an app, the module defines an app descriptor bean in its webModuleApplicationContext.xml file, e.g.

<bean id="kenyaEmrExampleAddonApp" class="org.openmrs.module.appframework.SimpleAppDescriptor">
  <property name="id" value="keaddonexample.example"/>
  <property name="label" value="Example"/>
  <property name="homepageUrl" value="keaddonexample/home.page"/>
  <property name="iconUrl" value="moduleResources/keaddonexample/images/apps/example.png"/>
</bean>

An add-on module can define as many new apps as it wants.

Adding new content

The KenyaEMR module contains content managers which can be used to access existing content or register new content:

• MetadataManager
• RegimenManager
• FormManager
• CalculationManager
• ReportManager

Adding new metadata

You can load a set of metadata packages easily using the metadata manager. To do this create an XML file which lists the packages you want loaded, e.g.

<packages xmlns="http://www.kenyaemr.org/packages">
  <package groupUuid="b3dd6a3c-ecae-45e9-86a8-17c1f2f38da9" filename="metadata/Example_Addon_Metadata-1.zip" />
</packages>

Then add a metadata configuration bean to your moduleApplicationContext.xml, e.g.

<bean class="org.openmrs.module.kenyaemr.metadata.MetadataConfiguration">
  <property name="moduleId" value="keaddonexample" />
  <property name="path" value="packages.xml" />
</bean>

Registering a form

Once you've added an HTML form via a metadata package, you can register it so that it's used within the main Kenya EMR UI. Do this by adding a form descriptor to your your moduleApplicationContext.xml, e.g.

<bean class="org.openmrs.module.kenyaemr.form.FormDescriptor">
  <property name="formUuid" value="b694b1bc-2086-47dd-a4ad-ba48f9471e4b" />
  <property name="frequency" value="VISIT" />
  <property name="apps">
    <set><value>kenyaemr.medicalEncounter</value><value>kenyaemr.medicalChart</value></set>
  </property>
  <property name="iconProvider" value="keaddonexample" />
  <property name="icon" value="forms/example.png" />
</bean>

Adding a new report

Reports in the Kenya EMR are created from report builders which are registered components. To define your own report simply create a component which extends ReportBuilder, e.g.

@Component
public class ExampleReport extends ReportBuilder {
  ...
}

Using the Kenya EMR UI

Example also uses the uiframework module and can access any UI resource from the Kenya EMR module or Kenya UI module. To use UI resources from the Kenya EMR module, the add-on module just has to specify the provider name, e.g.

<% ui.decorateWith("kenyaemr", "standardPage") %>

<% ui.includeFragment("kenyaui", "widget/button", [ label: "Ok" ]) %>

To access the KenyaEmrUiUtils class which contains useful methods for formatting objects, use the @SpringBean annotation in a controller's parameter list, e.g.

public void controller(PageModel model, UiUtils ui, @SpringBean KenyaEmrUiUtils kenyaUi) {
  ...
}