MaleCircumcision

The MaleCircumcision intervention class introduces male circumcision as a method to control HIV transmission. Voluntary medical male circumcision (VMMC) permanently reduces a male’s likelihood of acquiring HIV; successful distribution results in a reduction in the probability of transmission.

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
Apply_If_Higher_Reduced_Acquire	boolean	0	1	0	If set to false (0), the MaleCircumcision intervention can never be applied to someone who already has a MaleCircumcision intervention. If set to true (1), a male who already has a MaleCircumcision intervention, but whose pre-existing MaleCircumcision intervention has a lower efficacy parameter (Circumcision_Reduced_Acquire) than the one about to be applied, will receive the higher-efficacy MaleCircumcision.	{ "Apply_If_Higher_Reduced_Acquire": 1 }
Circumcision_Reduced_Acquire	float	0	1	0.6	The reduction of susceptibility to STI by voluntary male medical circumcision (VMMC).	{ "Circumcision_Reduced_Acquire": 0.6 }
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" ] }
Distributed_Event_Trigger	string	NA	NA	NA	When defined as part of an intervention block of class MaleCircumcision, this string defines the name of the column in the output files ReportHIVByAgeAndGender.csv and ReportEventRecorder.csv, which log when the intervention has been distributed. See Event list for possible values.	{ "Distributed_Event_Trigger": "VMMC_1" }
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 }
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": "MaleCircumcision", "Intervention_Name": "Routine voluntary male circumcision" } }
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" }

{
    "Use_Defaults": 1,
    "Campaign_Name": "HIV 3B: VMMC",
    "Events": [{
        "class": "CampaignEventByYear",
        "Event_Name": "Male circumcision at birth starting in 2025",
        "Start_Year": 2025,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Intervention_Config": {
                "class": "BirthTriggeredIV",
                "Demographic_Coverage": 1,
                "Target_Demographic": "ExplicitGender",
                "Target_Gender": "Male",
                "Actual_IndividualIntervention_Config": {
                    "class": "MaleCircumcision",
                    "Circumcision_Reduced_Acquire": 0.6
                }
            }
        }
    }]
}