ImmunityBloodTest

The ImmunityBloodTest intervention class identifies whether an individual’s immunity meets a specified threshold (as set with the Positive_Threshold_AcquisitionImmunity campaign parameter) and then broadcasts an event based on the results; positive has immunity while negative does not. Note that Base_Sensitivity and Base_Specificity function whether or not the immunity is above the threshold.

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	Data type	Minimum	Maximum	Default	Description	Example
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 zero, then individuals who have the condition always receive a false-negative diagnostic test.	{ "Base_Sensitivity": 0.8 }
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.	{ "Base_Specificity": 0.9 }
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.	{ "Cost_To_Consumer": 0 }
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).	{ "Days_To_Diagnosis": 0 }
Disqualifying_Properties	array of strings	NA	NA	[]	A list of IndividualProperty key:value pairs that cause an intervention to be aborted. 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" ] }
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 }
Enable_Is_Symptomatic	boolean	0	1	0	If true (1), requires an infection to be symptomatic to return a positive test.	{ "Base_Sensitivity": 0.92, "Base_Specificity": 0.85, "Enable_Is_Symptomatic": 1 }
Intervention_Name	string	NA	NA	ImmunityBloodTest	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": "Immunity Blood Test - Series 1", "class": "ImmunityBloodTest" } }
Negative_Diagnosis_Event	enum	NA	NA	“”	If an individual tests negative (does not have immunity), then an individual type event is broadcast; custom individual events can be defined in the config parameter Custom_Individual_Events. This may trigger another intervention when the event occurs.	{ "Intervention_Config": { "Negative_Diagnosis_Event": "TestedNegative_IamSusceptible", "Positive_Diagnosis_Event": "TestedPositive_IamImmune" } }
New_Property_Value	string	NA	NA	“”	An optional IndividualProperty key:value pair that will be assigned when the intervention is applied. 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.	{ "New_Property_Value": "InterventionStatus:None" }
Positive_Diagnosis_Event	enum	NA	NA	“”	If the test is positive (has immunity), then an individual type event is broadcast; custom individual events can be defined in the config parameter Custom_Individual_Events. This may trigger another intervention when the event occurs.	{ "Intervention_Config": { "Negative_Diagnosis_Event": "TestedNegative_IamSusceptible", "Positive_Diagnosis_Event": "TestedPositive_IamImmune" } }
Positive_Threshold_Acquisition_Immunity	float	0	1	1	Specifies the threshold for acquired immunity, where 1 equals 100% immunity and 0 equals 100% susceptible.	{ "Positive_Threshold_Acquisition_Immunity": 0.99 }
Treatment_Fraction	float	0	1	1	The fraction of positive diagnoses that are treated.	{ "Treatment_Fraction": 1 }

{
    "Events":[{
            "class":"CampaignEvent",
            "Start_Day":14,
            "Nodeset_Config":{
                "class":"NodeSetAll"
            },
            "Event_Coordinator_Config":{
                "class":"StandardInterventionDistributionEventCoordinator",
                "Target_Demographic":"Everyone",
                "Demographic_Coverage": 1.0,
                "Intervention_Config": {
                    "Base_Sensitivity": 1.0,
                    "Base_Specificity": 1.0,
                    "Cost_To_Consumer": 0,
                    "Days_To_Diagnosis": 0.0,
                    "Positive_Diagnosis_Event": "TestedPositive_IamImmune",
                    "Negative_Diagnosis_Event": "TestedNegative_IamSusceptible",
                    "Treatment_Fraction": 1.0,
                    "Positive_Threshold_AcquisitionImmunity": 0.99,
                    "class": "ImmunityBloodTest"
                }
            }
        }],
    "Use_Defaults":1
}