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

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	Example	Description	Type	Min	Max	Default
Base_Sensitivity	link	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.	float	0	1	1
Base_Specificity	link	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.	float	0	1	1
Cost_To_Consumer	link	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.	float	0	3.40282e+38	1
Days_To_Diagnosis	link	The number of days from test until diagnosis.	float	0	3.40282e+38	0
Disqualifying_Properties	link	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.	array of strings	nan	nan	[]
Dont_Allow_Duplicates	link	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.	boolean	0	1	0
Enable_IsSymptomatic	link	If true (1), requires an infection to be symptomatic to return a positive test.	boolean	0	1	0
Intervention_Name	link	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	string	nan	nan	nan
Negative_Diagnosis_Event	link	If an individual tests negative (does not have immunity), then an individual type event is broadcast. This may trigger another intervention when the event occurs. Only used when Event_Or_Config is set to Event.	enum	nan	nan	""
New_Property_Value	link	An optional IndividualProperty key:value pair that will be assigned when the intervention is distributed. 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.	string	nan	nan	nan
Positive_Diagnosis_Config	link	The intervention distributed to individuals if they test positive. Only used when Event_Or_Config is set to Config.	JSON object	nan	nan	nan
Positive_Diagnosis_Event	link	If the test is positive (has immunity), then an individual type event is broadcast. This may trigger another intervention when the event occurs. Only used if Event_Or_Config is set to Event.	enum	nan	nan	""
Positive_Threshold_AcquisitionImmunity	link	Specifies the threshold for acquired immunity, where 1 equals 100% immunity and 0 equals 100% susceptible.	float	0	1	1
Treatment_Fraction	link	The fraction of positive diagnoses that are treated.	float	0	1	1

link