ARTMortalityTable#
The ARTMortalityTable intervention class allows the user to modify an individual’s life expectancy based on different levels of ART adherence; the user defines parameters for age, CD4 count, and time on ART in a multi-dimensional table which is then used to determine mortality rate. Note: If you have have different adherence levels for each gender, then you will need to configure your campaign to distribute an ARTMortalityTable for each gender and adherence level.
Additional considerations when using this intervention:
The model will not allow someone who is HIV negative to be put on ART.
A person who has not previously been on ART is considered to be ‘starting ART’ at the time this intervention is applied; the model will track this start time/duration.
If a person is already on ART from another intervention, receiving a second ART intervention will have no effect.
If a person is on already ART and receives the ARTMortalityTable intervention, the original ART start time will be used to calculate the duration from enrollment to ART AIDS Death. The duration since starting ART will not change; it will continue to increase.
If a person is on ART and receives the ARTDropout intervention, the person will go off ART and the duration will be reset; if receiving a new ART intervention, this new start time/duration will be used in any calculations.
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 |
|---|---|---|---|---|---|---|
Age_Years_Bins |
array of floats |
0 |
125 |
[] |
An array of bins representing the age of the person, in years, at the time they received the intervention (greater than or equal to the value of the bin, but less than the value of the next bin). If they are new to ART, then it is the age that they started ART. If they are changing their adherence, then it is the age at that time. This bin is used to select the second dimension of the MortalityTable. |
{
"Age_Years_Bins": [
0,
20,
30,
40,
50
]
}
|
ART_Duration_Days_Bins |
array of floats |
0 |
3.40282e+38 |
[] |
An array of bins representing the person’s duration on ART, in days (greater than or equal to the value of the bin, but less than the value of the next bin). Each value represents the outer dimension of the MortalityTable. |
{
"ART_Duration_Days_Bins": [
0,
30,
60,
90,
120
]
}
|
ART_Is_Active_Against_Mortality_And_Transmission |
boolean |
0 |
1 |
1 |
If set to true (1), ART will suppress viral load and extend prognosis. |
{
"ART_Is_Active_Against_Mortality_And_Transmission": 1
}
|
ART_Multiplier_On_Transmission_Prob_Per_Act |
float |
0 |
1 |
0.08 |
Multiplier acting on Base_Infectivity to determine the per-act transmission probability of a virally suppressed HIV+ individual. |
{
"ART_Multiplier_On_Transmission_Prob_Per_Act": 0.08
}
|
CD4_Count_Bins |
array of floats |
0 |
1000 |
[] |
An array of bins representing a person’s CD4 count at the time they received the intervention (started ART or changed adherence). For each value in the array, there will be one value in the associated row in the MortalityTable. A mortality rate will be selected from the table as follows:
|
{
"CD4_Count_Bins": [
0,
200,
400,
600,
800,
1000
]
}
|
Cost_To_Consumer |
float |
0 |
99999 |
1 |
Unit cost per drug (unamortized). |
{
"Cost_To_Consumer": 1
}
|
Days_To_Achieve_Viral_Suppression |
float |
0 |
3.40282e+38 |
183 |
The number of days after ART initiation over which infectiousness declines linearly until the ART_Multiplier_On_Transmission_Prob_Per_Act takes full effect. |
{
"Days_To_Achieve_Viral_Suppression": 183
}
|
Disqualifying_Properties |
array of strings |
NA |
NA |
[] |
A list of IndividualProperty key:value pairs that will prevent an intervention from being distributed, applied/updated. 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 |
ARTMortalityTable |
The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. |
{
"Intervention_Config": {
"Intervention_Name": "My ART Mortality Table",
"class": "ARTMortalityTable"
}
}
|
MortalityTable |
array of floats |
0 |
1 |
[] |
Three-dimensional array of mortality rates used to determine the number of days until AIDS death. Dimensioned by the values specified in ART_Duration_Days_Bins, Age_Years_Bins, and CD4_Count_Bins. |
{
"MortalityTable": [
[
[
0.2015,
0.2015,
0.1128,
0.0625,
0.0312,
0.0206,
0.0162
],
[
0.0875,
0.0875,
0.049,
0.0271,
0.0136,
0.0062,
0.0041
]
],
[
[
0.0271,
0.0271,
0.0184,
0.0149,
0.0074,
0.0048,
0.0048
],
[
0.0171,
0.0171,
0.0116,
0.0094,
0.0047,
0.003,
0.003
]
],
[
[
0.0119,
0.0119,
0.0081,
0.0066,
0.0033,
0.0033,
0.0033
],
[
0.0119,
0.0119,
0.0081,
0.0066,
0.0033,
0.0033,
0.0033
]
],
[
[
0.0119,
0.0119,
0.0081,
0.0066,
0.0033,
0.0033,
0.0033
],
[
0.0119,
0.0119,
0.0081,
0.0066,
0.0033,
0.0033,
0.0033
]
],
[
[
0.0119,
0.0119,
0.0081,
0.0066,
0.0033,
0.0033,
0.0033
],
[
0.0119,
0.0119,
0.0081,
0.0066,
0.0033,
0.0033,
0.0033
]
]
]
}
|
New_Property_Value |
string |
NA |
NA |
“” |
An optional IndividualProperty key:value pair that will be assigned when the intervention is first applied/updated. 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"
}
|
{
"class": "ARTMortalityTable",
"Cost_To_Consumer" : 1,
"ART_Multiplier_On_Transmission_Prob_Per_Act" : 0.08,
"ART_Is_Active_Against_Mortality_And_Transmission" : 1,
"Days_To_Achieve_Viral_Suppression" : 183.0,
"ART_Duration_Bins" : [ 0, 6, 12, 24, 36 ],
"Age_Bins" : [ 0, 40 ],
"CD4_Count_Bins" : [ 0, 25, 74.5, 149.5, 274.5, 424.5, 624.5 ],
"MortalityTable" :
[
[
[ 0.2015, 0.2015, 0.1128, 0.0625, 0.0312, 0.0206, 0.0162 ],
[ 0.0875, 0.0875, 0.0490, 0.0271, 0.0136, 0.0062, 0.0041 ]
],
[
[ 0.0271, 0.0271, 0.0184, 0.0149, 0.0074, 0.0048, 0.0048 ],
[ 0.0171, 0.0171, 0.0116, 0.0094, 0.0047, 0.0030, 0.0030 ]
],
[
[ 0.0119, 0.0119, 0.0081, 0.0066, 0.0033, 0.0033, 0.0033 ],
[ 0.0119, 0.0119, 0.0081, 0.0066, 0.0033, 0.0033, 0.0033 ]
],
[
[ 0.0119, 0.0119, 0.0081, 0.0066, 0.0033, 0.0033, 0.0033 ],
[ 0.0119, 0.0119, 0.0081, 0.0066, 0.0033, 0.0033, 0.0033 ]
],
[
[ 0.0119, 0.0119, 0.0081, 0.0066, 0.0033, 0.0033, 0.0033 ],
[ 0.0119, 0.0119, 0.0081, 0.0066, 0.0033, 0.0033, 0.0033 ]
]
]
}