TBHIVConfigurableTBdrug

The TBHIVConfigurableTBdrug class is an individual level intervention for TB treatment. The intervention applies TB drug effects to the progression, associated mortality, transmission, and acquisition of TB infections in HIV positive and negative individuals.

All drugs must be configured in the configuration file under TBHIV_Drug_Types and TBHIV_Drug_Params (see Drugs and treatments parameters for more information).

The sum of all daily probabilities for state changes (for example, active to cured) and the total duration of treatment specify the probability that any event occurs. If no event occurs, the individual fails drug treatment.

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 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

Active_Multiplier

array of floats

0

1

1

Multiplier of clearance/inactivation if active TB on drug treatment. Relapse, mortality, and resistance apply only to active.

 
{
    "Active_Multiplier": 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 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
}

Dose_Interval

float

0

99999

1

The interval between doses, in days.

 
{
    "Dose_Interval": 1
}

Drug_Cmax

float

0

10000

1

The maximum drug concentration that can be used, and is in the same units as Drug_PKPD_C50. Since drug concentrations and C50 values are often specified with different unit systems, these two parameters have been designed to be flexible provided that the units are the same for each. This parameter is used when Durability_Profile is set to CONCENTRATION_VERSUS_TIME.

 
{
    "Durability_Profile": "CONCENTRATION_VERSUS_TIME",
    "Drug_Cmax": 200,
    "Drug_PKPD_C50": 6,
    "Drug_Vd": 1
}

Drug_PKPD_C50

float

0

10000

1

The concentration at which drug killing rates are half of the maximum. Must use the same units as Drug_Cmax. This parameter is used when Durability_Profile is set to CONCENTRATION_VERSUS_TIME.

 
{
    "Durability_Profile": "CONCENTRATION_VERSUS_TIME",
    "Drug_Cmax": 200,
    "Drug_PKPD_C50": 6,
    "Drug_Vd": 1
}

Drug_Vd

float

0

10000

1

The volume of drug distribution. This value is the ratio of the volume of the second compartment to the volume of the first compartment in a two-compartment model, and is dimensionless. This parameter is used when Durability_Profile is set to CONCENTRATION_VERSUS_TIME.

 
{
    "Durability_Profile": "CONCENTRATION_VERSUS_TIME",
    "Drug_Cmax": 200,
    "Drug_PKPD_C50": 6,
    "Drug_Vd": 1
}

Durability_Profile

enum

NA

NA

FIXED_DURATION_CONSTANT_EFFECT

The profile of durability decay. Possible values are:

FIXED_DURATION_CONSTANT_EFFECT

The durability does not decay.

CONCENTRATION_VERSUS_TIME

Conditionally loads the following parameters: Drug_Cmax, Drug_PKPD_C50, and Drug_Vd.

 
{
    "Durability_Profile": "CONCENTRATION_VERSUS_TIME",
    "Drug_Cmax": 200,
    "Drug_PKPD_C50": 6,
    "Drug_Vd": 1
}

Fraction_Defaulters

float

0

1

0

The fraction of individuals who will not finish their drug treatment.

 
{
    "Fraction_Defaulters": 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": "TBHIVConfigurableTBdrug",
        "Intervention_Name": "Isoniazid distribution"
    }
}

Latency_Multiplier

array of floats

0

1

1

Multiplier of clearance/inactivation if latent TB on drug treatment for the TB drug cure rate parameters (TB_Drug_Cure_Rate, TB_Drug_Cure_Rate_MDR, TB_Drug_Cure_Rate_HIV ) and the TB drug inactivation rate parameters (TB_Drug_Inactivation_Rate, TB_Drug_Inactivation_Rate_MDR, TB_Drug_Inactivation_Rate_HIV).

 
{
    "Latency_Multiplier": 1
}

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"
}

Primary_Decay_Time_Constant

float

0

1.00E+00

0

The primary decay time constant (in days) of the decay profile.

 
{
    "Primary_Decay_Time_Constant": 180
}

Remaining_Doses

integer

0

999999

0

The remaining doses in an intervention; enter a negative number for unlimited doses.

 
{
    "Remaining_Doses": 1
}

Secondary_Decay_Time_Constant

float

0

999999

1

The secondary decay time constant of the durability profile. This parameter is used when Durability_Profile is set to CONCENTRATION_VERSUS_TIME.

 
{
    "Durability_Profile": "CONCENTRATION_VERSUS_TIME",
    "Secondary_Decay_Time_Constant": 730
}

TB_Drug_Name

string

NA

NA

NA

The name of TB drug used in the TBHIVConfigurationTBdrug intervention. This must be one of the listed drugs as specificed under TBHIV_Drug_Types in the configuration file.

 
{
    "Active_Multiplier": 1,
    "Durability_Profile": "FIXED_DURATION_CONSTANT_EFFECT",
    "Latency_Multiplier": 1,
    "Remaining_Doses": 1,
    "TB_Drug_Name": "PreDOTSLowNoMDR",
    "class": "TBHIVConfigurableTBdrug"
}

TB_Reduced_Acquire

array of floats

0

1

0

Proportion reduction in acquisition of new TB infection under drug treatment. Only relevant when TB_Enable_Exogenous is enabled to allow exogenous re-infection.

 
{
    "TBHIV_Drug_Params": {
        "ACFDOTS": {
            "TB_Drug_Cure_Rate": 0.25,
            "TB_Drug_Inactivation_Rate": 1e-09,
            "TB_Drug_Inactivation_Rate_HIV": 1e-09,
            "TB_Drug_Inactivation_Rate_MDR": 1e-09,
            "TB_Drug_Mortality_Rate": 1e-09,
            "TB_Drug_Mortality_Rate_HIV": 1e-09,
            "TB_Drug_Mortality_Rate_MDR": 1e-09,
            "TB_Drug_Primary_Decay_Time_Constant": 179,
            "TB_Drug_Relapse_Rate": 1e-09,
            "TB_Drug_Relapse_Rate_HIV": 1e-09,
            "TB_Drug_Relapse_Rate_MDR": 1e-09,
            "TB_Drug_Resistance_Rate": 1e-09,
            "TB_Drug_Resistance_Rate_HIV": 1e-09,
            "TB_Reduced_Acquire": 1,
            "TB_Reduced_Transmit": 1,
            "TB_Drug_Cure_Rate_HIV": 0,
            "TB_Drug_Cure_Rate_MDR": 0
        }
    }
}

TB_Reduced_Transmit

array of floats

0

1

0

Proportion reduction in TB transmission under drug treatment. The value scales the Base_Infectivity parameter.

 
{
    "TBHIV_Drug_Params": {
        "ACFDOTS": {
            "TB_Drug_Cure_Rate": 0.25,
            "TB_Drug_Inactivation_Rate": 1e-09,
            "TB_Drug_Inactivation_Rate_HIV": 1e-09,
            "TB_Drug_Inactivation_Rate_MDR": 1e-09,
            "TB_Drug_Mortality_Rate": 1e-09,
            "TB_Drug_Mortality_Rate_HIV": 1e-09,
            "TB_Drug_Mortality_Rate_MDR": 1e-09,
            "TB_Drug_Primary_Decay_Time_Constant": 179,
            "TB_Drug_Relapse_Rate": 1e-09,
            "TB_Drug_Relapse_Rate_HIV": 1e-09,
            "TB_Drug_Relapse_Rate_MDR": 1e-09,
            "TB_Drug_Resistance_Rate": 1e-09,
            "TB_Drug_Resistance_Rate_HIV": 1e-09,
            "TB_Reduced_Acquire": 1,
            "TB_Reduced_Transmit": 1,
            "TB_Drug_Cure_Rate_HIV": 0,
            "TB_Drug_Cure_Rate_MDR": 0
        }
    }
}

{
    "Event_Coordinator_Config": {
        "Demographic_Coverage": 1.0,
        "Number_Repetitions": 1,
        "Timesteps_Between_Repetitions": 0,
        "Target_Demographic": "Everyone",
        "Intervention_Config": {
            "Remaining_Doses": 1,
            "TB_Drug_Name": "ACFDOTS",
            "class": "TBHIVConfigurableTBdrug"
        },
        "class": "StandardInterventionDistributionEventCoordinator"
    },
    "Event_Name": "Configurable AntiTBDrug: InterventionUnderTest",
    "Nodeset_Config": {
        "class": "NodeSetAll"
    },
    "Start_Day": 20,
    "class": "CampaignEvent"
}