ControlledVaccine¶
The ControlledVaccine intervention class is a subclass of 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 does not permit comments, but you can add “dummy” parameters to add contextual information to your files.
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 |
|---|---|---|---|---|---|---|
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"
]
}
|
Distributed_Event_Trigger |
enum |
NA |
NA |
NA |
The name of the event to be broadcast when the intervention is distributed to an individual. See Event list for possible values. |
{
"Distributed_Event_Trigger": "Vaccinated"
}
|
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_To_Wait_Before_Revaccination |
float |
0 |
3.40E+3 |
3.40E+38 |
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. |
{
"Duration_To_Wait_Before_Revaccination": 240
}
|
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_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
}
}
}
|
Expired_Event_Trigger |
enum |
NA |
NA |
“” |
The name of the event to be broadcast when the intervention is distributed to an individual. See Event list for possible values. |
{
"Expired_Event_Trigger": "VaccineExpired"
}
|
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": "ControlledVaccine",
"Intervention_Name": "Round of three measles vaccinations"
}
}
|
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"
}
|
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
}
}
}
|
Vaccine_Type |
enum |
NA |
NA |
Generic |
The type of vaccine to distribute in a vaccine intervention. Possible values are:
|
{
"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
}
}
}
|
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. |
{
"Waning_Config": {
"Box_Duration": 3650,
"Initial_Effect": 1,
"class": "WaningEffectBox"
}
}
|
{
"Use_Defaults": 1,
"Events": [{
"COMMENT": "Vaccinate Everyone with VaccineA",
"class": "CampaignEvent",
"Start_Day": 1,
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Target_Demographic": "Everyone",
"Demographic_Coverage": 1.0,
"Intervention_Config": {
"class": "ControlledVaccine",
"Intervention_Name": "VaccineA",
"Cost_To_Consumer": 1,
"Vaccine_Type": "AcquisitionBlocking",
"Vaccine_Take": 1.0,
"Waning_Config": {
"class": "WaningEffectMapLinear",
"Initial_Effect": 1.0,
"Expire_At_Durability_Map_End": 1,
"Durability_Map": {
"Times": [0, 25, 50],
"Values": [1.0, 1.0, 0.0]
}
},
"Distributed_Event_Trigger": "VaccinatedA",
"Expired_Event_Trigger": "VaccineExpiredA",
"Duration_To_Wait_Before_Revaccination": 40
}
}
},
{
"COMMENT": "After the first round expires, distribute a different vaccine, VaccineB",
"class": "CampaignEvent",
"Start_Day": 60,
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Target_Demographic": "Everyone",
"Demographic_Coverage": 1.0,
"Intervention_Config": {
"class": "ControlledVaccine",
"Intervention_Name": "VaccineB",
"Cost_To_Consumer": 1,
"Vaccine_Type": "AcquisitionBlocking",
"Vaccine_Take": 1.0,
"Waning_Config": {
"class": "WaningEffectMapLinear",
"Initial_Effect": 1.0,
"Expire_At_Durability_Map_End": 1,
"Durability_Map": {
"Times": [0, 25, 50],
"Values": [1.0, 1.0, 0.0]
}
},
"Distributed_Event_Trigger": "VaccinatedB",
"Expired_Event_Trigger": "VaccineExpiredB",
"Duration_To_Wait_Before_Revaccination": 40
}
}
}
]
}