BirthTriggeredIV#

The BirthTriggeredIV intervention class monitors for birth events and then distributes an actual intervention to the new individuals as specified in Actual_IndividualIntervention_Config.

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 sought. Selects a class for the intervention and configures the parameters specific for that intervention class.

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

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

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 to continue this intervention.

Note

For BirthTriggeredIV, specifying a value of -1 results in indefinite persistence of the birth-triggered intervention.

 
{
  "Duration": -1
}

Intervention_Name

string

NA

NA

BirthTriggeredIV

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": "BirthTriggeredIV",
    "Intervention_Name": "Measles vaccination at 6 months"
  }
}

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

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
}

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": [{
        "class": "CampaignEventByYear",
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Start_Year": 1960,
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Intervention_Config": {
                "class": "BirthTriggeredIV",
                "Target_Demographic": "ExplicitGender",
                "Target_Gender": "Male",
                "Demographic_Coverage": 1,
                "Actual_IndividualIntervention_Config": {
                    "class": "HIVSigmoidByYearAndSexDiagnostic",
                    "New_Property_Value": "InterventionStatus:None",
                    "Ramp_Min": 0.0,
                    "Ramp_Max": 0.3,
                    "Ramp_MidYear": 2002.0,
                    "Ramp_Rate": 0.5,
                    "Positive_Diagnosis_Event": "HIVNeedsMaleCircumcision"
                }
            }
        }

    }]
}