RTSSVaccine¶
The RTSSVaccine intervention class protects individuals against infection acquisition by directly boosting the circumsporozoite protein (CSP) antibody concentration. This contrasts with the SimpleVaccine intervention, which is used to modify the probability of acquisition or transmission.
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 |
---|---|---|---|---|---|---|
Antibody_Type |
enum |
NA |
NA |
CSP |
The antibody type used to determine immune response targets. Possible values are:
|
{
"Intervention_Config": {
"Antibody_Type": "CSP",
"Antibody_Variant": 0,
"Boosted_Antibody_Concentration": 1200,
"Cost_To_Consumer": 1.0,
"class": "RTSSVaccine"
}
}
|
Antibody_Variant |
integer |
0 |
2.15E+0 |
0 |
The antibody variant index. |
{
"Intervention_Config": {
"Antibody_Type": "CSP",
"Antibody_Variant": 0,
"Boosted_Antibody_Concentration": 1200,
"Cost_To_Consumer": 1.0,
"class": "RTSSVaccine"
}
}
|
Boosted_Antibody_Concentration |
float |
0 |
1.00E+0 |
1 |
The boosted antibody concentration, where unity equals maximum from natural exposure. |
{
"Intervention_Config": {
"Antibody_Type": "CSP",
"Antibody_Variant": 0,
"Boosted_Antibody_Concentration": 1200,
"Cost_To_Consumer": 1.0,
"class": "RTSSVaccine"
}
}
|
Cost_To_Consumer |
float |
0 |
999999 |
3.75 |
The unit cost of RTS,S vaccination (unamortized). |
{
"Intervention_Config": {
"Antibody_Type": "CSP",
"Antibody_Variant": 0,
"Boosted_Antibody_Concentration": 1200,
"Cost_To_Consumer": 1.0,
"class": "RTSSVaccine"
}
}
|
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": "RTSSVaccine",
"Intervention_Name": "CSP boosting vaccine campaign"
}
}
|
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",
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Start_Day": 20,
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Target_Demographic": "Everyone",
"Demographic_Coverage": 0.8,
"Intervention_Config": {
"class": "RTSSVaccine",
"Antibody_Type": "CSP",
"Antibody_Variant": 0,
"Boosted_Antibody_Concentration": 1200,
"Cost_To_Consumer": 1.0
}
}
}],
"Use_Defaults": 1
}