Skip to content

NodeLevelHealthTriggeredIVScaleUpSwitch

The NodeLevelHealthTriggeredIVScaleUpSwitch intervention class transitions from one intervention to another over time. Generally this is used if one type of diagnostic tool is being phased out but the transition to replace it with the new diagnostic takes place over a few years. The individuals who are included by Demographic_Coverage will receive the new intervention and those that aren't will receive the older "not covered" intervention.

Note

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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
Actual_IndividualIntervention_Config link The configuration of an actual individual intervention sought. Selects a class for the intervention and configures the parameters specific for that intervention class. JSON object nan nan nan
Actual_NodeIntervention_Config link The configuration of the actual node-level intervention sought. This parameter selects a class for the intervention and configures the parameters specific for that intervention class. JSON object nan nan nan
Blackout_Event_Trigger link The event to broadcast if an intervention cannot be distributed due to the Blackout_Period. See Event list for possible values. enum nan nan ""
Blackout_On_First_Occurrence link If set to true (1), individuals will enter the blackout period after the first occurrence of an event in the Trigger_Condition_List. boolean 0 1 0
Blackout_Period link After the initial intervention distribution, the time, in days, to wait before distributing the intervention again. If it cannot distribute due to the blackout period, it will broadcast the user-defined Blackout_Event_Trigger. float 0 3.40282e+38 0
Demographic_Coverage link The fraction of individuals in the target demographic that will receive this intervention. float 0 1 1
Demographic_Coverage_Time_Profile link The profile for the ramp-up time to demographic coverage.
Possible values are:
Immediate
Linear
* Sigmoid
enum nan nan Immediate
Disqualifying_Properties link 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 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. array of strings nan nan []
Distribute_On_Return_Home link When set to true (1), individuals will receive an intervention upon returning home if that intervention was originally distributed while the individual was away. boolean 0 1 0
Duration link The number of days to continue this intervention.
.. Note::
For BirthTriggeredIV, specifying a value of -1 results in indefinite persistence of the birth-triggered intervention.
float -1 3.40282e+38 -1
Initial_Demographic_Coverage link The initial level of demographic coverage when using linear scale-up. float 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
New_Property_Value link An optional NodeProperty key:value pair that will be assigned when the intervention is distributed. See 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. string 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
Not_Covered_IndividualIntervention_Configs link The array of interventions that is distributed if an individual qualifies according to all parameters except Demographic_Coverage. Generally, this is used to specify a diagnostic tool that is being phased out. array of JSON objects nan nan nan
Primary_Time_Constant link The time to full scale-up demographic coverage. float 0 365000 1
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
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_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), the intervention is only distributed to individuals that began the simulation in the node (i.e. those that claim the node as their residence). boolean 0 1 0
Trigger_Condition_List link An array of events that will trigger an intervention. The events contained in the list can be built-in events (see Event list for possible events) or the custom events defined in Listed_Events in the simulation configuration file. array of strings nan nan nan

link