Table Of Contents
Scoping Details | |
---|---|
Responsible Person: | |
Other parties to review/input: | |
FYI: | |
Targeted release date: | 31st July 2019 |
Jira Status: |
The responsible person owns this feature from scoping to tracking development by Ona and providing clarifications if needed, to testing and sign off. Status
Status
# | Step | Status |
---|---|---|
1 | Responsible prepares rough business analysis/reqs doc | COMPLETE Pierre Dane |
2 | Get CHAI review | COMPLETE Vivek Agrawal |
3 | Get Akros Review | COMPLETE Christina Riley |
4 | Get Ona feedback | COMPLETE Craig Appl |
5 | Responsible - 1 iteration for feedback | COMPLETE Pierre Dane |
6 | Ona sign off | COMPLETE Craig Appl |
7 | Ona tech spec scoping | COMPLETE Craig Appl |
8 | Ona LOE | |
9 | Ona scheduling |
Definitions
A Potential Area of Transmission (PAOT) can be a variety of things:
- It can be in close proximity to a mosquito collection point, larval dipping site or a structure
- It can be within or outside of an operational area
- It can be a distinct thing next to a residential structure
- Identifying PAOTs is part of the Thai protocol and is currently done on hand-drawn maps
- Dropping a point for or editing a potential area of Transmission should not be restricted by GPS proximity
Functional Requirements
- OVERVIEW: A user should be able to add an icon (TBD) to the Reveal Android map showing a Potential Area of Transmission (PAOT).
- FORM FIELDS: The user should be able to add a comment to the PAOT form (not mandatory) - maximum string size tbc (2000 chars? this should be the same as other comment fields in Reveal)
specify the type of PAOT from a drop-down (list to be provided - 'Pond, Cave, Forest) (Pedro Pagalday Olivares to confirm this please) - FORM FIELDS:
- The comment field (task/form) should be editable Craig Appl - can you verify that each time this data is saved that a new form is submitted to the server (same data workflow as mosq collection point & larval dipping).
- The date that the PAOT was recorded should be recorded and displayed on the card view
- We should be able to see a historical view of the comments & dates recorded as a PAOT in the web UI & supersets.(low priority)
- REQUIREDNESS: It is not mandatory to add a PAOT to a focus
- LIFECYCLE: The PAOT will persist across subsequent FI, but should be able to be removed (set to inactive) I.e. they do not expire
- LIFECYCLE: The addition of a PAOT to a focus area will, in general, be a .once off task performed during the first visit
- USAGE: The PAOT data should be synced to the Reveal WebUI and be visible in the Web UI maps (high priority)
- USAGE: The PAOT data should be as a line listing reports (to be mocked up) (low priority) - the comment should display when clicking the PAOT icon in the WebUI
- USAGE: The PAOT should be synced to Biophics in the same way that other tasks are (high priority) - this is where the BVBD will analyse the data
- PLANNING:
The PAOT activity will not be part of a plan activity←Changed this on 18 July | We will generate plan actions and goals to visit any existing PAOT and update the information in the system. - TASK STATUS: The PAOT can be coulored yellow when it is created:
- Once selected and the comment field is filled out, the color will turn to green for status of 'Completed'.
- LINKAGE: One focus area can have multiple PAOTs
- LINKAGE: The PAOT is associated to a focus area and not explicitly to an Index Case. This linkage can be assumed through the 1:1 mapping of focus area and index case per plan. However, the PAOT is not necessarily related to the index or secondary cases in the focus i.e. it is A a potential area of transmission, not THE potential area of transmission for the cases in the focus at that time.
- EDGE CASE: A PAOT is NEVER another type of structure, and if a structure is identified as a potential source then a PAOT should be added alongside the existing structure
- A potential issue raised is what happens with very large structures (Markets, football fields) as PAOT cannot be dropped on top of this - Vivek confirmed that this was discussed with BVBD and placing a pit next to the structure with a comment is sufficient
Software Specification
This section defines the software development that needs to take place in order to deliver this feature.
Assumptions
This section defines the assumptions required for this new feature.
- Comments from Potential Areas of Transmission are plan specific. We will not transfer comments from one plan to the next.
- Tasks for PAOTs need to be defined per plan. If a new plan is generated, we need to generate new tasks for existing PAOTs based on the actions that are defined in that plan.
Android Client
Assumptions
- Tasks assigned to these points do not need to be displayed in the task list view. They are only required in the map view.
Development Required
- Update the register structure form to include a new Potential Area of Transmission (Data dictionary link)
- Add a PAOT form in English and Thai (Data dictionary link)
- If the status of the PAOT changes from "Active" to "Inactive" the post save action will make this point inactive in the location and sync the updated location to the server
- Add a PAOT client to the EC data model
- Add a card view to display the new PAOT
- This card view should have the following attributes:
Title: Potential Area of Transmission
Icon: Should be the icon of the area of transmission
Field 1: "Last Updated Date" (form variable name = lastUpdatedDate)
Button with Label: Edit PAOT Details
Button Action: Open a form to edit the existing information that has been captured. We need to retain a copy of all comments and allow the user to add to the comments
- This card view should have the following attributes:
- Add a new icon type to the Android client and support the colour coding as defined in the Task business logic and colour coding section of this document
- Add the ability to edit the existing form in the system when the user completes it saving the comment history and updating the lastUpdatedDate field each time the form is edited.
Server and Web UI
Assumptions
- These points need to display in the map view across plan actions so that users are able to see PAOTs plan action that's selected in the right menu
Development Required
- Update the ETL process to extract these new forms from the OpenSRP server and post them to the data warehouse
- Add a new icon type to the Web UI and support color coding of these points as defined in the map view
- Update the process for generating tasks for new plans to include the Potential Areas of Transmission task generation on existing PAOTs that have properties.status=Active
- (Lower Priority) Add the ability to view PAOTs across plan action goals so that users can see the relationship between each plan action and PAOTs
- (Lower Priority) Display comments in the pop-up when a user clicks a PAOT in the map view
Plan Action and Goal Templates
We need to add the following plan action and goal templates for these PAOT
{ "id": "PAOT_goal", "description": "Update Potential Areas of Transmission", "priority": "medium-priority", "target": [ { "measure": "Percent of PAOT updated", "detail": { "detailQuantity": { "value": 100, "comparator": ">=", "unit": "percent" } }, "due": "${now():toNumber():plus(864000000):format("yyyy-MM-dd")}" } ] }
{ "identifier": "${UUID()}", "prefix": 7, "title": "Potential Area(s) of Transmission", "description": "Update Potential Areas of Transmission", "code": "PAOT", "timingPeriod": { "start": "${now():format("yyyy-MM-dd", "GMT")}", "end": "${now():toNumber():plus(864000000):format("yyyy-MM-dd")}" }, "reason": "Investigation", "goalId": "PAOT_goal", "subjectCodableConcept": { "text": "PAOT" }, "taskTemplate": "PAOT" }
Task business logic and colour coding
Form Name(s): PAOT
Intervention Unit: Location with type: PAOT
Status Colour Coding
Color | BusinessStatus | Logic |
---|---|---|
Green | Complete | The form has been filled. Calculation: task.businessStatus = “Complete” |
Yellow | Not Visited | The form has not been completed for this task. Calculation: task.businessStatus = “Not Visited” |
Task Template
PAOT Tasks need the following template (Note that this impacts the automatic plan generation)
{ "identifier": "${UUID()}", "planIdentifier": "${planIdentifier}", "groupIdentifier": "${location.properties.parentId}", "status": "Ready", "businessStatus": "Not Visited", "priority": 3, "code": "${planActionCode}", "description": "${planActionDescription}", "focus": "${planActionIdentifier}", "for": "${location.id}", "executionStartDate": "${planActionTimingPeriodStart}", "executionEndDate": "${planActionTimingPeriodEnd}", "owner": "${taskOwner}", "note": null }
Icon
Below is a sample icon
Mock-Ups
Adding a PAOT PAOT Form Card View
Views
We anticipate the following views to be impacted on with the creation of this feature:
- Android - Add structure form
- Android - Maps - Add a new icon with colour coding
- Android - Maps - Add a card view when the user taps the PAOT
- Android - New form to collect comments
- Web - Maps - Display these new icons in the web view
- Web - Maps - Display comments when the user taps on the PAOT in the map (Low priority)
Justification
- The Thailand BVBD has requested this feature:
- They need to be able to list the PAOT so that they can monitor them and potentially intervene (in active foci).
- It is important to be able to measure the most common PAOT in order to decide on intervention types to implement (inputs into epi research, SOPs and policy)
Dependencies
- Data Dictionary completed
- Icon produced
Notes
- Vivek - purpose: for targeted interventions, could visually see if there is a correlation of infection for more than one focus. they do this on paper at the moment. It is a critical piece of protocol for the Thai team.
- Was this mentioned in the initial first visit? To confirm with Pedro
- Data should be surfaced in web UI and pushed through to Biophics (not for this version though)
- You need to be able to define an area of transmission as part of the focus investigation
Questions
- This feature has been described as a Potential Source of Infection (POI) and a Potential Source of Transmission- which is correct?
- Confirmed by Vivek Agrawal as Potential Area of Transmission (PAOT)
- Was this requirement mentioned during the initial first visit? To confirm with Pedro
Test Case
# | Step | Pass / Fail | Comment |
---|---|---|---|
1 | |||
2 | |||
3 | |||
4 | |||
5 | |||
6 | |||
7 | |||
8 | |||
Additional tester comments: |