StandardInterventionDistributionEventCoordinator

The StandardInterventionDistributionEventCoordinator coordinator class distributes an individual-level or node-level intervention to a specified fraction of individuals or nodes within a node set. Recurring campaigns can be created by specifying the number of times distributions should occur and the time between repetitions.

Demographic restrictions such as Demographic_Coverage and Target_Gender do not apply when distributing node-level interventions. The node-level intervention must handle the demographic restrictions.

See the following JSON example and table, which shows all available parameters for this event coordinator.

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 format does not permit comments, but you can add “dummy” parameters to add contextual information to your files. Any keys that are not EMOD parameter names will be ignored by the model.

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
Demographic_Coverage float 0 1 1 The fraction of individuals in the target demographic that will receive this intervention. 
{
    "Demographic_Coverage": 1
}
Individual_Selection_Type enum NA NA DEMOGRAPHIC_COVERAGE

Defines how the people that pass all of the other target restrictions are selected.

Possible values are:

DEMOCGRAPHIC_COVERAGE
When set, the parameter Demographic_Coverage is used to randomly select a certain percentage of the targeted group.
TARGET_NUM_INDIVIDUALS
When set, the parameter Target_Num_Individuals is used to select exactly that number of people out of the targeted group.
 
{
    "Individual_Selection_Type": "DEMOGRAPHIC_COVERAGE",
    "Demographic_Coverage": 0.75
}
Intervention_Config JSON object NA NA NA The nested JSON of the actual intervention to be distributed by this event coordinator. 
{
    "Intervention_Config": {
        "class": "OutbreakIndividual",
        "Incubation_Period_Override": 1,
        "Outbreak_Source": "PrevalenceIncrease"
    }
}
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. See NodeProperties and IndividualProperties parameters for more information.

You can specify AND and OR combinations of key:value pairs with this parameter.

The following example restricts the intervention to nodes that are urban and medium risk or rural and low risk.

{
    "Node_Property_Restrictions": [
        {
            "Place": "URBAN",
            "Risk": "MED"
        },
        {
            "Place": "RURAL",
            "Risk": "LOW"
        }
    ]
}
Number_Repetitions integer -1 10000 1 The number of times an intervention is given, used with Timesteps_Between_Repetitions. A value of -1 implies an infinite number of repetitions. 
{
    "Event_Coordinator_Config": {
        "Intervention_Config": {
            "class": "Outbreak",
            "Num_Cases": 1
        },
        "Number_Repetitions": 10,
        "Timesteps_Between_Repetitions": 50,
        "class": "StandardInterventionDistributionEventCoordinator"
    }
}
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 intervention. See NodeProperties and IndividualProperties parameters for more information.

To specify AND and OR combinations of key:value pairs, use Property_Restrictions_Within_Node. You cannot use both of these parameters in the same event coordinator.

 
{
    "Property_Restrictions": [
        "Risk:HIGH"
    ]
}
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 intervention. See NodeProperties and IndividualProperties parameters for more information.

This parameter allows you to specify AND and OR combinations of key:value pairs. You may specify individual property restrictions using either this parameter or Property_Restrictions, but not both.

The following example restricts the intervention to individuals who are urban and high risk or urban and medium risk.

{
    "Property_Restrictions_Within_Node": [
        {
            "Risk": "HIGH",
            "Geographic": "URBAN"
        },
        {
            "Risk": "MEDIUM",
            "Geographic": "URBAN"
        }
    ]
}
Target_Age_Max float 0 9.3228e+35 9.3228e+35 The upper 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_Age_Min float 0 9.3228e+35 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
  • 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"
}
Target_Residents_Only boolean 0 1 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
}
Timesteps_Between_Repetitions integer -1 10000 -1 The repetition interval. 
{
    "Timesteps_Between_Repetitions": 50
}
Targeting_Config JSON object NA NA NA Be more selective of individuals by using the Targeting_Config classes. 
{
    "Targeting_Config": {
        "class": "HasIntervention",
        "Is_Equal_To": 0,
        "Intervention_Name": "MyVaccine"
    }
}

{
    "Use_Defaults": 1,
    "Events": [{
        "Event_Name": "Outbreak",
        "class": "CampaignEvent",
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Start_Day": 1,
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Demographic_Coverage": 0.005,
            "Intervention_Config": {
                "Outbreak_Source": "PrevalenceIncrease",
                "class": "OutbreakIndividual"
            }
        }
    }]
}