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 parameter-campaign-node-nodelevelhealthtriggerediv or parameter-campaign-event-communityhealthworkereventcoordinator.
Note
1 2 3 4 5 6 7 8 9 10 11 | |
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 |
|---|---|---|---|---|---|---|
| Broadcast_Event | link | The name of the event that will trigger the intervention. See Event list for possible values. | string | nan | nan | "" |
| Disqualifying_Properties | link | 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 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 | [] |
| 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 |
| 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 | BroadcastEvent |
| New_Property_Value | link | An optional IndividualProperty 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 |