Ineligible Structure Marking for Family Module
NOTE: Inactive Structure Marking IS A SEPARATE SCOPING DOCUMENT
Overview
This functionality was requested by the Thai team for Focus Investigation. This is also needed for MDA when the family module is used.
Fields workers should be able to mark a structure as ineligible for household registration, and therefore subsequent tasks should be marked: task.businessStatus = Not Eligible
Responsible Person: | |
Other parties to review/input: | |
FYI: | |
Targeted release date: | |
Jira Status: |
Status
# | Step | Status |
---|---|---|
1 | Responsible prepares rough business analysis/reqs doc | COMPLETE Pierre Dane |
2 | Get CHAI review | COMPLETE: Vivek Agrawal |
3 | ||
4 | Get Ona feedback | IN PROGRESS: Craig Appl |
5 | Responsible - 1 iteration for feedback | |
6 | Ona sign off | |
7 | Ona tech spec scoping | |
8 | Ona LOE | |
9 | Ona scheduling |
Definitions
- Inactive structure: a non-valid structure that was created erroneously and should be removed from play completely (e.g., duplicate residential structure record created by accident)
- This is effectively soft deleting the structure
- Ineligible structure: a valid structure that is ineligible to participate in an intervention for a valid reason (e.g., a residential structure where the inhabitants are not currently residing but may return in the future)
- This is a form field specific to the activity
QUESTION: Should we be marking ineligibility at the household level or at the task level? This document assumes household level but I'm not sure if that is correct.
Requirements
- Users should be able to mark a structure as ineligible during household registration or within the family module for a house already registered
- This should be an option in the household registration form similar to IRS (screenshot below); for a house that has never been registered, eligibility questions should come after inactive qusetions
- Marking the structure as ineligible should turn the structure grey, hide/skip subsequent questions in the form and set all tasks assigned to the structure as Not Eligible
- Any structures that have been marked as ineligible should be removed from the target denominator for the FI (Number of Structures)
- Q: Although this structure will still have been visited and number of structures visited may be a metric
- Typically we would not count ineligible structures in the visited metric as we are most interested in how many eligible structures were visited.
- Any task linked to the structures that have been marked as ineligible should be removed from the target denominator for the FI (Number of Households registered)
- Any subsequent tasks (RACD, bednets etc) that have been marked as ineligible should be removed from the target denominator for the FI (Number of bednets to distribute)
- Q: Although this structure will still have been visited and number of structures visited may be a metric
- A structure cannot be marked ineligible if a household
has been registered, orhas had any tasks associated with it that are not in an initial state (IN_PROGRESS as BusinessStatus?)- Structure may have been previously registered but during this visit the house is ineligible
- A structure cannot be marked as eligible if it has been already marked as ineligible within this plan (this would mean that all tasks would have to be changed from Not Eligible to In Progress - is this valid?)
- If an ineligible structure is clicked/touched a card is displayed indicating that the structure is ineligible with the date it was marked ineligible
- LIFECYCLE: Restricted to the plan. Ineligibility will not persist across interventions (an IRS plan in the same OA will not have the structure marked as ineligible) and ineligibility will not extend to the following FI
- Both enumerated and field-added structures may be marked as ineligible
Workflow
- Workflow to determine a structure is ineligible:
- The user visits the structure seen in the map view of the mobile client and determines that this structure is not eligible for the intervention.
- Tap the structure.
- If no household has been registered:
- First see questions for inactive structure Inactive Structure Marking
- If structure is residential (not inactive), present next questions. Note that if structure is marked as non-residential, it is automatically not eligible for certain interventions and may not reach this stage:
- New field: Is this structure eligible for the intervention?
- Eligible structure
- Ineligible structure
- First see questions for inactive structure Inactive Structure Marking
- If household has been registered
- Tap the three dots in the upper right-hand corner
- Select 'Mark as inelgible for this plan'
- If no household has been registered:
Suggested MVP
Full Workflow specified above
Views:
- Android - Maps - Add a card view for ineligible structures
- Android - Ineligible structure marking form
- Web - Maps - Display ineligible structures in grey in the web view
with ability to toggle on/off - Android - Maps - Add colour coding for ineligible (grey)
- Android - New options in family view to:
- Mark as ineligible for current household (for this intervention i.e. FI)
Suggested not in MVP
View:
- Web - Maps - Ability to show/hide or filter the ineligible structures for a given task view (nice-to-have - will be part of a larger ticket for filtering of task types and statuses) .
Software Requirements Specification
We need to develop the feature for marking residential structures as ineligible when there is a register family task assigned to that structure. This requires changes to the Android client as follows:
- We need to add a field to register family form
Justification
Dependencies
Questions
Notes
- The ability to mark a structure as ineligible is the priority feature - the feature to mark structures as inactive can be developed in a future release and should be created as a separate scoping document (once this document has been completed
- The list of reasons for a structure being ineligible are specific to the intervention
- This will be a form field added in the data dictionary
- Q: How does the form field link to the task status? In some cases could marking a structure as ineligible mean that the task is complete/green?
- As this is for Thailand FI, the immediate use case is to be able to add fields to the household registration form
- We need to provide the ability to update the task status as the first question
- Tasks assigned to OA, location or a person
- Q: Would get into a tricky spot if moving from ineligible to eligible - might be better to create a new register family task. generate a new task for registration?
- Not priority right now - assume this can't be done in this iteration
- If marked a structure as ineligible can you open and see the profile? No - .... what displays/ need to know why on the card.
- Map view only displays high-level tasks
- Register Family - mark structure as ineligible, define post save action, if structure not residential then skip all other fields, post save action will be - if there are tasks, mark these as won't fo/eligible. If there are people registered - what to fo (e.g blood) Maybe cant mark as ineligible
- Can you or cant you mark something as ineligible (Inactive is a mistake - should
- ef have 2 plans, IRS and Focus eligible for one plan and not other, inactive removes structure
Test Case
# | Step | Pass / Fail | Comment |
---|---|---|---|
1 | |||
2 | |||
3 | |||
4 | |||
5 | |||
6 | |||
7 | |||
8 | |||
Additional tester comments: |
This site is no longer maintained. Please visit docs.opensrp.io for current documentation.