BCGVaccine¶
The BCGVaccine intervention class includes vaccination in the simulation. Vaccination can reduce the likelihood of infection or transmission of pathogens. This intervention adds further functionality to vaccination by including the ability to vary vaccine take with age.
Note
Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. 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 |
|---|---|---|---|---|---|---|
Vaccine_Take_Age_Decay_Rate |
float |
-3.40E+3 |
3.40E+3 |
1 |
The exponential decline in vaccine take over time. The rate of decline is in units of 1/years. |
{
"Vaccine_Take_Age_Decay_Rate": 0.2
}
|
Cost_To_Consumer |
float |
0 |
999999 |
10 |
The unit cost per vaccine (unamortized). |
{
"Cost_To_Consumer": 10.0
}
|
Efficacy_Is_Multiplicative |
boolean |
NA |
NA |
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
}
}
}
|
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"
}
}
|
Reduced_Transmit |
float |
0 |
1 |
1 |
The transmission reduction ratio, or the reduced infectiousness when an individual receives drugs. |
{
"Intervention_Config": {
"Cost_To_Consumer": 1,
"Drug_Type": "FirstLineCombo",
"Durability_Profile": "FIXED_DURATION_CONSTANT_EFFECT",
"Primary_Decay_Time_Constant": 10,
"Remaining_Doses": 1,
"TB_Drug_Clearance_Rate": 0.1,
"TB_Drug_Inactivation_Rate": 0.00000001,
"TB_Drug_Resistance_Rate": 0.000000001,
"TB_Drug_Relapse_Rate": 0.0000001,
"Reduced_Transmit": 1,
"class": "AntiTBDrug"
}
}
|
Primary_Decay_Time_Constant |
float |
0 |
1.00E+0 |
0 |
The primary decay time constant (in days) of the decay profile. |
{
"Primary_Decay_Time_Constant": 180
}
|
Secondary_Decay_Time_Constant |
float |
0 |
999999 |
1 |
The secondary decay time constant of the durability profile. This parameter is used when Durability_Profile is set to CONCENTRATION_VERSUS_TIME. |
{
"Durability_Profile": "CONCENTRATION_VERSUS_TIME",
"Secondary_Decay_Time_Constant": 730
}
|
Dont_Allow_Duplicates |
boolean |
NA |
NA |
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
}
|
Disqualifying_Properties |
string |
NA |
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"
]
}
|
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_Name":"Diagnostic_Sample"
}
|
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"
}
|
{
"Events": [
{
"class": "CampaignEvent",
"Event_Name": "vaccination for all new births",
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 1,
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Number_Repetitions": 1,
"Property_Restrictions": [],
"Target_Demographic": "Everyone",
"Demographic_Coverage": 1,
"Include_Arrivals": 0,
"Include_Departures": 0,
"Intervention_Config": {
"class": "NodeLevelHealthTriggeredIV",
"Actual_IndividualIntervention_Config": {
"Cost_To_Consumer": 1,
"Vaccine_Take": 1,
"Vaccine_Take_Age_Decay_Rate": 0,
"Vaccine_Type": "AcquisitionBlocking",
"class": "BCGVaccine",
"Waning_Config": {
"class": "WaningEffectBox",
"Initial_Effect": 1,
"Box_Duration": 5475
}
},
"Trigger_Condition_List": [
"Births"
]
}
}
}
],
"Use_Defaults": 1
}