PRD for STOP TB Community Screening
1. Document Overview
This document defines the functional requirements for the TB Screening mobile application developed under the TB Mukt Janjati Abhiyan: A community-driven TB elimination initiative targeting tribal populations across India. The application is purpose-built for field use by community volunteers in tribal areas where connectivity, literacy, and device familiarity may be limited.
The application should be simple to use, comprehensive and must work in low/no-connectivity environments.
1.1 Purpose
This application is developed to screen and maximize TB case detection in all age groups through active case finding, contact investigation, and community mobilization. This application helps in patient tracking throughout treatment cascade at community and facility level via Community Influencers and Nikshay Mitras. Ensure prompt referral and linkage of diagnosed individuals from community to health facilities for timely treatment initiation is the purpose of this application.
1.2 Users of the system
1. Volunteers- Community mobilization, screenings, camps etc.
2. Admin / Supervisory- Backend/Dashboard Access
1.3 In Scope Functional Modules
| TB Screening modules | Enlisted in the PRD |
| NCD Screening modules | Enlisted in the PRD |
| Nikshay integration | External dependency |
| Integration of AI assessment tool (Cough) | External technical dependency |
| Lab testing device integration (sputum testing) | External technical dependency |
| Integration of AI enabled hand- held chest Xray (digital) | External technical dependency |
Dashboard indicators | |
Pre Camp Work Plan Preparation Module | Subjected to requirement |
1.4 Workflow
2. Login Page
- Login Page Name should be "NikshayMitra Application".
- It must be followed by "NikshayMitra" Logo.
- It must have both Online and Offline capabilities. ("Offline capabilities feature to exchange data between Mobile devices in a closed environment in real-time without internet")
- It must have Multilingual Feature with English, Hindi and other Indian languages enabled, and must be configurable to accommodate all the Indian languages as and when required in future.
UI Field Name
Field Type
Options
Validations
"NikshayMitra Application" Logo
<Placeholder>
Please Select your Language
Radio Button
- English
- Hindi
- The fields and labels must populate in the language selected by the user
Username
Textbox
Password
Textbox
Remember Me
Checkbox
- When 'Remember Me' checkbox is selected, next time directly allow user to login just by authenticating with fingerprint
Powered by Piramal Foundation
Text
- Display on the bottom of the screen
2.1 Landing page
- This page must have a hamburger icon (side drawer), "NikshayMitra" text, sync button, and "Language Translation" button on the Top row.
- There should be a hamburger icon on the left side, which on clicking should have following details-
- Full Name (User)
- Username
- Sync Records
- Create ABHA ID
- Support
- Request to delete account
- Log out
- Landing page should have 2 tabs- "Home" and "Dashboard".
- In home tab floating "Registration" button on the right bottom corner.
2.2 Home Page- "Home tab"
- Should contain four modules/ Cards- All Beneficiaries, TB screening, NCD screening, Referrals written on these cards.
- On clicking "All Beneficiaries" card- open the "Beneficiary module" form documented below (section 2.2.1) for registering the beneficiary by giving the floating "Registration" button in the right corner.
- On clicking "TB" card- open the "Tuberculosis module" (section 2.2.2). On clicking the next screen, it should have 3 cards titled "TB Screening", "Suspected TB cases" and ""Confirmed TB cases".
- On clicking "NCD" card- open the "Non Communicable Disease (NCD) module" (section 2.2.3). On clicking the next screen, it should have 3 cards titled "NCD eligible list", "NCD priority list", and "NCD non-priority list".
- On clicking "Referrals"- This should show the line listing of cases/ patients (TB+NCD) when they are referred to health facilities for further check up.
2.2.1 Module - Beneficiary Registration
- On clicking Registration button the user will be navigated to Beneficiary Registration Page
- Show a pop up for Consent form "I have been explained, the purpose for which the information and findings is being collected from me, in a language I understand and I give my consent to collect the information and findings on my personal health profile."
- This page has "All Beneficiaries" Text displayed on top with "Home" Icon on the right corner to Navigate to Home page in the 1st row
- The card below should be visible after the registration of beneficiary.
- If the beneficiary does not have ABHA ID, give one clickable button on the ABHA ID area of the card to initiate ABHA ID generation.
Photo of the beneficiary | Name | Beneficiary ID |
Age (Years) | Village Name- | |
Phone Number | ABHA ID (ABHA registration)- Clickable |
Field Name | Field Type | Value/ Options | Validation/ Logic |
Date of registration | Should be auto selected and updated when the volunteer logs in the application to do the screening. | ||
Photo | Camera | Optional |
|
First Name | Text |
| |
Last Name |
| ||
Beneficiary Status | Radio Button | · Alive · Death | · Enable only in the “Edit” Beneficiary screen · Auto-populate, if ‘Death’ is reported from any module (eg: Tuberculosis) · Default value is “Alive” · If “Death” is selected, enable below four fields and mark it mandatory- 1. Date of Death 2. Time of Death 3. Reason for Death 4. Place of Death or Other Place of Death |
Date of Death | Date picker | · Enable if “Beneficiary status”= “Death” · Mandatory if enabled · By default, date is null · Not greater than Today’s Date · Accept ‘Date of Death’ after date of registration · Auto-populate, if ‘Death’ is reported from any module (eg: Tuberculosis) | |
Time of Death | Time picker | · Show only if above value is “Death” · Optional | |
Reason for Death (Type of Death) | · Maternal Death · Natural Death · Accident · Infectious Disease · Animal Bite Death · Suicide · Undetermined | · Enable if “Beneficiary status”= “Death” · Mandatory if enabled
| |
Place of Death |
| · Enable if “Beneficiary status”= “Death” · Mandatory if enabled
| |
Other Place of Death | Textbox |
| |
Age | Number (Years) |
| |
Date of Birth | Date Picker |
| |
Gender | Dropdown |
|
|
Mobile Number | Number |
| |
Village/ Hamlet | dropdown | ||
Marital Status | radio button |
|
|
Husband's/ Wife's Name | Textbox |
| |
Father's Name | Textbox |
| |
Mother's Name | Textbox |
| |
Community | radio button |
|
|
Religion | radio button |
|
|
Economic Status | radio button |
| |
Type of Residential area | radio button |
| |
Other Type of Residential area | Textbox |
| |
Occupation |
| ||
Cancel | Button |
|
|
Capture Geolocation |
| ||
Submit |
|
Lists Sections
Different types of lists are created based on the beneficiary registrations. These are defined in the following data fields: "Age" and "CBAC Score".
- All Beneficiaries List- Should be visible in "All beneficiaries" and "TB Screening" modules.
- NCD Eligible List: All Beneficiary both Male and Female whose age > = 30 years and excluding Pregnant Women; with CBAC Form access.
- NCD Priority List: Beneficiary age > = 30 years and CBAC assessment score is greater than 4
- NCD Non-Eligible List: Beneficiary age > = 30 years and CBAC assessment score is less or equals to 4
2.2.2 Module- Tuberculosis
2.2.2.a TB Screening
In this section show all beneficiaries irrespective of any age group and gender.
Maintain a separate list for TB Suspected cases for further follow-ups.
TB Screening |
|
|
|
* If "Yes" is selected for any one of the questions below with "*" auto select "yes" for "Referral Required." Show these beneficiaries to 'Suspected TB cases' section Show these beneficiaries to 'Referral list module in the Home' section |
|
|
|
** If "Yes" is selected for any one of the questions below with "**" "Refer to the nearest health facility and collect the Sputum sample". Show these beneficiaries to 'Referral list module in the Home' section Screen all the family members and contacts of the |
|
|
|
Date | Calendar | Is Mandatory |
|
Symptomatic Screening |
| ||
Coughing More than 2 weeks * | radio button |
|
|
Blood in Sputum * | radio button |
|
|
Fever > 2 weeks * | radio button |
|
|
Rise of fever in evening* | radio button |
|
|
Loss of Appetite* | radio button |
|
|
Loss of Weight * | radio button |
|
|
Night Sweats * | radio button |
|
|
History of TB * | radio button |
|
|
Are you currently taking Anti TB drugs ** | radio button |
|
|
Anyone in Family Currently Suffering from TB ** | radio button |
|
|
Asymptomatic Screening |
|
|
|
Age more than 60 | radio button |
|
|
Diabetic | radio button |
|
|
Tobacco user | radio button |
|
|
BMI < 18.5 | radio button |
| Validation?? As we are not taking height and weight? |
Contact with TB patient on treatment | radio button |
|
|
Last 5 years history of TB | radio button |
|
|
Referral Required | radio button |
| |
Referral to |
|
|
|
Capture Geolocation |
| ||
Submit | Button |
|
|
2.2.2.b Suspected TB cases
This section should contain only Suspected TB cases.
Name of data Field | Field Type | Value/ Options | Validation/ Logic/ Condition |
Date | Calendar | Mandatory |
|
Name | Textbox |
| Auto fill from Beneficiary details |
Age | Textbox |
| Auto fill from Beneficiary details |
Gender | Textbox |
| Auto fill from Beneficiary details |
Symptomatic TB |
| To be enabled if "Yes" is selected in any "Symptomatic Screening fields" | |
Is Sputum sample collected? | radio button |
|
|
Sputum sample submitted at | radio button |
|
|
Sputum Test result | radio button |
|
|
Asymptomatic TB |
|
| To be enabled if "Yes" is selected in any "Asymptomatic Screening fields" |
TB Chest X-Ray Test done |
|
|
|
Chest X-Ray Test Result |
|
|
|
Nikshay ID | Textbox |
|
|
Type of suspected TB case | Radio button |
|
|
Reason for suspected TB case | Dropdown |
|
|
Other | textbox |
| |
Has the diagnosis of DR-TB been confirmed? | Radio button |
|
|
Capture Geolocation |
| ||
Submit | Button |
|
|
2.2.2.c Confirmed TB cases
Treatment and follow up of TB confirmed cases.
Name of Data Field | Field Type | Value/ Options | Validation/ Logic/ Condition |
Regimen Type | Radio button |
| Open module 2.2.2.d (TPT- TB Prevention treatment) module if “DS-TB (6 Months)” is selected Alert to Volunteer to screen all household members/ Contacts if DS-TB case is selected.
|
Treatment Start Date | Date picker
| Mandatory |
|
Expected Treatment Completion Date | Label | Read only | Auto calculate this date based on below condition form ‘Treatment Start Date’: 1. If ‘Regimen Type’ is “1”, “4”, “5” then add 6 months 2. If ‘Regimen Type’ is “2”, then, Treatment duration is 9–12 months (show 9–12 range dates) 3. If ‘Regimen Type’ is “3”, then, Treatment duration is 18–24 months (show 18–24 range dates) |
Follow-up & Adherence | |||
Follow up Date | Date picker
| Mandatory |
|
Monthly follow up done | Label | Month-1 to Month-24 |
|
Adherence to Medicines | Radio button |
|
|
Any discomfort | Radio button |
|
|
Treatment Completion | |||
Did the patient complete the full course of treatment? | Radio button |
| Enable these below filed based on below conditions: 1. If ‘Regimen Type’ is “1”, “4”, “5” then enable after 5 Monthly follow up visits 2. If ‘Regimen Type’ is “2”, then enable after 9 Monthly follow up visits 3. If ‘Regimen Type’ is “3”, then enable after 18 Monthly follow up visits |
Actual Treatment Completion Date | Date picker |
|
|
TB Treatment outcomes | Dropdown |
| If "Death" is selected, update 'Beneficiary Status' = "Death" in the Beneficiary record, with “Date of Death”, "Place of Death" and "Reason for Death” in the next fields. |
Date of Death | Date picker |
|
|
Place of Death | Dropdown |
| Enable only if "TB Treatment outcomes" = “Death” |
Reason for Death | Label Read only | Tuberculosis | Enable only if "TB Treatment outcomes" = “Death” |
Reason for non completion of treatment | Textbox |
| Enable this field if “No” selected for “Did the patient complete full treatment?” |
Capture Geolocation |
| ||
Submit | button |
|
|
Follow up visit history | Table |
| Maintain a Follow up visit history of Visit |
2.2.2.d Tuberculosis Preventive Treatment
Tuberculosis Preventive Treatment (TPT)
- TPT is the preventive treatment given to close contacts of confirmed Drug-Sensitive TB (DS-TB) cases who are at high risk of developing active TB.
- If a contact tests positive for active TB at any step (X-Ray or Sputum positive), the system must immediately redirect the volunteer to create a new TB Suspected Case record for that contact — bypassing the TPT flow.
- This module should open when in Confirmed TB case module, “Regimen type” = “DS-TB (6 months)”
- Make this module editable as after referral of the contact for diagnostic tests, volunteer needs to enter further details once the tests are done.
Household Contact Line listing Screen-
Name of data field | Field Type | Value/ Options | Validation/ logic/ condition |
Name of the contact | Text Box |
| |
Age of the contact |
| ||
Gender | Dropdown |
|
|
Mobile Number | Number |
| |
TPT (TB Preventive Treatment) Screening Status |
|
|
|
Referral Facility for screening |
|
|
|
Screening done at the referral facility |
|
|
|
Is it confirmed TB case |
|
|
|
Are you advised to take (TPT) |
|
|
|
TPT initiated |
|
|
|
TPT start date | Date picker | =<Today’s date |
|
Treatment duration of TPT |
|
|
|
Expected completion date | date |
|
|
Follow up visit number | Numeric |
|
|
Follow up visit date | Date picker | =<Today’s date |
|
TPT completion status |
|
|
|
Other | Free text | ||
Date of completion | Date picker | =<Today’s date |
|
Date of death | Date picker |
|
|
Cause of death | Free text |
|
|
Capture Geolocation |
| ||
Submit |
|
|
|
2.2.3 Module- Non Communicable Disease (NCD) Screening
Note: The common questions in CBAC Part B1 and TB screening form, if either of the form is filled and submitted first, then responses in the other form should be automatically selected.
Community Based Assessment Checklist (CBAC) Form
NCD (Non-Communicable Diseases) Eligible List:
Show all Beneficiary both Male and Female whose age > = 30 years and excluding Pregnant Women.
And this CBAC Form is applicable to screen these Beneficiaries.
This CBAC Form, assessment check should be done yearly once, Maintain the history of submitted CBAC Form for viewing, year wise
Name of Data Field | Field Type | Value/ Options | Validation/ Logic/ Condition |
CBAC Form |
|
|
|
Date | Calendar |
|
|
Name | Textbox |
| Auto fill from Beneficiary details |
Age | Textbox |
| Auto fill from Beneficiary details |
Sex | Textbox |
| Auto fill from Beneficiary details |
Part A: Risk Assessment |
|
|
|
What is your Age? (in Age) | radio button | Is Mandatory
| Auto-populate Age from 'Beneficiary' registration: |
Do you smoke or consume smokeless products such as gutka or khaini | radio button | Is Mandatory
| Score Logic: |
Do you consume alcohol daily | radio button | Is Mandatory
| Score Logic: |
Measurement of Waist (in cm) | radio button | Is Mandatory
| Score Logic: |
Do you under take any physical activity for minimum of 150 minutes in a week | radio button | Is Mandatory
| Score Logic: |
Do you have any family history (any one of your parents or siblings) of high BP / Diabetes / Heart Disease | radio button | Is Mandatory
| Score Logic: |
Total Score | Label |
| Total Score Formula: |
Part B1: Early Detection |
|
|
|
If "Yes" is selected below then display a pop-up message, "Suspected NCD case, please visit nearest HWC or call 104." |
|
|
|
* If "Yes" is selected for any one of the questions below with "*" then show a pop-up message "Refer to MO and collect the Sputum sample" |
|
|
|
** If "Yes" is selected for any one of the questions below with "**" then show a pop-up message "Refer to MO or inform ANM/MPW to tracing of all family members" |
|
|
|
Shortness of Breath | radio button | Is Mandatory
|
|
Coughing More than 2 weeks * | radio button | Is Mandatory
|
|
Blood in Sputum * | radio button | Is Mandatory
|
|
Fever > 2 weeks * | radio button | Is Mandatory
|
|
Loss of Weight * | radio button | Is Mandatory
|
|
Night Sweats * | radio button | Is Mandatory
|
|
Are you currently taking Anti TB drugs ** | radio button | Is Mandatory
|
|
Anyone in Family Currently Suffering from TB ** | radio button | Is Mandatory
|
|
History of TB * | radio button | Is Mandatory
|
|
Recurrent of ulceration on Palm or Sole | radio button | Is Mandatory
|
|
Recurrent of tingling on Palm or Sole | radio button | Is Mandatory
|
|
Cloudy or Blurred Vision | radio button | Is Mandatory
|
|
Difficulty in reading | radio button | Is Mandatory
|
|
Pain in eyes lasting for more than weeks | radio button | Is Mandatory
|
|
Redness in eyes for more than weeks | radio button | Is Mandatory
|
|
Difficulty in Hearing | radio button | Is Mandatory
|
|
History of Fits | radio button | Is Mandatory
|
|
Difficulty in Opening Mouth | radio button | Is Mandatory
|
|
Ulcers in Mouth Not Healed in 2 weeks | radio button | Is Mandatory
|
|
Growth in Mouth Not Healed in 2 weeks | radio button | Is Mandatory |
|
Any white or red Patch in Mouth Not Healed in 2 weeks | radio button | Is Mandatory
|
|
Pain while chewing | radio button | Is Mandatory
|
|
Any change in Tone of Voice | radio button | Is Mandatory
|
|
Any hypo pigmented patches or discolour lesions with loss of sensation | radio button | Is Mandatory
|
|
Any thickened skin | radio button | Is Mandatory
|
|
Any nodules skin | radio button | Is Mandatory
|
|
Any Patch or Discoloration on Skin | radio button | Is Mandatory
|
|
Recurrent numbness on palm or sole | radio button | Is Mandatory
|
|
Clawing of fingers in hand or feet | radio button | Is Mandatory
|
|
Tingling and numbness in hand / or feet | radio button | Is Mandatory
|
|
Inability to close eye lid | radio button | Is Mandatory
|
|
Difficulty in Holding Objects in hands or Fingers | radio button | Is Mandatory
|
|
Weakness in feet that cause difficulty in walking | radio button | Is Mandatory
|
|
Part B2: Women Only |
|
|
|
Lump in the Breast | radio button | Is Mandatory
|
|
Bleeding after Menopause | radio button | Is Mandatory
| If option selected is "Yes" then display "Inform ASHA Facilitator." |
Blood Stained Discharge from the Nipple | radio button | Is Mandatory
|
|
Bleeding after intercourse | radio button | Is Mandatory
|
|
Part B3: Elderly Specific |
|
|
|
Feeling unsteady while standing or walking | radio button | Is Mandatory
| If option selected is "Yes" then display "Send the patient to MOIC of nearest health center for treatment " |
Suffering from any physical disability that restrict movement | radio button | Is Mandatory
| If option selected is "Yes" then display "Send the patient to MOIC of nearest health center for treatment " |
Needing help from others to perform every day activities such as eating, getting dressed, grooming, bathing, walking, or using the toilets | radio button | Is Mandatory
| If option selected is "Yes" then display "Send the patient to MOIC of nearest health center for treatment " |
Forgetting names of yours, near ones or your own home address | radio button | Is Mandatory
| If option selected is "Yes" then display "Send the patient to MOIC of nearest health center for treatment " |
Part C: Risk factor for COPD |
|
|
|
Type of Fuel Used for Cooking | radio button | Choose: |
|
Occupational Exposure | radio button | Choose: |
|
Part D: PHQ2 |
|
|
|
Over the last two weeks bothered by the following problem? |
|
|
|
Little interest or pleasure in doing things? | radio button | Choose:
| Score Logic: |
Feeling down, depressed or hopeless? | radio button | Choose:
| Score Logic: |
Total Score | Label |
| Total Score formula: Sum of all the above score |
Capture Geolocation |
| ||
Submit |
|
|
|
2.2.4 Module - Referrals
This module should contain the list of names/ cases referred to health facilities.
2.3 Home Page- Dashboard
- Flip feature between "Home" and "Dashboard".
- Put a field for filter with 2 selection options-
- Time Period- based on "today and previous months" This filter should show all the data cards in the dashboard pertaining to the time period selected. (eg: today, Jan, Feb etc)
- Village Name- Dropdown options to be populated with names of village/ hamlets
- Module cards should be placed below the filter selection option.
Field Name | Field Type | Options | Validation |
Filter/ Selection option | Dropdown | The Dropdown Values are
| If this filter is selected, then show all the values of the dashboard indicators pertaining to the time period selected. |
Filter/ Selection option | Dropdown | Village/ Hamlet names to be put here | If this filter is selected, then show all the values of the dashboard indicators pertaining to the particular village selected. |
Total TB screenings | Card must be yellow in colour | It must auto populate based on the filter selected. | |
Total TB suspected cases | Card must be yellow in colour | It must auto populate based on the filter selected. | |
Total TB confirmed cases | Card must be yellow in colour | It must auto populate based on the filter selected. | |
NIKSHAY IDs | Card must be yellow in colour | Total number of NIKSHAY IDs made in the selected time period or Village | |
ABHA IDs | Card must be yellow in colour | Total number of ABHA IDs made in the selected time period or Village |

