STIBarrier

The STIBarrier intervention is used to reduce the probability of STI or HIV transmission by applying a time-variable probability of condom usage. Each STIBarrier intervention is directed at a specific relationship type, and must be configured as a sigmoid trend over time.

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

Cost_To_Consumer

float

0

999999

10

Determines the unit cost when using the STIBarrier intervention to change defaults from demographics. Note that there is no cost for condoms distributed using demographics-configured default usage probabilities.

 
{
  "Cost_To_Consumer": 1.0
}

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
}

Early

float

0

1

1

The left asymptote for the sigmoid trend over time. The Early value must be smaller than the Late value.

 
{
  "Intervention_Config": {
    "class": "STIBarrier",
    "Early": 0.0,
    "Late": 1.0,
    "Midyear": 1990,
    "Rate": 0.0,
    "Relationship_Type": "TRANSITORY",
    "Cost_To_Consumer": 1.0
  }
}

Intervention_Name

string

NA

NA

STIBarrier

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

Late

float

0

1

1

The right asymptote for the sigmoid trend over time. The Late value must be larger than the Early value.

 
{
  "Intervention_Config": {
    "class": "STIBarrier",
    "Early": 0.0,
    "Late": 1.0,
    "Midyear": 1990,
    "Rate": 0.0,
    "Relationship_Type": "TRANSITORY",
    "Cost_To_Consumer": 1.0
  }
}

MidYear

float

0

1

1

The time of the inflection point in the sigmoid trend over time.

 
{
  "Intervention_Config": {
    "class": "STIBarrier",
    "Early": 0.0,
    "Late": 1.0,
    "Midyear": 1990,
    "Rate": 0.0,
    "Relationship_Type": "TRANSITORY",
    "Cost_To_Consumer": 1.0
  }
}

New_Property_Value

string

NA

NA

“”

An optional IndividualProperty key:value pair that will be assigned when the intervention is applied. 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"
}

Rate

float

0

1

1

The slope of the inflection point in the sigmoid trend over time. A Rate of 1 sets the slope to a 25% change in probability per year. Specify a negative Rate (e.g. -1) to achieve a negative sigmoid.

 
{
  "Intervention_Config": {
    "class": "STIBarrier",
    "Early": 0.0,
    "Late": 1.0,
    "Midyear": 1990,
    "Rate": 0.0,
    "Relationship_Type": "TRANSITORY",
    "Cost_To_Consumer": 1.0
  }
}

Relationship_Type

enum

NA

NA

TRANSITORY

The relationship type to which the condom usage probability is applied. Possible values are:

  • TRANSITORY

  • INFORMAL

  • MARITAL

 
{
  "Intervention_Config": {
    "class": "STIBarrier",
    "Early": 0.0,
    "Late": 1.0,
    "Midyear": 1990,
    "Rate": 0.0,
    "Relationship_Type": "TRANSITORY",
    "Cost_To_Consumer": 1.0
  }
}

Usage_Duration_Constant

float

0

3.40282E+38

6

Each instance will receive this constant/fixed value.

 
{
  "Usage_Duration_Constant": 6
}

Usage_Duration_Distribution

enum

NA

NA

NOT_INITIALIZED

For the distribution of each STIBarrier, a randomly selected duration from this distribution will determine when the man stops using the intervention and revert back to condom usage based on the relationship type. Possible values are:

  • NOT_INITIALIZED

  • CONSTANT_DISTRIBUTION

  • UNIFORM_DISTRIBUTION

  • GAUSSIAN_DISTRIBUTION

  • EXPONENTIAL_DISTRIBUTION

  • POISSON_DISTRIBUTION

  • LOG_NORMAL_DISTRIBUTION

  • DUAL_CONSTANT_DISTRIBUTION

  • WEIBULL_DISTRIBUTION

  • DUAL_EXPONENTIAL_DISTRIBUTION

 
{
  "Usage_Duration_Distribution": "UNIFORM_DISTRIBUTION"
}

Usage_Duration_Exponential

float

0

3.40282E+38

6

The mean for an exponential distribution.

 
{
  "Usage_Duration_Exponential": 2.5
}

Usage_Duration_Gaussian_Mean

float

0

3.40282E+38

6

The mean for a Gaussian distribution.

 
{
  "Usage_Duration_Gaussian_Mean": 6
}

Usage_Duration_Gaussian_Std_Dev

float

1.17549E-38

3.40282E+38

1

The standard deviation for a Gaussian distribution.

 
{
  "Usage_Duration_Gaussian_Std_Dev": 1
}

Usage_Duration_Kappa

float

1.17549E-38

3.40282E+38

1

The shape value in a Weibull distribution.

 
{
  "Usage_Duration_Kappa": 1
}

Usage_Duration_Lambda

float

1.17549E-38

3.40282E+38

1

The scale value in a Weibull distribution.

 
{
  "Usage_Duration_Lambda": 1
}

Usage_Duration_Log_Normal_Mu

float

-3.40282E+38

3.40282E+38

6

The mean for a log-normal distribution.

 
{
  "Usage_Duration_Log_Normal_Mu": 6
}

Usage_Duration_Log_Normal_Sigma

float

-3.40282E+38

3.40282E+38

1

The width for a log-normal distribution.

 
{
  "Usage_Duration_Log_Normal_Sigma": 1
}

Usage_Duration_Max

float

0

3.40282E+38

1

The maximum of the uniform distribution.

 
{
  "Usage_Duration_Max": 1
}

Usage_Duration_Mean_1

float

1.17549E-38

3.40282E+38

1

The mean of the first exponential distribution.

 
{
  "Usage_Duration_Mean_1": 1
}

Usage_Duration_Mean_2

float

1.17549E-38

3.40282E+38

1

The mean of the second exponential distribution.

 
{
  "Usage_Duration_Mean_2": 1
}

Usage_Duration_Min

float

0

3.40282E+38

0

The minimum of the uniform distribution.

 
{
  "Usage_Duration_Min": 0
}

Usage_Duration_Peak_2_Value

float

0

3.40282E+38

1

The value to assign to the remaining individuals.

 
{
  "Usage_Duration_Peak_2_Value": 1
}

Usage_Duration_Poisson_Mean

float

0

3.40282E+38

6

The mean for a Poisson distribution.

 
{
  "Usage_Duration_Poisson_Mean": 6
}

Usage_Duration_Proportion_0

float

0

1

1

The proportion of individuals to assign a value of zero.

 
{
  "Usage_Duration_Proportion_0": 1
}

Usage_Duration_Proportion_1

float

0

1

1

The proportion of individuals in the first exponential distribution.

 
{
  "Usage_Duration_Proportion_1": 1
}

Usage_Expiration_Event

string

NA

NA

“”

When the person stops using the STIBarrier, this event will be broadcasted. See Event list for possible values (note: not all built-in events are applicable), or use a custom event defined in the Custom_Individudual_Events list in the config file.

 
{
  "Usage_Expiration_Event": "HIVTestedPositive"
}

{
    "Campaign_Name": "Baseline campaign for HIV-5 examples",
    "Events": [
        {
            "Event_Coordinator_Config": {
                "Demographic_Coverage": 1.0,
                "Intervention_Config": {
                    "class": "STIBarrier",
                    "Early": 1.0,
                    "Late": 1.0,
                    "Midyear": 1990,
                    "Rate": 1.0,
                    "Relationship_Type": "INFORMAL",
                    "Cost_To_Consumer": 1.0
                },
                "Target_Demographic": "Everyone",
                "class": "StandardInterventionDistributionEventCoordinator"
            },
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Start_Year": 1992,
            "class": "CampaignEventByYear"
        },
        {
            "Event_Coordinator_Config": {
                "Demographic_Coverage": 1.0,
                "Intervention_Config": {
                    "class": "STIBarrier",
                    "Early": 1.0,
                    "Late": 1.0,
                    "Midyear": 1990,
                    "Rate": 1.0,
                    "Relationship_Type": "MARITAL",
                    "Cost_To_Consumer": 1.0
                },
                "Target_Demographic": "Everyone",
                "class": "StandardInterventionDistributionEventCoordinator"
            },
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Start_Year": 1996,
            "class": "CampaignEventByYear"
        }
    ],
    "Use_Defaults": 1
}