NodeLevelHealthTriggeredIV

The NodeLevelHealthTriggeredIV intervention class is a node-level intervention that distributes an intervention to individuals when a specific event occurs to those individuals. NodeLevelHealthTriggeredIV monitors for event triggers from individuals, and when found, will distribute the intervention. For example, NodeLevelHealthTriggeredIV can be configured such that all individuals will be given a diagnostic intervention when they transition from susceptible to infectious. During the simulation, when individuals become infected, they broadcast the NewInfectionEvent trigger and NodeLevelHealthTriggeredIV distributes the diagnostic intervention to them.

Notes and tips for this intervention:

  • This is the main tool for distributing an intervention to a person when an event happens to that person. Note that the intervention is distributed to all individuals in the node which experience the triggering event.

  • This is a node-level intervention and is not serialized. If interventions were distributed prior to serialization, in order to have those interventions continue after starting from the serialized file, they must be added to the new campaign file.

  • This can be used to distribute other node-level interventions. For example, it can be used to distribute SpaceSpraying to the node when someone becomes infected (e.g. by listening for for NewInfectionEvent or an event from a diagnostic).

  • A powerful feature of this intervention is that it can target specific groups of individuals who broadcast the event. Individuals, and subgroups of individuals, can be targeted by age, gender, and Individual Property.

  • Note that when distributing a node-level intervention parameters associated with targeting an individual (such as Target_Demographic, Target_Gender, Property_Restriction_Within_Node, etc.) do not apply.

  • Blackout_Period is a feature that can be useful when monitoring an event from the individual in a node. It enables reaction to some individuals experiencing an event but ignoring subsequent events for a period of time. For example, SpaceSpraying could be distributed to the node on the first occurrence of NewInfectionEvent, but after spraying has occurred all other infection events can be ignored for a specific period of time. Without Blackout_Period, each infection event would trigger another round of spraying.

  • The Distribute_On_Return_Home feature causes NodeLevelHealthTriggeredIV to keep track of residents when they leave the node and then return. If a person leaves the node and an intervention is distributed while the person is gone, NodeLevelHealthTriggeredIV gives the person the intervention (such as a vaccine dose) when they return to the node.

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

Actual_IndividualIntervention_Config

json object

NA

NA

NA

The configuration of an actual individual intervention to be distributed on the trigger. Selects a class for the intervention and configures the parameters specific for that intervention class.

 
{
  "Actual_IndividualIntervention_Config": {
    "Antigen": 0,
    "Genome": 0,
    "class": "OutbreakIndividual"
  }
}

Actual_NodeIntervention_Config

json object

NA

NA

NA

The configuration of the actual node-level intervention sought. This parameter selects a class for the intervention and configures the parameters specific for that intervention class.

 
{
  "Actual_NodeIntervention_Config": {
    "Antigen": 0,
    "Genome": 0,
    "class": "OutbreakIndividual"
  }
}

Blackout_Event_Trigger

enum

NA

NA

“”

The event to broadcast if an intervention cannot be distributed due to the Blackout_Period. See Event list for possible values.

 
{
  "Blackout_Event_Trigger": "Blackout"
}

Blackout_On_First_Occurrence

boolean

0

1

0

If set to true (1), individuals will enter the blackout period after the first occurrence of an event in the Trigger_Condition_List.

 
{
  "Blackout_On_First_Occurrence": 0
}

Blackout_Period

float

0

3.40282e+38

0

After the initial intervention distribution, the time, in days, to wait before distributing the intervention again. If it cannot distribute due to the blackout period, it will broadcast the user-defined Blackout_Event_Trigger.

 
{
  "Blackout_Period": 0.0
}

Demographic_Coverage

float

0

1

1

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

 
{
  "Demographic_Coverage": 1
}

Disqualifying_Properties

array of strings

NA

NA

[]

A list of NodeProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to nodes 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"
  ]
}

Distribute_On_Return_Home

boolean

0

1

0

When set to true (1), individuals will receive an intervention upon returning home if that intervention was originally distributed while the individual was away.

 
{
  "Distribute_On_Return_Home": 1
}

Dont_Allow_Duplicates

boolean

0

1

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
}

Duration

float

-1

3.40282e+38

-1

The number of days the NLHTIV will exist and listen for events/triggers. Note: Specifying a value of -1 results in indefinite persistence of the intervention.

 
{
  "Duration": -1
}

Intervention_Name

string

NA

NA

NodeLevelHealthTriggeredIV

The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.

 
{
  "Intervention_Config": {
    "class": "NodeLevelHealthTriggeredIV",
    "Intervention_Name": "Treat individuals when infectious"
  }
}

New_Property_Value

string

NA

NA

“”

An optional NodeProperty key:value pair that will be assigned when the intervention is applied. See NodeProperties and IndividualProperties parameters for more information.

 
{
  "New_Property_Value": "HasHealthCare:YES"
}

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

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.32E+35

9.32E+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
}

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

Trigger_Condition_List

array of strings

NA

NA

NA

An array of events that will trigger an intervention. The events contained in the list can be built-in events (see Event list for possible events) or the custom events defined in Custom_Individual_Events in the simulation configuration file.

 
{
  "Trigger_Condition_List": [
    "OnART3"
  ]
}

{
    "Use_Defaults": 1,
    "Events": [{
        "class": "CampaignEvent",
        "Start_Day": 1,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Intervention_Config": {
                "class": "NodeLevelHealthTriggeredIV",
                "Trigger_Condition_List": ["HappyBirthday"],
                "Demographic_Coverage": 1.0,
                "Target_Age_Max": 99,
                "Target_Age_Min": 21,
                "Target_Demographic": "ExplicitAgeRanges",
                "Target_Residents_Only": 1,
                "Actual_IndividualIntervention_Config": {
                    "class": "OutbreakIndividual",
                    "Antigen": 0,
                    "Genome": 0,
                    "Outbreak_Source": "PrevalenceIncrease"
                }
            }
        }
    }]
}