AntimalarialDrug

The AntimalarialDrug intervention is used to apply drug-based control efforts to malaria simulations. When configuring this intervention, note that the Malaria_Drug_Params need to be configured, as they govern how particular anti-malarial drugs will behave.

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
Cost_To_Consumer float 0 999999 10 The unit cost per drug (unamortized). 
{    
    "Intervention_Config": {
        "Cost_To_Consumer": 3.75, 
        "Dosing_Type": "FullTreatmentWhenSymptom", 
        "Drug_Type": "Chloroquine", 
        "class": "AntimalarialDrug"
     }
}
Dosing_Type enum NA NA SingleDose

The type of anti-malarial dosing to distribute in a drug intervention. Possible values are:

  • FullTreatmentCourse
  • FullTreatmentParasiteDetect
  • FullTreatmentNewDetectionTech
  • FullTreatmentWhenSymptom
  • Prophylaxis
  • SingleDose
  • SingleDoseNewDetectionTech
  • SingleDoseParasiteDetect
  • SingleDoseWhenSymptom
 
{    
    "Intervention_Config": {
        "Cost_To_Consumer": 3.75, 
        "Dosing_Type": "FullTreatmentWhenSymptom", 
        "Drug_Type": "Chloroquine", 
        "class": "AntimalarialDrug"
     }
}
Drug_Type enum NA NA NA

The type of drug to distribute in a drugs intervention.

Possible values for Malaria are:

  • Artemether_Lumefantrine
  • Artemisinin
  • Chloroquine
  • GenPreerythrocytic
  • GenTransBlocking
  • Primaquine
  • Quinine
  • SP
  • Tafenoquine

The above are the actual values you use in a configuration file. For a list showing the full name for each drug, please see Malaria Drug Efficacy.

 
{    
    "Intervention_Config": {
        "Cost_To_Consumer": 3.75, 
        "Dosing_Type": "FullTreatmentWhenSymptom", 
        "Drug_Type": "Chloroquine", 
        "class": "AntimalarialDrug"
     }
}
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"
}

{
     "Use_Defaults": 1,
     "Events": [{
               "class": "CampaignEvent",
               "Nodeset_Config": {
                    "class": "NodeSetAll"
               },
               "Start_Day": 270,
               "Event_Coordinator_Config": {
                    "class": "StandardInterventionDistributionEventCoordinator",
                    "Target_Demographic": "Everyone",
                    "Demographic_Coverage": 0.8,
                    "Intervention_Config": {
                         "class": "AntimalarialDrug",
                         "Cost_To_Consumer": 3.75,
                         "Dosing_Type": "FullTreatmentWhenSymptom",
                         "Drug_Type": "Chloroquine"
                    }
               }
          },
          {
               "class": "CampaignEvent",
               "Nodeset_Config": {
                    "class": "NodeSetAll"
               },
               "Start_Day": 300,
               "Event_Coordinator_Config": {
                    "class": "StandardInterventionDistributionEventCoordinator",
                    "Target_Demographic": "Everyone",
                    "Demographic_Coverage": 0.8,
                    "Intervention_Config": {
                         "class": "AntimalarialDrug",
                         "Cost_To_Consumer": 3.75,
                         "Dosing_Type": "FullTreatmentParasiteDetect",
                         "Drug_Type": "Chloroquine"
                    }
               }
          }
     ]
}