BroadcastEvent

The BroadcastEvent intervention class immediately broadcasts the event trigger you specify. This campaign event is typically used with other classes that monitor for a broadcast event, such as NodeLevelHealthTriggeredIV or CommunityHealthWorkerEventCoordinator.

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
Broadcast_Event string NA NA No Trigger The name of the event that will trigger the intervention. See Event list for possible values.
{
    "Broadcast_Event": "HIVNeedsHIVTest"
}
Dont_Allow_Duplicates boolean NA NA 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
}
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,
    "Campaign_Name": "4C: HIVMuxer",
    "Events": [{
            "Description": "Drive initial population into a loop",
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config": {
                    "class": "BroadcastEvent",
                    "Broadcast_Event": "Loop_Entry_InitialPopulation"
                }
            }
        },
        {
            "Description": "Wait one year, only one entry allowed at a time per individual",
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config": {
                    "class": "NodeLevelHealthTriggeredIV",
                    "Trigger_Condition": "TriggerList",
                    "Trigger_Condition_List": [
                        "Loop_Entry_InitialPopulation",
                        "Loop_Entry_Birth",
                        "Done_Waiting"
                    ],
                    "Actual_IndividualIntervention_Config": {
                        "class": "HIVMuxer",
                        "Disqualifying_Properties": ["InterventionStatus:Abort_Infinite_Loop"],
                        "New_Property_Value": "InterventionStatus:Infinite_Loop",
                        "Delay_Distribution": "FIXED_DURATION",
                        "Delay_Period": 365,
                        "Muxer_Name": "Delay_Loop_Muxer",
                        "Max_Entries": 1,
                        "Broadcast_Event": "Done_Waiting"
                    }
                }
            }
        }
    ]
}