AdherentDrug¶
The AdherentDrug class extends AntiMalarialDrug class and allows for incorporating different patterns of adherence to taking the drug.
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 |
|---|---|---|---|---|---|---|
Adherence_Config |
JSON object |
NA |
NA |
NA |
Configuration for the probability of taking a dose of the specified anti-malarial. Use a waning effect class, Waning effect classes, to specify how this probability changes over time. |
{
"Adherence_Config": {
"class": "WaningEffectMapCount",
"Initial_Effect": 1.0,
"Durability_Map": {
"Times": [
1.0,
2.0,
3.0,
4.0
],
"Values": [
0.1,
0.1,
0.1,
0.1
]
}
}
}
|
Cost_To_Consumer |
float |
0 |
99999 |
1 |
The unit cost per drug (unamortized). |
{
"Cost_To_Consumer": 10
}
|
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 nodes 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
}
|
Dosing_Type |
enum |
NA |
NA |
SingleDose |
The type of anti-malarial dosing to distribute in a drug intervention. Possible values are:
|
{
"Intervention_Config": {
"Cost_To_Consumer": 3.75,
"Dosing_Type": "FullTreatmentWhenSymptom",
"Drug_Type": "Chloroquine",
"class": "AntimalarialDrug"
}
}
|
Intervention_Name |
string |
NA |
NA |
AdherentDrug |
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": "AdherentDrug",
"Intervention_Name": "Isoniazid with mediocre adherence"
}
}
|
Max_Dose_Consideration_Duration |
float |
1.0/24.0 (1hr) |
3.40E+03 |
3.40E+03 |
The maximum number of days that an individual will consider taking the doses of the drug. |
{
"class": "AdherentDrug",
"Cost_To_Consumer": 1,
"Drug_Type": "TestDrug",
"Dosing_Type": "FullTreatmentCourse",
"Adherence_Config": {
"class": "WaningEffectMapCount",
"Initial_Effect": 1.0,
"Durability_Map": {
"Times": [
1.0,
2.0,
3.0
],
"Values": [
1.0,
0.0,
1.0
]
}
},
"Non_Adherence_Options": [
"NEXT_DOSAGE_TIME"
],
"Non_Adherence_Distribution": [
1.0
],
"Max_Dose_Consideration_Duration": 4,
"Took_Dose_Event": "NewClinicalCase"
}
|
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"
}
|
Non_Adherence_Distribution |
array of floats |
0 |
1 |
0 |
The non adherence probability value(s) assigned to the corresponding options in Non_Adherence_Options. The sum of non adherence distribution values must equal a total of 1. |
{
"Non_Adherence_Distribution": [
0.7,
0.3
]
}
|
Non_Adherence_Options |
array of strings |
NA |
NA |
NEXT_UPDATE |
Defines the action the person takes if they do not take a particular dose, are not adherent. |
{
"AD_Non_Adherence_Options": [
"NEXT_DOSAGE_TIME",
"NEXT_UPDATE"
]
}
|
Took_Dose_Event |
string |
NA |
NA |
“” |
The event that triggers the drug intervention campaign. The events contained in the list can be built-in events (see Event list for possible events). |
{
"class": "AdherentDrug",
"Cost_To_Consumer": 1,
"Drug_Type": "TestDrug",
"Dosing_Type": "FullTreatmentCourse",
"Adherence_Config": {
"class": "WaningEffectMapCount",
"Initial_Effect": 1.0,
"Durability_Map": {
"Times": [
1.0,
2.0,
3.0
],
"Values": [
1.0,
0.0,
1.0
]
}
},
"Non_Adherence_Options": [
"NEXT_DOSAGE_TIME"
],
"Non_Adherence_Distribution": [
1.0
],
"Max_Dose_Consideration_Duration": 4,
"Took_Dose_Event": "NewClinicalCase"
}
|
{
"class": "AdherentDrug",
"Cost_To_Consumer": 1,
"Drug_Type": "TestDrug",
"Dosing_Type": "FullTreatmentCourse",
"Adherence_Config" : {
"class": "WaningEffectMapCount",
"Initial_Effect" : 1.0,
"Durability_Map" : {
"Times" : [ 1.0, 2.0, 3.0 ],
"Values" : [ 1.0, 0.0, 1.0 ]
}
},
"Non_Adherence_Options" : [ "NEXT_DOSAGE_TIME" ],
"Non_Adherence_Distribution" : [ 1.0 ],
"Max_Dose_Consideration_Duration" : 4,
"Took_Dose_Event" : "NewClinicalCase"
}