CommunityHealthWorkerEventCoordinator

The CommunityHealthWorkerEventCoordinator coordinator class is used to model a health care worker’s ability to distribute interventions to the nodes and individual in their coverage area. This coordinator distributes a limited number of interventions per day, and can create a backlog of individuals or nodes requiring the intervention. For example, individual-level interventions could be distribution of drugs and node-level interventions could be spraying houses with insecticide.

Note

Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. JSON does not permit comments, but you can add “dummy” parameters to add contextual information to your files.

The table below describes all possible parameters with which this class can be configured. The JSON example that follows shows one potential configuration.

Parameter

Data type

Minimum

Maximum

Default

Description

Example

Amount_In_Shipment

integer

1

2.15E+0

2.15E+09

The number of interventions (such as vaccine doses) that a health worker or clinic receives in a shipment. Interventions can only be distributed if they are in stock; stock is updated every Days_Between_Shipments with the Amount_In_Shipment.

 
{
    "Amount_In_Shipment": 10
}

Days_Between_Shipments

float

1

3.40E+3

3.40E+38

The number of days to wait before a clinic or health worker receives a new shipment of interventions (such as vaccine doses). Interventions can only be distributed if they are in stock; stock is updated every Days_Between_Shipments with the Amount_In_Shipment.

 
{
    "Days_Between_Shipments": 30
}

Duration

float

0

3.40E+3

3.40E+38

The number of days for an event coordinator to be active before it expires.

 
{
    "Duration": 65
}

Initial_Amount

float

0

3.40E+3

6

The initial amount of stock of interventions (such as vaccine doses). Interventions can only be distributed if they are in stock; stock is updated every Days_Between_Shipments with the Amount_In_Shipment.

 
{
    "Initial_Amount": 10
}

Initial_Amount_Distribution_Type

enum

NA

NA

NOT_INITIALIZED

The distribution type to set when initializing Initial_Amount. Possible values are:

NOT_INITIALIZED

No distribution set.

FIXED_DURATION

A constant duration.

UNIFORM_DURATION

A uniform random draw for the duration.

GAUSSIAN_DURATION

Duration of the active period is defined by the mean and standard deviation of the Gaussian distribution. Negative values are truncated at zero.

EXPONENTIAL_DURATION

The active period is the mean of the exponential random draw.

POISSON_DURATION

The active period is the mean of the random Poisson draw.

LOG_NORMAL_DURATION

The active period is a log normal distribution defined by a mean and log width.

BIMODAL_DURATION

The distribution is bimodal, the duration is a fraction of the active period for a specified period of time and equal to the active period otherwise.

PIECEWISE_CONSTANT

The distribution is specified with a list of years and a matching list of values. The duration at a given year is that specified for the nearest previous year.

PIECEWISE_LINEAR

The distribution is specified with a list of years and matching list of values. The duration at a given year is a linear interpolation of the specified values.

WEIBULL_DURATION

The duration is a Weibull distribution with a given scale and shape.

DUAL_TIMESCALE_DURATION

The duration is two exponential distributions with given means.

 
{
    "Initial_Amount_Distribution_Type": "FIXED_DURATION"
}

Initial_Amount_Max

float

0

3.40E+3

0

The maximum amount of initial stock when Initial_Amount_Distribution_Type is set to UNIFORM_DISTRIBUTION.

 
{
    "Initial_Amount_Distribution_Type": "UNIFORM_DURATION",
    "Initial_Amount_Min": 5,
    "Initial_Amount_Max": 10
}

Initial_Amount_Mean

float

0

3.40E+3

6

The average amount of initial stock when Initial_Amount_Distribution_Type is set to GAUSSIAN_DISTRIBUTION.

 
{
    "Initial_Amount_Distribution_Type": "GAUSSIAN_DISTRIBUTION",
    "Initial_Amount_Std_Dev": 1,
    "Initial_Amount_Mean": 5
}

Initial_Amount_Min

float

0

3.40E+3

0

The minimum amount of initial stock when Initial_Amount_Distribution_Type is set to UNIFORM_DISTRIBUTION.

 
{
    "Initial_Amount_Distribution_Type": "UNIFORM_DURATION",
    "Initial_Amount_Min": 5,
    "Initial_Amount_Max": 10
}

Initial_Amount_Std_Dev

float

0

3.40E+3

1

The standard deviation for the amount of initial stock when Initial_Amount_Distribution_Type is set to GAUSSIAN_DISTRIBUTION.

 
{
    "Initial_Amount_Distribution_Type": "GAUSSIAN_DISTRIBUTION",
    "Initial_Amount_Std_Dev": 1,
    "Initial_Amount_Mean": 5
}

Intervention_Config

JSON object

NA

NA

NA

The nested JSON of the actual intervention to be distributed by this event coordinator.

 
{
    "Intervention_Config": {
        "class": "BroadcastEvent",
        "Broadcast_Event": "EventFromIntervention"
    }
}

Max_Distributed_Per_Day

integer

1

2.15E+0

2.15E+09

The maximum number of interventions (such as vaccine doses) that can be distributed by health workers or clinics in a given day.

 
{
    "Max_Distributed_Per_Day": 1
}

Max_Stock

integer

0

2.15E+0

2.15E+09

The maximum number of interventions (such as vaccine doses) that can be stored by a health worker or clinic. If the amount of interventions in a new shipment and current stock exceeds this value, only the number of interventions specified by this value will be stored.

 
{
    "Max_Stock": 12
}

Trigger_Condition_List

array of strings

NA

NA

NoTrigger

The list of events that are of interest to the community health worker (CHW). If one of these events occurs, the individual or node is put into a queue to receive the CHW’s intervention. The CHW processes the queue when the event coordinator is updated. See Event list for possible values.

 
{
    "Trigger_Condition_List": ["ListenForEvent"]
}

Waiting_Period

float

0

3.40E+3

3.40E+38

The number of days a person or node can be in the queue waiting to get the intervention from the community health worker (CHW). If a person or node is in the queue, they will not be re-added to the queue if the event that would add them to the queue occurs. This allows them to maintain their priority, however they could be removed from the queue due to this waiting period.

 
{
    "Waiting_Period": 15
}

Property_Restrictions

array of JSON objects

NA

NA

NA

A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this individual-level intervention. See NodeProperties and IndividualProperties parameters for more information.

 
{
    "Property_Restrictions": [
        "Risk:HIGH"
    ]
}

Node_Property_Restrictions

array of JSON objects

NA

NA

NA

A list of the NodeProperty key:value pairs, as defined in the demographics file, that nodes must have to be targeted by the intervention.

 
{
    "Node_Property_Restrictions": [{
            "Place": "URBAN",
            "Risk": "MED"
        },
        {
            "Place": "RURAL",
            "Risk": "LOW"
        }
    ]
}

Target_Age_Min

float

0

3.40E+3

0

The lower end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.

 
{
    "Target_Age_Max": 20,
    "Target_Age_Min": 10,
    "Target_Demographic": "ExplicitAgeRanges"
}

Target_Demographic

enum

NA

NA

Everyone

The target demographic group. Possible values are:

  • Everyone

  • ExplicitAgeRanges

  • ExplicitAgeRangesAndGender

  • ExplicitGender

  • PossibleMothers

  • ArrivingAirTravellers

  • DepartingAirTravellers

  • ArrivingRoadTravellers

  • DepartingRoadTravellers

  • AllArrivingTravellers

  • AllDepartingTravellers

  • ExplicitDiseaseState

 
{
    "Target_Age_Max": 20,
    "Target_Age_Min": 10,
    "Target_Demographic": "ExplicitAgeRanges"
}

Target_Gender

enum

NA

NA

All

Specifies the gender restriction for the intervention. Possible values are:

  • Male

  • Female

  • All

 
{
    "Target_Gender": "Male"
}

Demographic_Coverage

float

0

1

1

The fraction of individuals in the target demographic that will receive this intervention.

 
{
    "Demographic_Coverage": 1
}

Property_Restrictions_Within_Node

array of JSON objects

NA

NA

NA

A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this node-level intervention. See NodeProperties and IndividualProperties parameters for more information.

 
{
    "Property_Restrictions_Within_Node": [{
        "Risk": "HIGH"
    }]
}

Target_Residents_Only

boolean

NA

NA

0

When set to true (1), the intervention is only distributed to individuals that began the simulation in the node (i.e. those that claim the node as their residence).

 
{
    "Target_Residents_Only": 1
}

{
    "Events": [{
        "class": "CampaignEvent",
        "Start_Day": 1,
        "Nodeset_Config": {
            "class": "NodeSetNodeList",
            "Node_List": [2, 3, 4]
        },
        "Event_Coordinator_Config": {
            "class": "CommunityHealthWorkerEventCoordinator",
            "Duration": 400,
            "Distribution_Rate": 25,
            "Waiting_Period": 10,
            "Days_Between_Shipments": 25,
            "Amount_In_Shipment": 250,
            "Max_Stock": 1000,
            "Initial_Amount_Distribution_Type": "FIXED_DURATION",
            "Initial_Amount": 500,
            "Target_Demographic": "Everyone",
            "Demographic_Coverage": 1.0,
            "Property_Restrictions": [],
            "Target_Residents_Only": 0,
            "Trigger_Condition_List": ["NewInfectionEvent"],
            "Intervention_Config": {
                "class": "SimpleVaccine",
                "Cost_To_Consumer": 10.0,
                "Vaccine_Take": 1,
                "Vaccine_Type": "AcquisitionBlocking",
                "Waning_Config": {
                    "class": "WaningEffectBox",
                    "Initial_Effect": 1,
                    "Box_Duration": 200
                }
            }
        }
    }]
}