TyphoidWASH

The TyphoidWASH intervention class acts on exposure through either the contact contagion population or the environmental contagion population in the simulation. The intervention can be configured to reduce either exposure dose or exposure frequency for each route, simulating effects of water, sanitation, and hygiene (WASH) interventions.

Note

Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. Minimum, maximum, or default values of “NA” indicate that those values are not applicable for that parameter.

EMOD does not use true defaults; that is, if the dependency relationships indicate that a parameter is required, you must supply a value for it. However, many of the tools used to work with EMOD will use the default values provided below.

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

Changing_Effect

JSON object

NA

NA

NA

A highly configurable effect that changes over time. Specify how this effect decays over time using one of the Waning effect classes.

 
{
    "Intervention_Config": {
        "Changing_Effect": {
            "Expire_At_Durability_Map_End": 1,
            "Initial_Effect": 1,
            "class": "WaningEffectConstant"
        },
        "Effect": 1,
        "Mode": "Exposures",
        "Use_Property_Targeting": 0,
        "class": "TyphoidWASH"
    }
}

Disqualifying_Properties

array of strings

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"
    ]
}

Effect

float

0

1

1

The efficacy of the TyphoidWASH intervention. For example, a value of 1 would be 100 percent efficacy for all targeted nodes within the intervention.

 
{
    "Intervention_Config": {
        "Changing_Effect": {
            "Expire_At_Durability_Map_End": 1,
            "Initial_Effect": 1,
            "class": "WaningEffectConstant"
        },
        "Effect": 1,
        "Mode": "Exposures",
        "Use_Property_Targeting": 0,
        "class": "TyphoidWASH"
    }
}

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_Config": {
        "Intervention_Name": "TyphoidWASH intervention campaign",
        "class": "TyphoidWASH"
    }
}

Mode

enum

NA

NA

Shedding

The mode of environmental or contact transmission of typhoid targeted by the intervention. Possible values are:

  • Dose (disease acquisition)

    Reduces the amount of contagion an individual is exposed to per exposure event, by a proportion.

  • Exposures (disease acquisition)

    Reduces the number of exposures to pathogen by a proportion.

  • Shedding (disease transmission)

    Reduces the amount of contagion shed if a vaccinated individual is infected.

 
{
    "Intervention_Config": {
        "Mode": "Exposures",
        "Effect": 1,
        "Use_Property_Targeting": 0,
        "Changing_Effect": {
            "class": "WaningEffectConstant",
            "Initial_Effect": 1,
            "Expire_At_Durability_Map_End": 1
        },
        "class": "TyphoidWASH"
    }
}

New_Property_Value

string

NA

NA

NA

An optional NodeProperty 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"
}

Targeted_Individual_Properties

string

NA

NA

NA

Individual Property key-value pairs to be targeted (optional).

 
{
    "Intervention_Config": {
        "Mode": "Exposures",
        "Effect": 1,
        "Use_Property_Targeting": 1,
        "Changing_Effect": {
            "class": "WaningEffectMapLinear",
            "Initial_Effect": 1,
            "Expire_At_Durability_Map_End": 1,
            "Durability_Map": {
                "Times": [
                    0,
                    100,
                    200,
                    300,
                    400,
                    500
                ],
                "Values": [
                    0,
                    1,
                    1,
                    1,
                    0,
                    1
                ]
            }
        },
        "class": "TyphoidWASH",
        "Targeted_Individual_Properties": "Risk:Target_Demographic"
    }
}

Use_Property_Targeting

boolean

0

1

1

Set to 1 (true) – or omit – if you want to use the Targeted_Individual_Property parameter to limit the effect of this intervention to just certain individuals. Set to 0 to apply effect to everyone.

 
{
    "Event_Coordinator_Config": {
        "Intervention_Config": {
            "Mode": "Shedding",
            "Use_Property_Targeting": 0,
            "Effect": 1.0,
            "Changing_Effect": {
                "class": "WaningEffectConstant",
                "Initial_Effect": 1.0,
                "Expire_At_Durability_Map_End": 1
            },
            "class": "TyphoidWASH"
        },
        "class": "StandardInterventionDistributionEventCoordinator"
    },
    "Nodeset_Config": {
        "class": "NodeSetAll"
    },
    "Start_Day": 10,
    "class": "CampaignEvent"
}

{
  "Intervention_Config": {
    "Changing_Effect": {
      "Durability_Map": {
        "Times": [
          0,
          100,
          200,
          300,
          400,
          500
        ],
        "Values": [
          0,
          1,
          1,
          1,
          0,
          1
        ]
      },
      "Expire_At_Durability_Map_End": 1,
      "Initial_Effect": 1,
      "class": "WaningEffectMapLinear"
    },
    "Effect": 1,
    "Mode": "Exposures",
    "Targeted_Individual_Properties": "Risk:Target_Demographic",
    "Use_Property_Targeting": 1,
    "class": "TyphoidWASH"
  }
}