...
Field Name | Input Type | Options / Values | Logic & Validations |
Counselling Date | Date picker | Date | Mandatory. Default: Today. Not > Today. Must be >= Registration date. |
Counselling Officer Name | Auto-filled (read-only) | Logged-in user | Auto-filled from logged-in Counselling Officer account. Read only. |
— PATIENT HEADER (AUTO-FILLED, READ-ONLY) — | |||
Beneficiary Name | Textbox (read-only) | Auto-filled | First Name + Last Name from beneficiary record. |
Beneficiary ID (AMRIT ID) | Textbox (read-only) | Auto-filled | From beneficiary record. |
Nikshay ID | Textbox (read-only) | Auto-filled | From Diagnostics screen. Read only. |
Age / Gender | Textbox (read-only) | Auto-filled | Age (years) and Gender from beneficiary record. |
Diagnosis | Textbox (read-only) | Auto-filled | X-ray Result | Truenat Result | Liquid Culture Result — populated from diagnostic records. Read only. |
SECTION A: DISEASE AWARENESS | |||
TB disease explained to patient | Radio button | Yes/ No | Mandatory. Must be checked before proceeding. Confirms counsellor has explained TB to the patient. |
Transmission route explained | Radio button | Yes/ No | Mandatory. |
Symptoms explained | Radio button | Yes/ No | Mandatory. |
Treatment duration explained | Radio button | Yes/ No | Mandatory. |
Disease awareness notes | Free text | — | Optional. Max 500 chars. |
SECTION B: DO'S AND DON'TS | |||
Cover mouth while coughing — advised | Radio button | Yes/ No | Mandatory. |
Complete full treatment course — advised | Radio button | Yes/ No | Mandatory. |
Regular follow-up attendance — advised | Radio button | Yes/ No | Mandatory. |
Nutritional guidance provided | Radio button | Yes/ No | Mandatory. |
No smoking / alcohol — advised | Radio button | Yes/ No | Mandatory. |
Isolation precautions explained | Radio button | Yes/ No | Mandatory. |
Do's & Don'ts notes | Free text | — | Optional. Max 500 chars. |
SECTION C: GOVERNMENT SCHEMES | |||
Nikshay Poshan Yojana (NPY) eligibility explained | Radio button | Yes/ No | NPY: DBT of Rs. 500/month for duration of treatment. |
DOTS free treatment explained | Radio button | Yes/ No | Confirm patient understands treatment is free under NTEP. |
Schemes notes | Free text | — | Optional. Max 300 chars. |
SECTION D: TREATMENT REGIMEN | |||
Regimen explained to patient | Radio button | Yes/ No | Mandatory. |
Medication names explained | Radio button | Yes/ No | Mandatory. |
Side effects explained | Radio button | Yes/ No | Mandatory. |
Importance of adherence explained | Radio button | Yes/ No | Mandatory. |
Treatment regimen notes | Free text | — | Optional. Max 300 chars. |
SECTION E: COUNSELLING COMPLETION | |||
Counselling completion status | Radio button | Complete | Refused | Mandatory. Make all the above sections obsolete if “Counselling completion status” = “Refused” If Refused → enable 'Reason for refusal' field. |
Reason for refusal | Free text | — | Mandatory if Counselling status = Refused. Max 300 chars. |
Counsellor remarks | Free text | — | Optional. Max 500 chars. |
SECTION E: Follow Up to TU | To be done within 15 days Editable | ||
Has the patient started the prescribed TB treatment regimen? | Radio button | Yes/ No | If No is selected, then enable “Reason for not starting the prescribed TB treatment regimen” |
Reason for not starting the prescribed TB treatment regimen | Free text | To be enabled if “Has the patient started the prescribed TB treatment regimen” = “No” Up to 500 characteristics | |
Has the patient visited the DOTS centre / referred health facility for treatment collection? | Radio button | Yes/ No | |
Has the patient reported side effects to the treating doctor or DOTS centre? | Radio button | Yes/ No | |
Submit | Button | — | Save counselling record. If status = Complete → Nikshay record updated; case marked 'Counselled'. |
7.3 Confirmed TB Cases — Treatment & Follow-Up
This screen manages treatment initiation and ongoing follow-up for beneficiaries confirmed as TB positive via Digital Chest X-ray, Truenat, or Liquid Culture.
...
Field Name | Field Type | Options / Values | Validation / Logic / Condition |
Regimen Type | Radio button | 1.DS-TB (6 Months) 2.Shorter Regimen (9–12 Months) 3.Longer Regimen (18–24 Months) 4.BPaL Regimen (6 Months) 5.INH Mono (6 Month) | · If DS-TB (6 Months) selected → open TPT module. · Alert volunteer to screen all household members / contacts if DS-TB case is selected. |
Treatment Start Date | Date picker | Date | · Mandatory. Must be >= TB Identification and Diagnosis Visit Date. Not greater than Today's Date. |
Expected Treatment Completion Date | Label (read-only) | Auto-calculated | 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 SECTION — | |||
Follow-up Date | Date picker | Date | · Greater than or equal to Treatment Start Date or greater than Last Follow up Date · Mandatory · Minimum date is Treatment Start Date · Accept date greater than Last Follow up Date · Allow 1 Follow up visit in a month (i.e. monthly 1 Follow up) · Not greater than Today's Date |
Monthly follow-up done | Label (read-only) | Month-1 to Month-24 | Incremental based on monthly follow-up visits completed. |
Adherence to Medicines | Radio button | Regular | Irregular | — |
Any discomfort | Radio button | Yes | No | — |
— TREATMENT COMPLETION SECTION — | |||
Did the patient complete the full course of treatment? | Radio button | Yes | No | 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 | Date | Enabled if 'Yes' selected above. Must be > Last Follow-up Date. |
TB Treatment Outcomes | Dropdown | Cured | Failed | Lost to Follow-up (LFU) | Death | If Death selected → update Beneficiary Status = Death in Beneficiary record; Enable Date of Death, Place of Death, and Reason for Death fields. |
Date of Death | Date picker | Date | Enable only if TB Treatment Outcomes = Death. Mandatory if enabled. Default: null. Not greater than Today's Date. >= Treatment Start Date or > Last Follow-up Date. |
Place of Death | Dropdown | Home | Subcenter | PHC | CHC | District Hospital | Medical College Hospital | Private Hospital | Other Place | Enable only if TB Treatment Outcomes = Death. |
Reason for Death | Label (read-only) | Tuberculosis | Enable only if TB Treatment Outcomes = Death. Pre-filled as 'Tuberculosis'. Read only. |
Reason for non-completion of treatment | Textbox | Free text | Enable if 'No' selected for 'Did the patient complete full treatment?' |
Capture Geolocation | Auto capture | — | Capture current location: latitude, longitude, address. |
Submit | Button | — | Save record. |
Follow-up visit history | Table (read-only) | — | Maintain and display complete follow-up visit history. |
...
7.
...
4 TB Preventive Treatment (TPT) Module
- TPT is preventive treatment given to close contacts of confirmed Drug-Sensitive TB (DS-TB) cases who are at high risk of developing active TB.
- This module opens when in the Confirmed TB Cases module, Regimen Type = 'DS-TB (6 months)'.
- The module must be editable — after referral of the contact for diagnostic tests, the volunteer enters further details once tests are completed.
- 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.
...
7.
...
4.1 Household Contact Line Listing Screen
Field Name | Field Type | Options / Values | Validation / Logic / Condition |
Name of the contact | Text Box | Free text | — |
Age of the contact | Number input | Numeric | — |
Gender | Dropdown | Male | Female | Transgender | Prefer not to say | Mandatory. Speech-to-text feature enabled. |
Mobile Number | Number | Numeric | Optional. Speech-to-text feature enabled. |
TPT Screening Status | Radio / Dropdown | Not Started | Pending | Completed | Mandatory. Single selection. Default: Pending. |
Referral Facility for screening | Radio / Dropdown | HWC | PHC | CHC | District Hospital | Mandatory. Single selection. From here volunteer can go directly to Submit as contact must first get tested. |
Screening done at the referral facility | Radio | Yes | No | Mandatory. |
Is it confirmed TB case | Radio | Yes | No | If Yes → move card to Confirmed TB list. If No → continue ahead. |
Are you advised to take TPT | Radio | Yes | No | If Yes → continue to next field. If No → go directly to Submit. |
TPT initiated | Radio | Yes | No | Mandatory. Enable next fields if Yes. |
TPT start date | Date picker | <= Today's date | Mandatory if enabled. Cannot be future date. Cannot be before date of screening. |
Treatment duration of TPT | Radio / Dropdown | 1 Month | 3 months | 6 months | — |
Expected completion date | Date (read-only) | Auto-calculated | Auto-calculated = TPT start date + regimen duration. Non-editable. |
Follow-up visit number | Numeric (read-only) | Auto-increment (1–6) | Non-editable. Automatically calculated by system. |
Follow-up visit date | Date picker | <= Today's date | Mandatory if enabled. Cannot be future date. Cannot be before TPT start date. |
TPT completion status | Radio / Dropdown | Completed Incomplete Lost to follow-up Developed active TB during TPT Died during TPT Other | Mandatory. If 'Completed' → enable Date of completion field. If 'Developed active TB during TPT' → redirect volunteer to create new TB Suspected Case record and close this TPT case. If 'Died during TPT' → enable Date of death and Cause of death fields. |
Other | Free text | — | — |
Date of completion | Date picker | <= Today's date | Mandatory if TPT completion status = Completed. Cannot be future date. |
Date of death | Date picker | Date | Enabled if TPT completion status = Died during TPT. Mandatory if enabled. |
Cause of death | Free text | — | Enabled if TPT completion status = Died during TPT. Mandatory if enabled. |
Capture Geolocation | Auto capture | — | Capture current location: latitude, longitude, address. |
Submit | Button | — | Save record. |
...
AC-REF-03: Given Random Blood Sugar >= 100 mg/dl is entered in General Examination, When the examination is submitted, Then the beneficiary appears in the HWC Referral list with Referral Trigger = 'High RBS: [value] mg/dl'.
9. Dashboard — Home Page Dashboard Tab
- Landing page has 2 tabs: Home and Dashboard. The Dashboard tab flips to the analytics view.
- Two filter options are provided at the top of the Dashboard:
- Time Period: Dropdown — Today / January / February / March / April / May / June / July / August / September / October / November / December
- Village Name: Dropdown — populated with village/hamlet names
- All dashboard indicators auto-populate based on the filter selected.
- Total numbers shown in bold; sex-disaggregated data shown for each card.
Dashboard Card | Colour | Breakdown Required | Logic / Condition |
Total TB Screenings (Total Positives / Negatives) | Yellow card | Male — Positives / Negatives Female — Positives / Negatives Children (<15 yrs) — Positives / Negatives Others | Auto-populate based on filter selected. Total shown in bold. |
Total TB Suspected Cases (Total Positives / Negatives) | Yellow card | Male — Positives / Negatives Female — Positives / Negatives Children (<15 yrs) — Positives / Negatives Others | Auto-populate based on filter selected. Total shown in bold. |
Total TB Confirmed Cases (Total Positives / Negatives) | Yellow card | Male — Positives / Negatives Female — Positives / Negatives Children (<15 yrs) — Positives / Negatives Others | Auto-populate based on filter selected. Total shown in bold. |
Total Digital Chest X-Rays conducted (Total Positives / Negatives) | — | Male — Positive / Negative Female — Positive / Negative Children (<15 yrs) — Positives / Negatives Others Age >= 60 years — Positives / Negatives | Auto-populate based on filter selected. Total shown in bold. |
Total Sputum collections conducted (Total Positives / Negatives) | — | Male — Positives / Negatives Female — Positives / Negatives Children (<15 yrs) — Positives / Negatives Others Age >= 60 years — Positives / Negatives | Auto-populate based on filter selected. Total shown in bold. |
Total Truenat tests conducted | — | Male — Positives / Negatives Female — Positives / Negatives Children (<15 yrs) — Positives / Negatives Others Age >= 60 years — Positives / Negatives | Auto-populate based on filter selected. Total shown in bold. |
Total sputum samples sent for liquid culture | — | Male — Positives / Negatives Female — Positives / Negatives Children (<15 yrs) — Positives / Negatives Others Age >= 60 years — Positives / Negatives | Auto-populate based on filter selected. Total shown in bold. |
Total cases referred to Health and Wellness Centres | — | Male Female Children (<15 yrs) Others Age >= 60 years | Auto-populate based on filter selected. Total shown in bold. |
NIKSHAY IDs | Yellow card | Total count | Total number of Nikshay IDs created in selected time period or village. |
ABHA IDs | Yellow card | Total count | Total number of ABHA IDs created in selected time period or village. |
Role-Based Access Control (RBAC)
Role | Modules Accessible | Write Access | Read Access | Cannot Access |
Registration Officer | Registration, Anthropometry | Registration, Anthropometry data for own camp | Own records | All Nurse, Counselling, Diagnostic, and Admin screens |
Nurse | General Examination, TB Screening, General OPD, Diagnostics Screen | All Nurse module data | Registration + Anthropometry data | Confirmed TB Cases (write); Counselling; Admin panel |
Counselling Officer | Confirmed TB Cases, Counselling, TPT / Household Contact Line Listing | Counselling data, Treatment initiation, Follow-up | Confirmed TB case data, Line list | Registration, Nurse modules (write); Admin panel |
Admin / NTEP / STOP TB | Full Dashboard, Reports, All modules (read), Configuration | Configuration, User management | All data — district and national level | full access |
...