TyphoidVaccine¶
The TyphoidVaccine intervention class is a subclass of SimpleVaccine so it contains all functionality of SimpleVaccine, but also provides the ability to configure the mode (shedding, dose, exposures) of contact transmission of typhoid for vaccine campaigns. For more information about mode, see the ‘Mode’ parameter for TyphoidVaccine.
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 |
Data type |
Minimum |
Maximum |
Default |
Description |
Example |
|---|---|---|---|---|---|---|
Changing_Effect |
JSON object |
NA |
NA |
NA |
A highly configurable effect that changes over time. Specify how this effect decays over time using one of the Waning effect classes. |
{
"Intervention_Config": {
"Changing_Effect": {
"Durability_Map": {
"Times": [
0,
10,
11,
20,
21,
26,
27,
33,
34,
40
],
"Values": [
0,
0,
1,
1,
0,
0,
1,
1,
0,
0
]
},
"Expire_At_Durability_Map_End": 1,
"Initial_Effect": 1,
"class": "WaningEffectMapLinear"
},
"Effect": 1,
"Mode": "Dose",
"Target_Demographic": "Everyone",
"class": "TyphoidVaccine"
}
}
|
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
}
|
Effect |
float |
0 |
1 |
1 |
The efficacy of the Typhoid vaccine intervention. For example, a value of 1 would be 100 percent efficacy for all targeted nodes within the intervention. |
{
"Intervention_Config": {
"Changing_Effect": {
"Durability_Map": {
"Times": [
0,
10,
11,
20,
21,
26,
27,
33,
34,
40
],
"Values": [
0,
0,
1,
1,
0,
0,
1,
1,
0,
0
]
},
"Expire_At_Durability_Map_End": 1,
"Initial_Effect": 1,
"class": "WaningEffectMapLinear"
},
"Effect": 1,
"Mode": "Dose",
"Target_Demographic": "Everyone",
"class": "TyphoidVaccine"
}
}
|
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": "TyphoidVaccine",
"Intervention_Name": "Country-wide vaccination campaign"
}
}
|
Mode |
enum |
NA |
NA |
Shedding |
The mode of contact transmission of typhoid targeted by the intervention. Possible values are:
|
{
"Intervention_Config": {
"Changing_Effect": {
"Durability_Map": {
"Times": [
0,
10,
11,
20,
21,
26,
27,
33,
34,
40
],
"Values": [
0,
0,
1,
1,
0,
0,
1,
1,
0,
0
]
},
"Expire_At_Durability_Map_End": 1,
"Initial_Effect": 1,
"class": "WaningEffectMapLinear"
},
"Effect": 1,
"Mode": "Dose",
"Target_Demographic": "Everyone",
"class": "TyphoidVaccine"
}
}
|
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"
}
|
{
"Intervention_Config": {
"Changing_Effect": {
"Durability_Map": {
"Times": [
0,
10,
11,
20,
21,
26,
27,
33,
34,
40
],
"Values": [
0,
0,
1,
1,
0,
0,
1,
1,
0,
0
]
},
"Expire_At_Durability_Map_End": 1,
"Initial_Effect": 1,
"class": "WaningEffectMapLinear"
},
"Effect": 1,
"Mode": "Dose",
"Target_Demographic": "Everyone",
"class": "TyphoidVaccine"
}
}