MultiEffectVaccine

The MultiEffectVaccine intervention class implements vaccine campaigns in the simulation. Vaccines can effect all of the following:

  • Reduce the likelihood of acquiring an infection

  • Reduce the likelihood of transmitting an infection

  • Reduce the likelihood of death

After distribution, the effect wanes over time.

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

Acquire_Config

JSON object

NA

NA

NA

The configuration for multi-effect vaccine acquisition. Specify how this effect decays over time using one of the Waning effect classes.

 
{
    "Acquire_Config": {
        "Initial_Effect": 0.9,
        "Decay_Time_Constant": 2525,
        "class": "WaningEffectExponential"
    }
}

Cost_To_Consumer

float

0

999999

10

The unit cost per vaccine (unamortized).

 
{
    "Cost_To_Consumer": 10.0
}

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

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
}

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": {
        "class": "MultiEffectVaccine",
        "Intervention_Name": "Routine MMR vaccination"
    }
}

Mortality_Config

JSON object

NA

NA

NA

The configuration for multi-effect vaccine mortality. Specify how this effect decays over time using one of the Waning effect classes.

 
{
    "Mortality_Config": {
        "Initial_Effect": 1.0,
        "Decay_Time_Constant": 2525,
        "class": "WaningEffectExponential"
    }
}

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

Transmit_Config

JSON object

NA

NA

NA

The configuration for multi-effect vaccine transmission. Specify how this effect decays over time using one of the Waning effect classes.

 
{
    "Transmit_Config": {
        "Initial_Effect": 0.6,
        "Decay_Time_Constant": 2525,
        "class": "WaningEffectExponential"
    }
}

Vaccine_Take

float

0

1

1

The rate at which delivered vaccines will successfully stimulate an immune response and achieve the desired efficacy. For example, if it is set to 0.9, there will be a 90 percent chance that the vaccine will start with the specified efficacy, and a 10 percent chance that it will have no efficacy at all.

 
{
    "Intervention_Config": {
        "class": "SimpleVaccine",
        "Cost_To_Consumer": 10,
        "Vaccine_Type": "AcquisitionBlocking",
        "Vaccine_Take": 1,
        "Efficacy_Is_Multiplicative": 0,
        "Waning_Config": {
            "class": "WaningEffectConstant",
            "Initial_Effect": 0.3
        }
    }
}

{
    "Events": [{
        "Event_Coordinator_Config": {
            "Demographic_Coverage": 1,
            "Intervention_Config": {
                "Cost_To_Consumer": 20,
                "Vaccine_Take": 1,
                "Vaccine_Type": "Generic",
                "class": "MultiEffectVaccine",
                "Acquire_Config": {
                    "Initial_Effect": 0.9,
                    "Decay_Time_Constant": 7300,
                    "class": "WaningEffectExponential"
                },
                "Transmit_Config": {
                    "Initial_Effect": 0.9,
                    "Decay_Time_Constant": 7300,
                    "class": "WaningEffectExponential"
                },
                "Mortality_Config": {
                    "Initial_Effect": 1.0,
                    "Decay_Time_Constant": 7300,
                    "class": "WaningEffectExponential"
                }
            },
            "Property_Restrictions": [
                "Accessibility:VaccineTake"
            ],
            "Target_Age_Max": 100,
            "Target_Age_Min": 12,
            "Target_Demographic": "ExplicitAgeRanges",
            "class": "StandardInterventionDistributionEventCoordinator"
        },
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Start_Day": 1,
        "class": "CampaignEvent"
    }],
    "Use_Defaults": 1
}