HIVSigmoidByYearAndSexDiagnostic

The HIVSigmoidByYearAndSexDiagnostic intervention class builds on HIVSimpleDiagnostic by allowing the probability of "positive diagnosis" to be configured sigmoidally in time. For a linear approach, use HIVPiecewiseByYearAndSexDiagnostic.

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	3.40282e+38	1	The unit 'cost' assigned to the diagnostic. 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 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 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.
Female_Multiplier	float	0	3.40282e+38	1	Allows for the sigmoid time-varying probability to be different for males and females, by multiplying the female probability by a constant value.
Intervention_Name	string	NA	NA	HIVSigmoidByYearAndSexDiagnostic	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.
Negative_Diagnosis_Event	enum	NA	NA	""	If an individual tests negative, this specifies an event that may trigger another intervention when the event occurs. See Event list for possible values.
New_Property_Value	string	NA	NA	""	An optional IndividualProperty key:value pair that will be assigned when the intervention is applied. 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.
Positive_Diagnosis_Event	enum	NA	NA	""	If the test is positive, this specifies an event that can trigger another intervention when the event occurs. See Event list for possible values.
Ramp_Max	float	-1	1	1	The right asymptote for the sigmoid trend over time.
Ramp_MidYear	float	-3.40282e+38	3.40282e+38	2000	The time of the infection point in the sigmoid trend over time.
Ramp_Min	float	-1	1	1	The left asymptote for the sigmoid trend over time.
Ramp_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.

{
    "Campaign_Name": "1d_MaleCircumcision_at_Age_18",
    "Default_Campaign_Path": "defaults/hiv_default_campaign.json",
    "Use_Defaults": 1,
    "Events":
    [
        {
            "class": "CampaignEventByYear",
            "Event_Name": "Male circumcision at birth",
            "Start_Year": 1990,
            "Nodeset_Config":
            {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config":
            {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config":
                {
                    "class": "BirthTriggeredIV",
                    "Target_Demographic": "ExplicitGender",
                    "Target_Gender": "Male",
                    "Demographic_Coverage": 1,
                    "Actual_IndividualIntervention_Config":
                    {
                        "class": "HIVSigmoidByYearAndSexDiagnostic",
                        "New_Property_Value": "InterventionStatus:None",
                        "Ramp_Min": 0.0,
                        "Ramp_Max": 0.3,
                        "Ramp_MidYear": 2002.0,
                        "Ramp_Rate": 0.5,
                        "Positive_Diagnosis_Event": "HIVNeedsMaleCircumcision"
                    }
                }
            }
        }
    ]
}