ControlledVaccine

The ControlledVaccine intervention class is a subclass of parameter-campaign-individual-simplevaccine so it contains all functionality of SimpleVaccine, but provides more control over additional events and event triggers. This intervention can be configured so that specific events are broadcast when individuals receive an intervention or when the intervention expires. Further, individuals can be re-vaccinated, using a configurable wait time between vaccinations.

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	Example	Description	Type	Min	Max	Default
Cost_To_Consumer	link	The unit cost per vaccine (unamortized).	float	0	999999	10
Disqualifying_Properties	link	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 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.	array of strings	nan	nan	[]
Distributed_Event_Trigger	link	The name of the event to be broadcast when the intervention is distributed to an individual. See Event list for possible values.	enum	nan	nan	nan
Dont_Allow_Duplicates	link	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.	boolean	0	1	0
Duration_To_Wait_Before_Revaccination	link	The length of time, in days, to wait before revaccinating an individual. After this time has passed, the individual can be revaccinated. If the first vaccine has not expired, the individual can receive the effect from both doses of the vaccine.	float	0	3.40282e+38	3.40282e+38
Efficacy_Is_Multiplicative	link	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.	boolean	0	1	1
Expired_Event_Trigger	link	The name of the event to be broadcast when the intervention is distributed to an individual. See Event list for possible values.	enum	nan	nan	""
Intervention_Name	link	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	string	nan	nan	nan
New_Property_Value	link	An optional IndividualProperty key:value pair that will be assigned when the intervention is distributed. See 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.	string	nan	nan	nan
Vaccine_Take	link	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.	float	0	1	1
Vaccine_Type	link	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.	enum	nan	nan	Generic
Waning_Config	link	The configuration of how the intervention efficacy wanes over time. Specify how this effect decays over time using one of the Waning effect classes.	JSON object	nan	nan	nan

link