NodeLevelHealthTriggeredIV¶
The NodeLevelHealthTriggeredIV intervention class distributes an intervention to an individual when a specific event occurs. NodeLevelHealthTriggeredIV monitors for event triggers from individuals, and when found, will distribute the intervention. For example, NodeLevelHealthTriggeredIV can be configured such that all individuals will be given a diagnostic intervention when they transition from susceptible to infectious. During the simulation, when individuals become infected, they broadcast the NewInfectionEvent trigger and NodeLevelHealthTriggeredIV distributes the diagnostic intervention to them.
Note
Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. 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 |
|---|---|---|---|---|---|---|
| Blackout_Event_Trigger | enum | NA | NA | NoTrigger | The event to broadcast if an intervention cannot be distributed due to the Blackout_Period. See Event list for possible values. | {
"Blackout_Event_Trigger" : "Blackout"
}
|
| Blackout_On_First_Occurrence | boolean | NA | NA | 0 | If set to true (1), individuals will enter the blackout period after the first occurrence of an event in the Trigger_Condition_List. | {
"Blackout_On_First_Occurrence": 0
}
|
| Blackout_Period | float | 0 | 3.40E+3 | 0 | 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. | {
"Blackout_Period" : 0.0
}
|
| Actual_NodeIntervention_Config | JSON object | NA | NA | NA | 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. | {
"Actual_NodeIntervention_Config": {
"class": "OutbreakIndividual",
"Antigen": 0,
"Genome": 0,
"Outbreak_Source": "PrevalenceIncrease"
}
}
|
| Distribute_On_Return_Home | boolean | NA | NA | 0 | When set to true (1), individuals will receive an intervention upon returning home if that intervention was originally distributed while the individual was away. | {
"Distribute_On_Return_Home" : 1
}
|
| Trigger_Condition | enum | NA | NA | NoTrigger | The condition for triggering a health seeking intervention. Normally, Trigger_Condition specifies an event from the built-in list of pre-defined events or triggers from the IndividualEventTriggerType enum. For a list of possible values, see Individual Event Trigger Values. If the value is set to TriggerString, the Trigger_Condition_String parameter specifies the event. If the value is set to TriggerList, the Trigger_Condition_List parameter specifies a list of events. |
|
| Trigger_Condition_List | enum | NA | NA | NA | This parameter configures NodeLevelHealthTriggeredIV to listen for multiple events at once. 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. | {
"Trigger_Condition_List": [
"OnART3"
]
}
|
| Node_Property_Restrictions | array of JSON objects | NA | NA | NA | 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 NodeProperties and IndividualProperties parameters for more information. | {
"Node_Property_Restrictions": [{
"Place": "URBAN",
"Risk": "MED"
},
{
"Place": "RURAL",
"Risk": "LOW"
}
]
}
|
| Target_Age_Max | float | 0 | 3.40E+3 | 3.40E+38 | The upper end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender. | {
"Target_Age_Max": 20,
"Target_Age_Min": 10,
"Target_Demographic": "ExplicitAgeRanges"
}
|
| Actual_IndividualIntervention_Config | JSON object | NA | NA | NA | The configuration of an actual individual intervention sought. Selects a class for the intervention and configures the parameters specific for that intervention class. | {
"Actual_IndividualIntervention_Config": {
"class": "OutbreakIndividual",
"Antigen": 0,
"Genome": 0,
"Outbreak_Source": "PrevalenceIncrease"
}
}
|
| Duration | float | -1 | 3.40E+3 | -1 | 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. |
{
"Duration": -1
}
|
| Demographic_Coverage | float | 0 | 1 | 1 | The fraction of individuals in the target demographic that will receive this intervention. | {
"Demographic_Coverage": 1
}
|
| Property_Restrictions_Within_Node | array of JSON objects | NA | NA | NA | A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this node-level intervention. See NodeProperties and IndividualProperties parameters for more information. | {
"Property_Restrictions_Within_Node": [{
"Risk": "HIGH"
}]
}
|
| Target_Gender | enum | NA | NA | All | Specifies the gender restriction for the intervention. Possible values are:
|
{
"Target_Gender": "Male"
}
|
| Target_Residents_Only | boolean | NA | NA | 0 | 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). | {
"Target_Residents_Only": 1
}
|
| Property_Restrictions | array of JSON objects | NA | NA | NA | A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this individual-level intervention. See NodeProperties and IndividualProperties parameters for more information. | {
"Property_Restrictions": [
"Risk:HIGH"
]
}
|
| Target_Demographic | enum | NA | NA | Everyone | The target demographic group. Possible values are:
|
{
"Target_Age_Max": 20,
"Target_Age_Min": 10,
"Target_Demographic": "ExplicitAgeRanges"
}
|
| Disqualifying_Properties | string | NA | NA | NA | A list of IndividualProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to individuals 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": [
"InterventionStatus:LostForever"
]
}
|
| Intervention_Name | string | NA | NA | NA | The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. | {
"Intervention_Name":"Diagnostic_Sample"
}
|
| New_Property_Value | string | NA | NA | NA | An optional IndividualProperty 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"
}
|
{
"Use_Defaults": 1,
"Events": [{
"class": "CampaignEvent",
"Start_Day": 1,
"Nodeset_Config": {
"class": "NodeSetAll"
},
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Intervention_Config": {
"class": "NodeLevelHealthTriggeredIV",
"Trigger_Condition_List": ["HappyBirthday"],
"Demographic_Coverage": 1.0,
"Actual_IndividualIntervention_Config": {
"class": "OutbreakIndividual",
"Antigen": 0,
"Genome": 0,
"Outbreak_Source": "PrevalenceIncrease"
}
}
}
}]
}