HIVRapidHIVDiagnostic

The HIVRapidHIVDiagnostic intervention class builds on HIVSimpleDiagnostic by also updating the individual's knowledge of their HIV status. This can affect their access to ART in the future as well as other behaviors. This intervention should be used only if the individual’s knowledge of their status should impact a voluntary male circumcision campaign.

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
Base_Sensitivity	float	0	1	1	The sensitivity of the diagnostic. This sets the proportion of the time that individuals with the condition being tested receive a positive diagnostic test. When set to 1, the diagnostic always accurately reflects the condition. When set to zero, then individuals who have the condition always receive a false-negative diagnostic test.
Base_Specificity	float	0	1	1	The specificity of the diagnostic. This sets the proportion of the time that individuals without the condition being tested receive a negative diagnostic test. When set to 1, the diagnostic always accurately reflects the lack of having the condition. When set to zero, then individuals who do not have the condition always receive a false-positive diagnostic test.
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.
Days_To_Diagnosis	float	0	3.40282e+38	0	The number of days from diagnosis (which is done when the intervention is distributed) until a positive response is performed. The response to a negative diagnosis is done immediately when the diagnosis is made (at distribution of the intervention).
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.
Enable_Is_Symptomatic	boolean	0	1	0	If true (1), requires an infection to be symptomatic to return a positive test.
Intervention_Name	string	NA	NA	HIVRapidHIVDiagnostic	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.
Probability_Received_Result	float	0	1	1	The probability that an individual received the results of a diagnostic test.
Sensitivity_Type	enum	NA	NA	SINGLE_VALUE	Set to SINGLE_VALUE (default) to use the single value of Base_Sensitivity or VERSUS_TIME to have sensitivity be based on the duration since the person became infected, Sensitivity_Versus_Time.
Sensitivity_Versus_Time	array of floats			[]	The 'Times' values are the duration from when the person became infected. 'Values' is the sensitivity of the diagnostic for the given age of the infection. See example.

{
    "Use_Defaults": 1,
    "Campaign_Name": "Generic HIV Outbreak",
    "Events": [{
        "class": "CampaignEvent",
        "Event_Name": "Test for HIV",
        "Start_Day": 0,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "Intervention_Config": {
                "class": "HIVRapidHIVDiagnostic",
                "Days_To_Diagnosis": 1,
                "Probability_Received_Result": 0.9,
                "Disqualifying_Properties": [],
                "New_Property_Value": "",
                "Positive_Diagnosis_Event": "HCTTestingLoop2",
                "Negative_Diagnosis_Event": "HCTTestingLoop3"
            },
            "Target_Demographic": "Everyone",
            "Demographic_Coverage": 1.0,
            "Number_Repetitions": 35,
            "Timesteps_Between_Repetitions": 200,
            "class": "StandardInterventionDistributionEventCoordinator",
            "Travel_Linked": 0
        }
    }]
}