Admin Patient Flags Overview

Patient Flags Overview

Table of contents

• Introduction
• App Definition
• How to configure displayed columns
• Default Flags

Introduction

The Patient Flags Overview page allows searching patients tagged by a specific flag.

App Definition

App definition for patient flags overview page must be named cfl.patientFlagsOverview

Definition of app is as follows:

{
    "id": "cfl.patientFlagsOverview",
    "label": "Patient Flags Overview",
    "description": "Patient Flags Overview",
    "extensions": [
      {
        "id": "cfl.patientFlagsOverview",
        "extensionPointId": "org.openmrs.cfl.homepageLink",
        "type": "link",
        "order": 5,
        "label": "Patient Flags Overview",
        "url": "owa/cfl/index.html#/patient-flags-overview",
        "icon": "icon-calendar"
      }
    ]
}

How to configure displayed columns

We can define which columns we want to display on the patient flags overview page. There are 5 predefined values/columns we can display: patient identifier, name, phone number, status and gender. Each of these values have their own valid alias that must be used in the configuration if we want to display such value.

These aliases are: patientIdentifier, patientName, phoneNumber, patientStatus, gender

We can also define labels which will be displayed in the header of the table. Labels can be whatever we want. The whole configuration of table columns must be included in the same app definition (cfl.patientFlagsOverview) in the config -> tableColumns section. Each column definiton consist of a colon separated label text and columns alias e.g. "Identifier":"patientIdentifier".

Here is an example of an app definition with all possible columns configured:

{
    "id": "cfl.patientFlagsOverview",
    "label": "Patient Flags Overview",
    "description": "Patient Flags Overview",
    "extensions": [
      {
        "id": "cfl.patientFlagsOverview",
        "extensionPointId": "org.openmrs.cfl.homepageLink",
        "type": "link",
        "order": 5,
        "label": "Patient Flags Overview",
        "url": "owa/cfl/index.html#/patient-flags-overview",
        "icon": "icon-calendar"
      }
    ],
     "config": {
       "tableColumns": {
         "Identifier":"patientIdentifier",
         "Name":"patientName",
         "Phone number":"phoneNumber",
         "Status":"patientStatus",
         "Gender":"gender"
        }
    }
}

If the 'tableColumns' section is not configured, then all columns will be displayed by default.

Default Flags

Connect for Life currently has following default patient flags:

• Missed last 3 visits - indicates when the patient missed the last 3 visits (in a row)
• Consent pending - indicates when the patient did not consent to receive messages from CfL platform
• Incorrect pincode - indicates when the patient entered incorrect pincode three times during a call