Cohort Module

The purpose of the OpenMRS Cohort Module is to manage Cohort-related Data, Types, Attributes, Attribute Types and Members while using REST to allow external system integration. Cohort management can be performed by one of two ways:

Simple cohorts for single entities.
Group cohorts catering to collections like households.

Introduction

What's a cohort?

A cohort consists of a group of patients based on a condition like patients receiving similar kind of treatment which can be monitored over a period of time.

Cohort management system unlike patient management system deals specifically to monitoring and suggesting possible cures to groups of cohort members under a specific cohort unlike separate diagnosis for a particular patient.

We can analyze trends and patterns and this helps in research and policy making.

Objective of the Project

The purpose is to manage cohort related data:
- cohorts
- cohort type
- cohort attributes
- cohort attribute types
- cohort members
- cohort member attribute
- cohort member attribute type
Using REST to allow external system integration with cohort module
Cohort Management can be performed in two ways:
- Simple Cohorts for single entities
- Cohorts including groups or collections like households

This document will cover following information:

Design of the Module
Cohort REST Web Service Integration
User Manual
Potential Improvements
Downloads and Resources

Design of the Module

ER Diagram:

The module deals with creating cohorts and associating it with cohort attributes which are dependent on cohort attribute types.
Every cohort member who is a patient is associated to the cohort and also it can have cohort member attributes which are dependent on cohort member attribute types.
Search operations can be performed based on name under the Manage Cohorts page.
Each of the cohort can have many encounters, visits and observations which are created utilizing the forms from the HTML Form Entry module.
The search operation would be based on the cohort unlike in OpenMRS which is based on only patient identifier/names.
It is also created utilizing the REST interface from the REST Module wherein the resources are identified in requests using URIs as resource identifiers to view cohorts, cohort encounters and cohort observations.

Cohort Web Service Web Integration

We would be utilizing REST services in our module so that users who are not accessing OpenMRS can view the available data of the module by sending an HTTP GET or POST request.
GET Request can be sent to view the data related to cohorts, cohort members, cohort encounters and cohort observations.
POST Request can be sent to add data into the database by sending parameters as a JSON object.
To know more about REST MODULE click here: REST Module
Modules required:
1. Cohort Module
2. REST web services

Resources

CohortMember

Retrieve cohort member

GET /ws/rest/v1/cohortm/cohortmember/<UUID>

Parameter	Type	Description
`UUID`	`string`	UUID of cohort member to be retrieved

List cohort member attributes

GET /ws/rest/v1/cohortm/cohortmember/<UUID>/attribute

Parameter	Type	Description
`UUID`	`string`	Cohort member UUID

CohortMemberAttributeType

Retrieve cohort member attribute type

GET /ws/rest/v1/cohortm/cohort-member-attribute-type/<UUID>

Parameter	Type	Description
`UUID`	`string`	Cohort member attribute type UUID to retrieve

Response

{
  "uuid": "a47330c2-6222-423e-9258-ccb186f39749",
  "display": "test_name",
  "name": "test_name",
  "description": "desc",
  "minOccurs": 1,
  "maxOccurs": 3,
  "datatypeClassname": "string",
  "preferredHandlerClassname": null,
  "retired": true,
  "links": [
    {
      "rel": "self",
      "uri": "http://localhost:8086/openmrs/ws/rest/v1/cohortm/cohort-member-attribute-type/a47330c2-6222-423e-9258-ccb186f39749"
    },
    {
      "rel": "full",
      "uri": "http://localhost:8086/openmrs/ws/rest/v1/cohortm/cohort-member-attribute-type/a47330c2-6222-423e-9258-ccb186f39749?v=full"
    }
  ],
  "resourceVersion": "1.9"
}

Retrieve all cohort member attribute types

GET /ws/rest/v1/cohortm/cohort-member-attribute-type

Create cohort member attribute type

POST /ws/rest/v1/cohortm/cohort-member-attribute-type

body

{
  "name": "Cohort member attribute type name",
  "description": "This is the description",
  "datatypeClassname": "java.lang.String"
}

Update cohort member attribute type

PUT /ws/rest/v1/cohortm/cohort-member-attribute-type/<UUID>

Parameter	Type	Description
`UUID`	`string`	UUID of cohort member attribute type to be updated

Body

{
  "name": "Updated test name"
}

Void/Delete cohort member attribute type

DELETE /ws/rest/v1/cohortm/cohort-member-attribute-type/<UUID>?purge=<true|false>

Parameter	Type	Description
`UUID`	`string`	UUID of cohort member attribute type to be voided
`purge`	`boolean`	Cohort member attribute type resource will be voided/retired unless `purge = true`

Example GET Requests

PARAMETERS:

{"name":"neurologicalrecoverystudy","cohortType":"\(list the related cohortType uuid\)","cohortProgram":"\(list the related cohortProgram uuid\)"}

POST :http://localhost:8080/openmrs/ws/rest/v1/cohortm/

PARAMETERS

{"name":"Horatio","person":"\(list the related person uuid\)","cohort":"\(list the related cohort uuid\)"}

POST: http://localhost:8080/openmrs/ws/rest/v1/cohortm/

PARAMETERS

{"encounterType":"\(list the related encounterType uuid\)","visit":"\(list the related visit uuid\)","cohort":"\(list the related cohort uuid\)","form":"\(list the related form uuid"\)}

POST: http://localhost:8080/openmrs/ws/rest/v1/cohortm/cohortobs

PARAMETERS:

{"encounterId":"\(list the related encounter uuid\)","concept":"\(list the related concept uuid\)","cohort":"\(list the related cohort uuid\)"}

The min version required for the OpenMRS Core is 1.11.0
The two modules - REST Module of 2.11+ version and HTML Form Entry of 2.5+ version are the required modules.
HTML FORM ENTRY OMOD FILE: https://modules.openmrs.org/#/show/58/htmlformentry
REST MODULE OMOD FILE: https://modules.openmrs.org/#/show/153/webservices-rest
These modules should be running on OpenMRS core before installing the Cohort Module.

User Manual

Potential Improvements:

Integrate it with Reporting Module
- Fetch / add members dynamically from reporting query instead of adding one by one.
- Create reports for cohorts.
Integrate Cohort Management with core OpenMRS
Extend the functionality of HTML Form Entry module for cohorts similar to patients which would require refactoring to allow adding custom tags related to cohorts for more dynamic and complex forms
- The original HTML Form Entry module supports dynamic functionality is saving forms to manage patient related encounters and observations data. In our module, the HTML Form functionality has been slightly extended to save cohort level encounters and observations based on cohort data to allow dynamic functionality in the module. This feature can be extended to maintain the module for cohort level encounters and observations.
- Voiding an encounter will void all the observations associated with that encounter.
- Cohort Module doesn't support Obs Group Component.
- The user can create a HTML form under the Manage HTML Forms tab and then open the HTML form under the module, the form created is viewed.
- The parameters date, location and provider needs to be included in the form and enter the rest of the fields in the form, the cohort encounters and observations related to the form are inserted into the database.
- To know more about HTML Form Entry module click here: HTML Form Entry module

The demonstration has been done on the legacy UI of this module. The current UI has been changed. However, the essential process remains the same.

Downloads and Resources

Source Code (OpenSRP openmrs-module-cohort)
Project Pages: Cohort Module, Cohort Module Enhacements
OpenMRS Talk Discussions
Sharon's GSoC '15 Blog posts
Shreyans' GSoC '16 Blog posts