Page tree
Skip to end of metadata
Go to start of metadata

Overview

The mUzima relationship feature was introduced in mUzima v2.5.0. The relationship feature is used to make an association between two people whose care may be inter-linked or inter-dependent based on the type of association between them. This is an optional feature in mUzima. It be can be enabled or disabled from the server instance (OpenMRS instance being linked to the mobile application). This feature extends OpenMRS relationship functionality to the mUzima mobile application and offers the following adding functionalities in mUzima: 

  • Viewing existing relationships on the mUzima App.
  • Creation of new relationships on the mUzima App.
  • Creation of a new person on the mobile side and set up a new relationship to an existing patient.
  • Conversion of a "Person" to a "Patient" on the mobile side by filling a patient registration form.
  • Sync all payloads to the server to create relationships, persons and register patients created/updated on the mUzima App.

Illustration on Viewing Existing Relationships on mUzima App

  • Relationship settings must be enabled on the OpenMRS mUzima instance.
  • This will enable the downloading of relationships for the clients.
  • Login in to the mUzima App.
  • In this illustration, mUzima App has been set up to  https://demo2.muzima.org/openmrs/login.htm mUzima OpenMRS instance.
  • It will navigate to the Clients as shown below.
  • Tap on an existing patient (the third patient on the list in this example).
  • It will navigate to the Client Summary as shown below.
  •  
  • This client has some relationships already set up.
  • Tap on the the relationship icon as highlighted above.
  • It will navigate to the Relationships details as shown below.
  • In the Relationships details, this patient Jepkemei has two relationships.
  • The first relationship is a Niece/Nephew relationship to person Chege.
  • The second relationship is a patient relationship to patient Maranga.
  • Tap on Maraga Jonathan Kipchoge.
  • It will navigate to the interface below.

Illustration on Creation of New Relationship on The mUzima Mobile App


  • In this illustration, we shall be using a patient who has no existing relationship set up with any patient/person.
  • Login to the mUzima App.
  • You will be navigated to Clients screen.
  • Tap on the second patient on the list by the name Baroret Francis Alaro.
  • It will navigate to the Client Summary page as shown below.
  • Tap on the relationship icon as highlighted above.
  • It will navigate to the Relationships details as shown below.
  • Tap on the Plus icon to add a relationship
  • It will navigate to the interface below.
  • Use the drop-down menu to choose a relationship type and the Edit text field area to Search person by name or identifier as illustrated below.
  • Search the person by name and click Save
  • The new relationship will be created.
  • It will navigate back to the Relationships details as shown below.
  • Click on the entry for Baroret relationship to Jepkemei and you will be navigated to Jepkemei client summary since Jepkemei is a patient.
  • If you tap on relationships for Jepkemei, you will see that Baroret is being listed as a Niece/Nephew as shown below.
  • At this juncture, you need to sync the relationship payload to the server.
  • Navigate to the Complete Form Data under mUzima Forms
  • Click on the upload icon as highlighted.
  • The Relationship payload will be synced to the server.

Illustration on Creation of a New Person on The mUzima Mobile App

  • In this illustration, we shall be using the patient Jepkemei to create a person relationship.
  • Tap on patient Jepkemei to navigate to the Client Summary.
  • Tap on the relationship icon to navigate to the Relationships details  as shown below.
  • Tap on the plus icon to add a relationship.
  • It will navigate to the interface below.
  • Choose sibling as the relationship type 
  • Type the name Kendrick in the edit text field to be searched locally
  • The search does not match any client locally.
  • Tap on SEARCH SERVER
  • This will run a search for the name Kendrick against the mUzima OpenMRS instance.
  • Please wait for the search to complete.  This should not take long.
  • If the name Kendrick does not match any patient on the mUzima OpenMRS instance, the server search results will be returned as follow.
  • Click on CREATE PERSON.
  • A person registration form will be loaded as follows.
  • Fill in the fields on the form.
  • Fields with an asterisks are mandatory.
  • Click on SAVE.
  • You will be navigated back to the Relationship activity.
  • Click SAVE
  • The Patient - person relationship will be created successfully as shown below.
  • At this juncture, you need to sync the relationship payload to the server.
  • Navigate to the Complete Form Data under mUzima Forms
  • Tap on the upload icon as highlighted.
  • The Relationship payload will be synced to the server

Illustration on conversion of a “Person” to a “Patient” on the mobile side by filling a registration form

  • In this illustration, we shall be converting a Person to a Patient by registering the person to become a patient.
  • We shall use the illustration on person Guyo Kendrick created in the previous illustration.
  • The person is listed under patient Jepkemei.
  • Tap on Guyo Kendrick as highlighted below
  • The following dialogue message will appear. 
  • Tap YES
  • It will navigate to a form selection activity.
  • Tap on the mUzima Registration Form as highlighted below. 
  • It will navigate to the mUzima Registration form.
  • Fill in the details for the Person to be registered as a patient.
  • Fields with an asterisks are mandatory.
  • Tap SAVE
  • It will navigate to the Patient Summary.
  • This person has now been converted into a patient.
  • At this juncture, we need to sync the payloads to the server for the patient updated on the mobile App.
  • Navigate to the Complete Form Data tab under mUzima forms
  • Tap on the the upload icon.
  • No labels