Skip to content

FemaleContraceptive

The FemaleContraceptive intervention class models contraceptive use among women. It is an individual-level intervention that reduces fertility for a configurable duration with a configurable waning efficacy. The Usage_Duration_Distribution determines how long each woman uses the contraceptive, and the Waning_Config controls how the efficacy changes over that period. When a woman stops using the contraceptive, the Usage_Expiration_Event is broadcast.

This intervention applies only when Birth_Rate_Dependence in config.json is set to "INDIVIDUAL_PREGNANCIES" or "INDIVIDUAL_PREGNANCIES_BY_AGE_AND_YEAR".

At a glance:

  • Distributed to: Individuals (females only)
  • Serialized: Yes. It will be preserved when starting from a serialized file.
  • Time-based expiration: Yes. It expires when the usage duration expires, which is determined by the Usage_Duration_Distribution.
  • Purge existing: No. Adding a new intervention of this class will not remove any existing interventions and efficacies will combine as birth_modifier *= new_birth_modifier.

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 Type Min Max Default Description
Cost_To_Consumer float 0 999999 0 The unit cost per intervention distributed. 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.
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 IndividualProperties and NodeProperties 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.
Dont_Allow_Duplicates bool NA NA 0 If set to true (1), does not allow any new interventions with matching Intervention_Name parameter value to be distributed to the individual.
Intervention_Name string NA NA FemaleContraceptive The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.
New_Property_Value string NA NA "" An optional IndividualProperty key:value pair that will be assigned when the intervention is applied. See IndividualProperties and NodeProperties 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.
Usage_Duration_Constant float 0 3.40282E+38 6 The duration value to use for all instances, in days, when Usage_Duration_Distribution is set to CONSTANT_DISTRIBUTION.
Usage_Duration_Distribution enum NA NA NOT_INITIALIZED The distribution type to use for assigning the usage duration. For each contraceptive distributed, a randomly selected duration from this distribution will determine when the woman stops using the contraceptive. This is independent of how long the contraceptive is effective.
Possible values are:
NOT_INITIALIZED
No distribution set. This is not a valid option and will cause an error.
CONSTANT_DISTRIBUTION
Use the same value for each individual. Set Usage_Duration_Constant.
UNIFORM_DISTRIBUTION
Use a uniform distribution with a given minimum and maximum. Set Usage_Duration_Max and Usage_Duration_Min.
GAUSSIAN_DISTRIBUTION
The distribution is Gaussian (or normal). Values are resampled to ensure >= 0. Set Usage_Duration_Gaussian_Mean and Usage_Duration_Gaussian_Std_Dev.
EXPONENTIAL_DISTRIBUTION
The distribution is exponential with a given mean. Set Usage_Duration_Exponential.
WEIBULL_DISTRIBUTION
Use a Weibull distribution with a given shape and scale. Set Usage_Duration_Kappa and Usage_Duration_Lambda.
LOG_NORMAL_DISTRIBUTION
Use a log-normal distribution with a given mean and width. Set Usage_Duration_Log_Normal_Mu and Usage_Duration_Log_Normal_Sigma.
POISSON_DISTRIBUTION
Use a Poisson distribution with a given mean. Set Usage_Duration_Poisson_Mean.
DUAL_CONSTANT_DISTRIBUTION
Use a distribution where some individuals are set to a value of zero and the rest to a given value. Set Usage_Duration_Proportion_0 and Usage_Duration_Peak_2_Value. This distribution does not use the parameters set for CONSTANT_DISTRIBUTION.
DUAL_EXPONENTIAL_DISTRIBUTION
Use two exponential distributions with given means. Set Usage_Duration_Mean_1, Usage_Duration_Mean_2, and Usage_Duration_Proportion_1. This distribution does not use the parameters set for EXPONENTIAL_DISTRIBUTION.
Usage_Duration_Exponential float 0 3.40282E+38 6 The mean of the usage duration, in days, when Usage_Duration_Distribution is set to EXPONENTIAL_DISTRIBUTION.
Usage_Duration_Gaussian_Mean float 0 3.40282E+38 6 The mean of the usage duration, in days, when Usage_Duration_Distribution is set to GAUSSIAN_DISTRIBUTION.
Usage_Duration_Gaussian_Std_Dev float 1.17549E-38 3.40282E+38 1 The standard deviation of the usage duration, in days, when Usage_Duration_Distribution is set to GAUSSIAN_DISTRIBUTION.
Usage_Duration_Kappa float 1.17549E-38 3.40282E+38 1 The shape value for the usage duration, in days, when Usage_Duration_Distribution is set to WEIBULL_DISTRIBUTION.
Usage_Duration_Lambda float 1.17549E-38 3.40282E+38 1 The scale value for the usage duration, in days, when Usage_Duration_Distribution is set to WEIBULL_DISTRIBUTION.
Usage_Duration_Log_Normal_Mu float -3.40282E+38 3.40282E+38 6 The mean of the usage duration, in days, when Usage_Duration_Distribution is set to LOG_NORMAL_DISTRIBUTION.
Usage_Duration_Log_Normal_Sigma float -3.40282E+38 3.40282E+38 1 The width of the usage duration, in days, when Usage_Duration_Distribution is set to LOG_NORMAL_DISTRIBUTION.
Usage_Duration_Max float 0 3.40282E+38 1 The maximum usage duration, in days, when Usage_Duration_Distribution is set to UNIFORM_DISTRIBUTION.
Usage_Duration_Mean_1 float 1.17549E-38 3.40282E+38 1 The mean of the first exponential distribution, in days, when Usage_Duration_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.
Usage_Duration_Mean_2 float 1.17549E-38 3.40282E+38 1 The mean of the second exponential distribution, in days, when Usage_Duration_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.
Usage_Duration_Min float 0 3.40282E+38 0 The minimum usage duration, in days, when Usage_Duration_Distribution is set to UNIFORM_DISTRIBUTION.
Usage_Duration_Peak_2_Value float 0 3.40282E+38 1 The usage duration value to assign to the remaining individuals, in days, when Usage_Duration_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.
Usage_Duration_Poisson_Mean float 0 3.40282E+38 6 The mean of the usage duration, in days, when Usage_Duration_Distribution is set to POISSON_DISTRIBUTION.
Usage_Duration_Proportion_0 float 0 1 1 The proportion of individuals to assign a value of zero days for usage duration when Usage_Duration_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.
Usage_Duration_Proportion_1 float 0 1 1 The proportion of individuals in the first exponential distribution when Usage_Duration_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.
Usage_Expiration_Event string NA NA "" When the woman stops using the contraceptive, this event will be broadcast. See Event list for possible built-in values, or create custom values using Custom_Individual_Events in the simulation configuration file.
Waning_Config json object NA NA NA A WaningEffect object used to control the efficacy of the contraceptive over time. Specify how this effect decays over time using one of the Waning effect classes. 
{
    "Use_Defaults": 1,
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config": {
                    "class": "NodeLevelHealthTriggeredIV",
                    "Trigger_Condition_List": ["NewClinicalCase"],
                    "Demographic_Coverage": 0.5,
                    "Target_Gender": "Female",
                    "Actual_IndividualIntervention_Config": {
                        "class": "FemaleContraceptive",
                        "Cost_To_Consumer": 5,
                        "Usage_Duration_Distribution": "CONSTANT_DISTRIBUTION",
                        "Usage_Duration_Constant": 180,
                        "Usage_Expiration_Event": "ContraceptiveExpired",
                        "Waning_Config": {
                            "class": "WaningEffectBox",
                            "Box_Duration": 180,
                            "Initial_Effect": 0.95
                        }
                    }
                }
            }
        }
    ]
}