UsageDependentBednet

The UsageDependentBednet intervention class is similar to SimpleBednet, as it distributes insecticide-treated nets to individuals in the simulation. However, bednet ownership and bednet usage are distinct in this intervention. As in SimpleBednet, net ownership is configured through the demographic coverage, and the blocking and killing rates of mosquitoes are time-dependent. Use of bednets is age-dependent and can vary seasonally. Once a net has been distributed to someone, the net usage is determined by the product of the seasonal and age-dependent usage probabilities until the net-retention counter runs out, and the net is discarded.

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
Discard_Event enum NA NA NoTrigger The event that is broadcast when an individual discards their bed net, either by replacing an existing net or due to the expiration timer. See Event list for possible values. 
{
    "Received_Event": "Bednet_Got_New_One",
    "Using_Event": "Bednet_Using",
    "Discard_Event": "Bednet_Discarded",
    "Expiration_Distribution_Type": "FIXED_DURATION",
    "Expiration_Period": 50
}
Expiration_Distribution_Type enum NA NA NOT_INITIALIZED

The type of distribution to use when calculating the time to discard a bed net. 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.
 
{
    "Received_Event": "Bednet_Got_New_One",
    "Using_Event": "Bednet_Using",
    "Discard_Event": "Bednet_Discarded",
    "Expiration_Distribution_Type": "FIXED_DURATION",
    "Expiration_Period": 50
}
Expiration_Percentage_Period_1 float 0 1 0.5 The percentage of draws where the first time-scale is used. Expiration_Distribution_Type must be set to DUAL_TIMESCALE_DURATION. 
{
    "Expiration_Distribution_Type": "DUAL_TIMESCALE_DURATION",
    "Expiration_Period_1": 150,
    "Expiration_Period_2": 50,
    "Expiration_Percentage_Period_1": 0.9
}
Expiration_Period_1 float 0 3.40E+3 6 The decay length of the first time-scale, when Expiration_Distribution_Type is set to DUAL_TIMESCALE_DURATION. 
{
    "Expiration_Distribution_Type": "DUAL_TIMESCALE_DURATION",
    "Expiration_Period_1": 150,
    "Expiration_Period_2": 50,
    "Expiration_Percentage_Period_1": 0.9
}
Expiration_Period_2 float 0 3.40E+3 6 The decay length of the second time-scale, when Expiration_Distribution_Type is set to DUAL_TIMESCALE_DURATION. 
{
    "Expiration_Distribution_Type": "DUAL_TIMESCALE_DURATION",
    "Expiration_Period_1": 150,
    "Expiration_Period_2": 50,
    "Expiration_Percentage_Period_1": 0.9
}
Expiration_Period float 0 3.40E+3 6.00E+00 The distribution period for when a bed net expires. Expiration_Distribution_Type must be set to FIXED_DURATION or EXPONENTIAL_DURATION. 
{
    "Expiration_Distribution_Type": "FIXED_DURATION",
    "Expiration_Period": 50
}
Expiration_Period_Max float 0 3.40E+3 0 The maximum duration of use for a bed net when Expiration_Distribution_Type is set to UNIFORM_DURATION. 
{
    "Expiration_Distribution_Type": "UNIFORM_DURATION",
    "Expiration_Period_Max": 50,
    "Expiration_Period_Min": 20
}
Expiration_Period_Mean float 0 3.40E+3 6 The mean of the duration of use for a bed net when Expiration_Distribution_Type is set to GAUSSIAN_DURATION. 
{
    "Expiration_Distribution_Type": "GAUSSIAN_DURATION",
    "Expiration_Period_Mean": 10,
    "Expiration_Period_Std_Dev": 1
}
Expiration_Period_Min float 0 3.40E+3 0 The minimum duration of use for a bed net when Expiration_Distribution_Type is set to UNIFORM_DURATION. 
{
    "Expiration_Distribution_Type": "UNIFORM_DURATION",
    "Expiration_Period_Max": 50,
    "Expiration_Period_Min": 20
}
Expiration_Period_Std_Dev float 0 3.40E+3 1 The standard deviation for the duration of use for a bed net when Expiration_Distribution_Type is set to GAUSSIAN_DURATION. 
{
    "Expiration_Distribution_Type": "GAUSSIAN_DURATION",
    "Expiration_Period_Mean": 10,
    "Expiration_Period_Std_Dev": 1
}
Received_Event enum NA NA NoTrigger This parameter broadcasts when a new net is received, either the first net or a replacement net. See Event list for possible values. 
{
    "Received_Event": "Bednet_Got_New_One",
    "Using_Event": "Bednet_Using",
    "Discard_Event": "Bednet_Discarded"
}
Usage_Config_List array of JSON objects NA NA NA The list of WaningEffects whose effects are multiplied together to get the usage effect. Specify how this effect decays over time using one of the Waning effect classes. 
{
    "Usage_Config_List": [{
        "class": "WaningEffectConstant",
        "Initial_Effect": 1.0
    }]
}
Using_Event enum NA NA NoTrigger This parameter broadcasts each time step in which a bed net is used. See Event list for possible values. 
{
    "Received_Event": "Bednet_Got_New_One",
    "Using_Event": "Bednet_Using",
    "Discard_Event": "Bednet_Discarded"
}
Blocking_Config JSON object NA NA NA Configures the rate of blocking for indoor mosquito feeds on individuals with an ITN. Specify how this effect decays over time using one of the Waning effect classes. 
{
    "Blocking_Config": {
        "Box_Duration": 3650,
        "Initial_Effect": 0,
        "class": "WaningEffectBox"
    }
}
Cost_To_Consumer float 0 999999 3.75 The unit cost per bednet (unamortized) 
{
    "Cost_To_Consumer": 4.5
}
Killing_Config JSON object NA NA NA The configuration of the rate at which mosquitoes die, conditional on a successfully blocked feed. Specify how this effect decays over time using one of the Waning effect classes. 
{
    "Killing_Config": {
        "Box_Duration": 3650,
        "Initial_Effect": 0.53429,
        "class": "WaningEffectBox"
    }
}
Dont_Allow_Duplicates boolean NA NA 0 If an individual’s container has an intervention, set to true (1) to prevent them from receiving another copy of the intervention. Supported by all intervention classes. 
{
    "Dont_Allow_Duplicates": 0
}
Disqualifying_Properties string NA NA NA A list of IndividualProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to individuals with these values). See NodeProperties and IndividualProperties parameters for more information. Generally used to control the flow of health care access. For example, to prevent the same individual from accessing health care via two different routes at the same time. 
{
    "Disqualifying_Properties": [
        "InterventionStatus:LostForever"
    ]
}
Intervention_Name string NA NA NA The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. 
{
    "Intervention_Name":"Diagnostic_Sample"
}
New_Property_Value string NA NA NA An optional IndividualProperty key:value pair that will be assigned when the intervention is distributed. See NodeProperties and IndividualProperties parameters for more information. Generally used to indicate the broad category of health care cascade to which an intervention belongs to prevent individuals from accessing care through multiple pathways. For example, if an individual must already be taking a particular medication to be prescribed a new one. 
{
    "New_Property_Value": "InterventionStatus:None"
}

{
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Target_Demographic": "Everyone",
                "Demographic_Coverage": 1.0,
                "Number_Repetitions": 1,
                "Timesteps_Between_Repetitions": 0,
                "Intervention_Config": {
                    "class": "UsageDependentBednet",
                    "Cost_To_Consumer": 5,
                    "Usage_Config_List":
                    [
                        {
                            "class": "WaningEffectConstant",
                            "Initial_Effect": 1.0
                        }
                    ],
                    "Blocking_Config": {
                        "class": "WaningEffectConstant",
                        "Initial_Effect": 1.0
                    },
                    "Killing_Config": {
                        "class": "WaningEffectConstant",
                        "Initial_Effect": 0.5
                    },
                    "Received_Event" : "Bednet_Got_New_One",
                    "Using_Event"    : "Bednet_Using",
                    "Discard_Event"  : "Bednet_Discarded",
                    "Expiration_Distribution_Type" : "FIXED_DURATION",
                    "Expiration_Period" : 50
                }
            }
        }
    ],
    "Use_Defaults": 1
}