Skip to content

Commit

Permalink
IFRCGo#280 Skeleton documentation for Volunteer Reporting
Browse files Browse the repository at this point in the history
  • Loading branch information
karolikl committed Nov 13, 2017
1 parent ea5a4b5 commit ec6a152
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 8 deletions.
10 changes: 5 additions & 5 deletions Documentation/Projects/Admin/Processes/DefiningProject.md
@@ -1,11 +1,11 @@
# Defining a Project

## Commands
* A [CBS Coordinator (global level)](../actors.md) is __[creating a project](../Commands/CreateProject.md)__
* A [Project Owner](../actors.md) is __[defining health risks for a project](../Commands/DefineHealthRisksForProject.md)__
* A [Project Owner](../actors.md) is __[defining the SMS reporting structure for a project](../Commands/SetSmsReportingStructure.md)__
* A [CBS Coordinator (global level)](../actors.md) is __[changing the data owner of a project](../Commands/ChangeProjectDataOwner.md)__
* A [Project Owner](../actors.md) is __[Setting the area structure and data verifiers for a project](../Commands/ChangeAreasAndDataVerifiers.md)__
* A [CBS Coordinator (global level)](../../actors.md) is __[creating a project](../Commands/CreateProject.md)__
* A [Project Owner](../../actors.md) is __[defining health risks for a project](../Commands/DefineHealthRisksForProject.md)__
* A [Project Owner](../../actors.md) is __[defining the SMS reporting structure for a project](../Commands/SetSmsReportingStructure.md)__
* A [CBS Coordinator (global level)](../../actors.md) is __[changing the data owner of a project](../Commands/ChangeProjectDataOwner.md)__
* A [Project Owner](../../actors.md) is __[Setting the area structure and data verifiers for a project](../Commands/ChangeAreasAndDataVerifiers.md)__

## Events
* __[A new project was created](../Events/ProjectCreated.md)__
Expand Down
@@ -0,0 +1,18 @@
---
title:
description:
keywords:
author: karolikl
---
# Receiving a text message

## Abstract
> A [Data Collector](../../actors.md) sends a text message to the system containing events occuring in their defined geographical area.
## Events

## External Events

## Read Model


@@ -0,0 +1,16 @@
---
title:
description:
keywords:
author: karolikl
---
# Read Model: Case Report


## Abstract
> A Case Report is an observed health risk reported by a data collector.
This model represents an entry in a projects list of Case Reports. It has been sent by a known/identified data collector and it has been parsed successfully, meaning that the format of the report was correct.

## Data Structure
* Case Report
6 changes: 3 additions & 3 deletions Documentation/Projects/actors.md
Expand Up @@ -14,12 +14,12 @@ aspects. Not all users have access to everything.

## User

## Volunteer
## Data Collector

Volunteers are trained to detect events that pose a risk to public health to the system. The volunteer is a community-based data collector, who submits structured data on events occuring in their defined geographical area to the system. The volunteer receives automated confirmation of receipt, or an error-report if the report could not be validated. If a report exceeds the threshold for any one event or triggers the initiation of an alert the volunteer will receive information that an alert has been triggered, with prompts for actions that may be required, and who is the designated person to follow up the alert (next level escalation. In the event of nothing to report, the volunteer will send a zero-report according to project SOP. The volunteers have access to their own data/ aggregated data from their own community.
Data collectors are trained to observe and report events that pose a risk to public health. The data collector is a community-based volunteer, who submits a text message case report on events occuring in their defined geographical area to the system. The data collector receives an automatic receipt message when submitting a case report, or an error message if the report could not be validated. If a report exceeds the threshold for any one event or triggers the initiation of an alert the data collector will receive information that an alert has been triggered, with prompts for actions that may be required, and who is the designated person to follow up the alert (next level escalation). In the event of nothing to report, the data collector will send a zero-report according to project SOP. The data collectors have access to their own data/ aggregated data from their own community.

## Coordinator / Supervisor
The supervisor has direct supervision responsibility for volunteers in their area (district or region) and is the first level of escalation. They receive alerts based on the volunteers' reports, and are tasked to verify the alert, assess and decided action (dismiss, community response, or escalation to next level).
The supervisor has direct supervision responsibility for data collector in their area (district or region) and is the first level of escalation. They receive alerts based on the data collectors' reports, and are tasked to verify the alert, assess and decided action (dismiss, community response, or escalation to next level).

## CBS Coordinator - national level

Expand Down

0 comments on commit ec6a152

Please sign in to comment.