SurveillanceEventCoordinator

Note

This campaign class and associated parameters are currently in beta release and have not yet been fully tested.

The SurveillanceEventCoordinator coordinator class listens for and detects events happening and then responds with broadcasted events when a threshold has been met. This campaign event is typically used with other classes, such as parameter-campaign-event-broadcastcoordinatorevent, parameter-campaign-event-triggeredeventcoordinator, and parameter-campaign-event-delayeventcoordinator.

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
Action_List	link	A list of possible actions to take if a particular threshold is met. An action is taken when the specified threshold value is less than the number of incidence counted. If there are multiple actions listed then the action with the highest threshold value, that is also less than the number of incidence counted, is selected. The list cannot be empty.	array of JSON objects	nan	nan	nan
Coordinator_Name	link	The unique identifying coordinator name, which is useful with the output report, ReportSurveillanceEventRecorder.csv.	string	nan	nan	TriggeredEventCoordinator
Counter_Event_Type	link	Type of events that can be included in Trigger_Condition_List. Possible values are: COORDINATOR INDIVIDUAL * NODE	enum	nan	nan	INDIVIDUAL
Counter_Period	link	When Counter_Type is set to PERIODIC, this is the counter period (in days).	float	1	10000	1
Counter_Type	link	Counter type used for surveillance of events. The counter is triggered by events in Start_Trigger_Condition_List and the counter stops when it receives an event in Stop_Trigger_Condition_List or the listening duration expires. Possible values are: PERIODIC Once triggered, events are counted during the period (in days) as set in Counter_Period. At the end of the period, the counter will notify Responder with the data accumulated and then start listening again, continuing forever until it is stopped or the duration expires. For example, if the listening duration is 45 days, Counter_Period is 30, and the counter is triggered on day 20, it will never complete the counter period and trigger the responder.	enum	nan	nan	PERIODIC
Demographic_Coverage	link	The fraction of individuals in the target demographic that are counted.	float	0	1	1
Duration	link	The number of days from when the surveillance event coordinator was created by the campaign event. Once the number of days has passed, the delay event coordinator will unregister for events and expire. The default value of '-1' = never expire.	float	-1	3.40282e+38	-1
Event_Type	link	The type of event to be broadcast. Possible values are: COORDINATOR INDIVIDUAL * NODE	enum	nan	nan	INDIVIDUAL
Incidence_Counter	link	List of JSON objects for specifying the conditions and parameters that must be met for an incidence to be counted. Some of the values are specified in the following parameters: Counter_Type, Counter_Period, Counter_Event_Type, Trigger_Condition_List, Node_Property_Restrictions, Property_Restrictions_Within_Node.	array of JSON objects	nan	nan	nan
Node_Property_Restrictions	link	A list of the NodeProperty key:value pairs, as defined in the demographics file, that nodes must have to be targeted by the intervention. See parameters for more information. You can specify AND and OR combinations of key:value pairs with this parameter.	array of JSON objects	nan	nan	nan
Percentage_Events_To_Count	link	When Threshold_Type equals PERCENTAGE_EVENTS then Percentage_Events_To_Count lists the events that will be counted for the denominator which will then be used with the specified event for Trigger_Condition_List counted for the numerator.	array of strings	nan	nan	nan
Property_Restrictions	link	A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this intervention. See parameters for more information. To specify AND and OR combinations of key:value pairs, use Property_Restrictions_Within_Node. You cannot use both of these parameters in the same event coordinator.	array of JSON objects	nan	nan	nan
Property_Restrictions_Within_Node	link	A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this intervention. See parameters for more information. This parameter allows you to specify AND and OR combinations of key:value pairs. You may specify individual property restrictions using either this parameter or Property_Restrictions, but not both.	array of JSON objects	nan	nan	nan
Responded_Event	link	A coordinator event, defined in Custom_Coordinator_Events, that is broadcast if Responder responded. More specifically, at the completion of a counting period, if an action is selected, the action events are broadcast and then the Responded_Event is also broadcast. This allows other event coordinators to react to the action events being broadcast.	string	nan	nan	""
Responder	link	List of JSON objects for specifying the threshold type, values, and the actions to take when the specified conditions and parameters have been met, as configured in Incidence_Counter. Some of the values are specified in the following parameters: Action_List Event_To_Broadcast Threshold_Type Threshold	array of JSON objects	nan	nan	nan
Start_Trigger_Condition_List	link	The trigger event list, as specified in the Custom_Coordinator_Events config parameter, that will start Incidence_Counter counting events. The surveillance event coordinator will keep counting and responding until it gets a stop event, as defined in Stop_Trigger_Condition_List, or the duration of the surveillance event coordinator has expired, as defined in Duration. The list cannot be empty.	array of strings	nan	nan	nan
Stop_Trigger_Condition_List	link	The broadcast event list, as specified in the Custom_Coordinator_Events config parameter, that will stop Incidence_Counter counting events. The coordinator can start counting again if it receives a start trigger event. The list can be empty.	array of strings	nan	nan	nan
Target_Age_Max	link	The upper end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.	float	0	9.3228e+35	9.3228e+35
Target_Age_Min	link	The lower end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.	float	0	3.40282e+38	0
Target_Demographic	link	The target demographic group. Possible values are: Everyone ExplicitAgeRanges ExplicitAgeRangesAndGender ExplicitGender * ExplicitDiseaseState	enum	nan	nan	Everyone
Target_Gender	link	Specifies the gender restriction for the intervention. Possible values are: Male Female * All	enum	nan	nan	All
Target_Residents_Only	link	When set to true (1), only individuals that currently reside in their 'home' node will be counted.	boolean	0	1	0
Threshold	link	The COUNT or PERCENTAGE, as configured with Threshold_Type, threshold value that must be met before and action from Action_List will be considered.	float	0	3.40282e+38	0
Threshold_Type	link	Threshold type to indicate how Responder handles the count of events from Incidence_Counter and the thresholds in Action_List. Possible values are: COUNT A raw count of events. Also, with COUNT, setting the x_Base_Population configuration parameter can affect the number count by changing the population but it could be very indirect. PERCENTAGE Counts the number of individuals that meet the restrictions and then to divide the total number of events by this number. Note that it is possible for an individual to emit an event that might not be counted in the denominator if their demographic restriction attributes changed between the time of the emitted event and the time the denominator was counted. PERCENTAGE_EVENTS Percentage_Events_To_Count lists the events that will be counted for the denominator, which will then be used with the specified event for Trigger_Condition_List to be counted for the numerator.	enum	nan	nan	COUNT
Trigger_Condition_List	link	The list of events to count.The list cannot be empty. The type of events contained in the list is determined by Counter_Event_Type. Depending upon the type, the events must be defined in one of the following configuration parameters: Custom_Coordinator_Events Custom_Individual_Events * Custom_Node_Events	array of strings	nan	nan	nan

link