EnvironmentalDiagnostic

The EnvironmentalDiagnostic intervention class identifies contaminated locations by sampling the environment, comparing the value to a threshold, and broadcasting either a positive or negative node event.

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
Base_Sensitivity	float	0	1	1	The likelihood that a positive measurement was made. If the contagion measurement is greater than the Sample_Threshold, a random number is drawn to determine if the detection was actually made.	{ "Base_Sensitivity": 0.7, "Sample_Threshold": 0.85 }
Base_Specificity	float	0	1	1	The proportion of time that the environment being tested and without the condition receives a negative diagnostic test. When set to 1, the diagnostic always accurately reflects the lack of having the condition. When set to zero, then environments that do not have the condition always receive a false-positive diagnostic test.	{ "Base_Specificity": 0.9 }
Disqualifying_Properties	array of strings	NA	NA	NA	A list of NodeProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to nodes 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": [] }
Environment_IP_Key_Value	string	NA	NA	NA	An IndividualProperty key:value pair that indicates a specific transmission pool, typically used to identify a location. If none is provided, the sample will be taken on the entire node.	{ "Environment_IP_Key_Value": "Location:UP_RIVER" }
Intervention_Name	string	NA	NA	EnvironmentalDiagnostic	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	{ "Intervention_Config": { "Intervention_Name": "Downriver sample testing", "class": "EnvironmentalDiagnostic" } }
Negative_Diagnostic_Event	string	NA	NA	“”	The event that will be broadcast to the node when the sample value is less than the threshold (e.g. the test is negative). If this is an empty string or set to NoTrigger, no event will be broadcast. See Event list for possible values, or create custom events using Custom_Node_Events.	{ "Event_Or_Config": "Event", "Negative_Diagnostic_Event": "Up_River_Clean" }
New_Property_Value	string	NA	NA	NA	An optional NodeProperty 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" }
Positive_Diagnostic_Event	string	NA	NA	“”	The event that will be broadcast to the node when the sample value is greater than the threshold (e.g. the test is positive). This cannot be an empty string or set to NoTrigger. See Event list for possible values, or create custom events using Custom_Node_Events.	{ "Positive_Diagnostic_Event": "Up_River_Contagion_Found" }
Sample_Threshold	float	0	3.40282e+38	0	The threshold that delineates a positive versus negative sampling result. If the sample is greater than the threshold, a positive finding will result; if the value is less than the threshold, it will be negative. This does not include values equal to the threshold so that the threshold can be set to zero; if the threshold is zero, the test is simply looking for any deposit in the transmission pool.	{ "Sample_Threshold": 0.2 }

{
    "comment": "No infections, Negative_Event_Node",
    "class": "CampaignEvent",
    "Start_Day": 10,
    "Nodeset_Config": {
        "class": "NodeSetAll"
    },
    "Event_Coordinator_Config": {
        "class": "StandardInterventionDistributionEventCoordinator",
        "Intervention_Config": {
            "class": "EnvironmentalDiagnostic",
            "Sample_Threshold": 0.2,
            "Environment_IP_Key_Value": "",
            "Base_Specificity": 1.0,
            "Base_Sensitivity": 1.0,
            "Negative_Diagnostic_Event": "Negative_Event_Node",
            "Positive_Diagnostic_Event": "Positive_Event_Node"
        }
    }
}