CoitalActRiskFactors

The CoitalActRiskFactors intervention class provides a method of modifying an individual’s risk/probability of acquiring or transmitting an STI. If other risk multipliers are active (across other interventions), the values will be multiplied together; the resulting value will be multiplied with any active STI co-infection factors. When the intervention expires, the individual’s risk factor multiplier returns to one. Since this intervention persists, it can be used with a reference tracking event coordinator (see Events and event coordinators for details).

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

Acquisition_Multiplier

float

0

100

1

Multiplier for STI acquisition probability per coital act.

 
{
  "Acquisition_Multiplier": 2
}

Cost_To_Consumer

float

0

999999

10

The unit ‘cost’ assigned to the intervention. Setting Cost_To_Consumer to zero for all other interventions, and to a non-zero amount for one intervention, provides a convenient way to track the number of times the intervention has been applied in a simulation.

 
{
  "Cost_To_Consumer": 1
}

Disqualifying_Properties

array of strings

NA

NA

[]

A list of IndividualProperty key:value pairs that will prevent an intervention from being distributed or 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
}

Expiration_Constant

float

0

3.40282e+38

6

Each instance will receive this constant/fixed value.

 
{
  "Expiration_Constant": 8,
  "Expiration_Distribution": "CONSTANT_DISTRIBUTION"
}

Expiration_Distribution

enum

NA

NA

NOT_INITIALIZED

The distribution type to use for setting the expiration of the intervention. Each assigned value is a random draw from the distribution. 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

 
{
  "Expiration_Distribution": "UNIFORM_DISTRIBUTION"
}

Expiration_Event_Trigger

string

NA

NA

“”

When the intervention expires, this event will be broadcasted. See Event list for possible built-in values, or create custom values using Custom_Individual_Events.

 
{
  "Expiration_Event_Trigger": "My Expiration Event"
}

Expiration_Exponential

float

0

3.40282e+38

6

The mean for an exponential distribution.

 
{
  "Expiration_Exponential": 6
}

Expiration_Gaussian_Mean

float

0

3.40282e+38

6

The mean for a Gaussian distribution.

 
{
  "Expiration_Gaussian_Mean": 6
}

Expiration_Gaussian_Std_Dev

float

1.17549e-38

3.40282e+38

1

The standard deviation for a Gaussian distribution.

 
{
  "Expiration_Gaussian_Std_Dev": 1
}

Expiration_Kappa

float

1.17549e-38

3.40282e+38

1

The shape value in a Weibull distribution.

 
{
  "Expiration_Kappa": 1
}

Expiration_Lambda

float

1.17549e-38

3.40282e+38

1

The scale value in a Weibull distribution.

 
{
  "Expiration_Lambda": 1
}

Expiration_Log_Normal_Mu

float

-3.40282e+38

3.40282e+38

1

The mean for a log-normal distribution.

 
{
  "Expiration_Log_Normal_Mu": 1
}

Expiration_Max

float

0

3.40282e+38

1

The maximum of the uniform distribution.

 
{
  "Expiration_Max": 1
}

Expiration_Mean_1

float

1.17549e-38

3.40282e+38

1

The mean of the first exponential distribution.

 
{
  "Expiration_Mean_1": 1
}

Expiration_Mean_2

float

1.17549e-38

3.40282e+38

1

The mean of the second exponential distribution.

 
{
  "Expiration_Mean_2": 1
}

Expiration_Min

float

0

3.40282e+38

0

The minimum of the uniform distribution.

 
{
  "Expiration_Min": 0
}

Expiration_Peak_2_Value

float

0

3.40282e+38

1

The value to assign to the remaining individuals.

 
{
  "Expiration_Peak_2_Value": 1
}

Expiration_Poisson_Mean

float

0

3.40282e+38

6

The mean for a Poisson distribution.

 
{
  "Expiration_Poisson_Mean": 6
}

Expiration_Proportion_0

float

0

1

1

The proportion of individuals to assign a value of zero.

 
{
  "Expiration_Proportion_0": 1
}

Expiration_Proportion_1

float

0

1

1

The proportion of individuals in the first exponential distribution.

 
{
  "Expiration_Proportion_1": 1
}

Intervention_Name

string

NA

NA

CoitalActRiskFactors

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 intervention",
    "class": "CoitalActRiskFactors"
  }
}

New_Property_Value

string

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

Transmission_Multiplier

float

0

100

1

Multiplier for STI transmission probability per coital act.

 
{
  "Transmission_Multiplier": 1
}

{
    "Use_Defaults": 1,
    "Events": [{
        "class": "CampaignEvent",
        "Start_Day": 40,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Node_Property_Restrictions": [{
                "HasAdministeredSexEducation": "YES"
            }],
            "Intervention_Config": {
                "class": "CoitalActRiskFactors",
                "Intervention_Name" : "MyRiskFactors",
                "Disqualifying_Properties" : [],
                "Dont_Allow_Duplicates" : 1,
                "New_Property_Value" : "",
                "Cost_To_Consumer": 1,
                "Acquisition_Multiplier" : 0.8,
                "Transmission_Multiplier" : 0.8,
                "Expiration_Distribution" : "CONSTANT_DISTRIBUTION",
                "Expiration_Constant" : 6,
                "Expiration_Event_Trigger" : "Risk_Factor_Expired"
            }
        }
    }]
}