MultiEffectBoosterVaccine¶
The MultiEffectBoosterVaccine intervention class is derived from MultiEffectVaccine and preserves many of the same parameters. Upon distribution and successful take, the vaccine’s effect in each immunity compartment (acquisition, transmission, and mortality) is determined by the recipient’s immune state. If the recipient’s immunity modifier in the corresponding compartment is above a user-specified threshold, then the vaccine’s initial effect will be equal to the corresponding priming parameter. If the recipient’s immune modifier is below this threshold, then the vaccine’s initial effect will be equal to the corresponding boost parameter. After distribution, the effect wanes, just like a MultiEffectVaccine. The behavior is intended to mimic biological priming and boosting.
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 |
|---|---|---|---|---|---|---|
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"
}
}
|
Boost_Acquire |
float |
0 |
1 |
0 |
Specifies the boosting effect on acquisition immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. This does not replace current immunity, it builds multiplicatively on top of it. |
{
"Boost_Acquire": 0.7
}
|
Boost_Mortality |
float |
0 |
1 |
0 |
Specifies the boosting effect on mortality immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. This does not replace current immunity, it builds multiplicatively on top of it. |
{
"Boost_Mortality": 1.0
}
|
Boost_Threshold_Acquire |
float |
0 |
1 |
0 |
Specifies how much acquisition immunity is required before the vaccine changes from a prime to a boost. |
{
"Boost_Threshold_Acquire": 0.0
}
|
Boost_Threshold_Mortality |
float |
0 |
1 |
0 |
Specifies how much mortality immunity is required before the vaccine changes from a prime to a boost. |
{
"Boost_Threshold_Mortality": 0.0
}
|
Boost_Threshold_Transmit |
float |
0 |
1 |
0 |
Specifies how much transmission immunity is required before the vaccine changes from a prime to a boost. |
{
"Boost_Threshold_Transmit": 0.0
}
|
Boost_Transmit |
float |
0 |
1 |
0 |
Specifies the boosting effect on transmission immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. This does not replace current immunity, it builds multiplicatively on top of it. |
{
"Boost_Transmit": 0.5
}
|
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": "MultiEffectBoosterVaccine",
"Intervention_Name": "Tetanus booster shot"
}
}
|
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"
}
|
Prime_Acquire |
float |
0 |
1 |
0 |
Specifies the priming effect on acquisition immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. |
{
"Prime_Acquire": 0.1
}
|
Prime_Mortality |
float |
0 |
1 |
0 |
Specifies the priming effect on mortality immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. |
{
"Prime_Mortality": 0.3
}
|
Prime_Transmit |
float |
0 |
1 |
0 |
Specifies the priming effect on transmission immunity for naive individuals (without natural or vaccine-derived immunity) for a multi-effect booster vaccine. |
{
"Prime_Transmit": 0.2
}
|
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
}
}
}
|
{
"Use_Defaults": 1,
"Campaign_Name": "Generic Seattle Regression Campaign",
"Events": [{
"Event_Coordinator_Config": {
"Demographic_Coverage": 1.0,
"Intervention_Config": {
"Cost_To_Consumer": 10.0,
"Vaccine_Take": 1,
"Prime_Acquire": 0.1,
"Prime_Transmit": 0.2,
"Prime_Mortality": 0.3,
"Boost_Acquire": 0.7,
"Boost_Transmit": 0.5,
"Boost_Mortality": 1.0,
"Boost_Threshold_Acquire": 0.0,
"Boost_Threshold_Transmit": 0.0,
"Boost_Threshold_Mortality": 0.0,
"Acquire_Config": {
"Box_Duration": 100,
"Initial_Effect": 0.5,
"class": "WaningEffectBox"
},
"Transmit_Config": {
"Box_Duration": 100,
"Initial_Effect": 0.5,
"class": "WaningEffectBox"
},
"Mortality_Config": {
"Box_Duration": 100,
"Initial_Effect": 0.5,
"class": "WaningEffectBox"
},
"class": "MultiEffectBoosterVaccine"
},
"Target_Demographic": "Everyone",
"class": "StandardInterventionDistributionEventCoordinator"
},
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 1,
"class": "CampaignEvent"
}]
}