Skip to content

SimpleVaccine

The SimpleVaccine intervention class implements vaccine campaigns in the simulation. Vaccines can have an effect on one of the following:

  • Reduce the likelihood of acquiring an infection
  • Reduce the likelihood of transmitting an infection
  • Reduce the likelihood of death

To configure vaccines that have an effect on more than one of these, use parameter-campaign-individual-multieffectvaccine instead.

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 Type Min Max Default Description
Cost_To_Consumer float 0 999999 10 The unit cost per vaccine (unamortized).
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 IndividualProperties and NodeProperties 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.
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.
Efficacy_Is_Multiplicative boolean 0 1 1 The overall vaccine efficacy when individuals receive more than one vaccine. When set to true (1), the vaccine efficacies are multiplied together; when set to false (0), the efficacies are additive.
Intervention_Name string NA NA SimpleVaccine The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.
New_Property_Value string NA NA "" An optional IndividualProperty key:value pair that will be assigned when the intervention is applied. See IndividualProperties and NodeProperties 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.
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.
Vaccine_Type enum NA NA Generic The type of vaccine to distribute in a vaccine intervention.
Possible values are:
Generic
The vaccine can reduce transmission, acquisition, and mortality.
TransmissionBlocking
The vaccine will reduce pathogen transmission.
AcquisitionBlocking
The vaccine will reduce the acquisition of the pathogen by reducing the force of infection experienced by the vaccinated individual.
MortalityBlocking
The vaccine reduces the disease-mortality rate of a vaccinated individual.
Waning_Config json object NA NA NA The configuration of how the intervention efficacy wanes over time. Specify how this effect decays over time using one of the Waning effect classes. 
{
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 60,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Target_Demographic": "Everyone",
                "Demographic_Coverage": 0.5,
                "Intervention_Config": {
                    "class": "SimpleVaccine",
                    "Cost_To_Consumer": 10.0,
                    "Vaccine_Take": 1,
                    "Vaccine_Type": "AcquisitionBlocking",
                    "Waning_Config": {
                        "class": "WaningEffectBox",
                        "Box_Duration": 3650,
                        "Initial_Effect": 1
                    }
                }
            }
        }
    ],
    "Use_Defaults": 1
}