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)
  • 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 cost of getting the contraceptive each time it is distributed.
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 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 boolean 0 1 0 If a node's container has an intervention, set to true (1) to prevent it from receiving another copy of the intervention. Supported by all intervention classes.
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 distributed. See 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.
Usage_Duration_Constant float 0 3.40282e+38 6 Each instance will receive this constant/fixed value.
Usage_Duration_Distribution enum NA NA NOT_INITIALIZED For the distribution of each contraceptive, a randomly selected duration from this distribution will determine when the woman stops using the contracpetive. This is independent of how long the contraceptive is effective. 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_Exponential float 0 3.40282e+38 6 The mean for an exponential distribution.
Usage_Duration_Gaussian_Mean float 0 3.40282e+38 6 The mean for a Gaussian distribution.
Usage_Duration_Gaussian_Std_Dev float 1.17549e-38 3.40282e+38 1 The standard deviation for a Gaussian distribution.
Usage_Duration_Kappa float 1.17549e-38 3.40282e+38 1 The shape value in a Weibull distribution.
Usage_Duration_Lambda float 1.17549e-38 3.40282e+38 1 The scale value in a Weibull distribution.
Usage_Duration_Log_Normal_Mu float -3.40282e+38 3.40282e+38 6 The mean for a log-normal distribution.
Usage_Duration_Log_Normal_Sigma float -3.40282e+38 3.40282e+38 1 The width for a log-normal distribution.
Usage_Duration_Max float 0 3.40282e+38 1 The maximum of the uniform distribution.
Usage_Duration_Mean_1 float 1.17549e-38 3.40282e+38 1 The mean of the first exponential distribution.
Usage_Duration_Mean_2 float 1.17549e-38 3.40282e+38 1 The mean of the second exponential distribution.
Usage_Duration_Min float 0 3.40282e+38 0 The minimum of the uniform distribution.
Usage_Duration_Peak_2_Value float 0 3.40282e+38 1 The value to assign to the remaining individuals.
Usage_Duration_Poisson_Mean float 0 3.40282e+38 6 The mean for a Poisson distribution.
Usage_Duration_Proportion_0 float 0 1 1 The proportion of individuals to assign a value of zero.
Usage_Duration_Proportion_1 float 0 1 1 The proportion of individuals in the first exponential distribution.
Usage_Expiration_Event string NA NA "" When the woman stops using the contraceptive, this event will be broadcasted. See Event list for possible built-in values, or create custom values using Custom_Individual_Events.
Waning_Config json object NA NA NA A WaningEffect object used to control the efficacy of the contraceptive, typically over time. Specify how this effect decays over time using one of the Waning effect classes. See example. 
{
    "Use_Defaults": 1,
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 730,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Target_Demographic": "ExplicitGender",
                "Target_Gender": "Female",
                "Demographic_Coverage": 0.1,
                "Intervention_Config": {
                    "class": "FemaleContraceptive",
                    "Cost_To_Consumer": 1,
                    "Waning_Config": {
                        "class": "WaningEffectBox",
                        "Box_Duration": 180,
                        "Initial_Effect": 0.95
                    },
                    "Usage_Duration_Distribution": "CONSTANT_DISTRIBUTION",
                    "Usage_Duration_Constant": 150,
                    "Usage_Expiration_Event": "StopUsingContraceptive"
                }
            }
        }
    ]
}