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 MultiEffectVaccine instead.
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 | 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
}
}
}
|
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
}
}
}
|
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
}
|
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"
}
}
|
Cost_To_Consumer | float | 0 | 999999 | 10 | The unit cost per vaccine (unamortized). | {
"Cost_To_Consumer": 10.0
}
|
Event_Or_Config | enum | NA | NA | Config | Specifies whether the current intervention (or a positive diagnosis, depending on the intervention class) distributes a nested intervention (the Config option) or an event will be broadcast which may trigger other interventions in the campaign file (the Event option). Possible values are:
|
{
"Event_Or_Config": "Config"
}
|
Base_Sensitivity | float | 0 | 1 | 1 | The sensitivity of the diagnostic. This sets the proportion of the time that individuals with the condition being tested receive a positive diagnostic test. When set to 1, the diagnostic always accurately reflects the condition. When set to zero, then individuals who have the condition always receive a false-negative diagnostic test. | {
"Base_Sensitivity": 0.8
}
|
Base_Specificity | float | 0 | 1 | 1 | The specificity of the diagnostic. This sets the proportion of the time that individuals without the condition being tested receive a negative diagnostic test. When set to 1, the diagnostic always accurately reflects the lack of having the condition. When set to zero, then individuals who do not have the condition always receive a false-positive diagnostic test. | {
"Base_Specificity": 0.9
}
|
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"
}
|
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"
}
|
{
"Events": [{
"class": "CampaignEvent",
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 60,
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Target_Demographic": "Everyone",
"Demographic_Coverage": 0.5,
"Intervention_Config": {
"class": "SimpleVaccine",
"Cost_To_Consumer": 10.0,
"Reduced_Transmit": 0,
"Vaccine_Take": 1,
"Vaccine_Type": "AcquisitionBlocking",
"Waning_Config": {
"Box_Duration": 3650,
"Initial_Effect": 1,
"class": "WaningEffectBox"
}
}
}
}],
"Use_Defaults": 1
}