MultiInterventionEventCoordinator

The MultiInterventionEventCoordinator coordinator class distributes multiple individual-level or node- level interventions at the same time to the same set of covered individuals or nodes. You cannot specify a mix of individual-level and node-level interventions within the same event coordinator. This enables correlated distributions, such as dosing of multiple drugs with different regimens and pharmacokinetic pharmacodynamic models. See the following JSON example and table, which shows all available parameters for this event coordinator.

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 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
Demographic_Coverage	float	0	1	1	The fraction of individuals in the target demographic that will receive this intervention.	{ "Demographic_Coverage": 1 }
Intervention_Configs	array of JSON objects	NA	NA	NA	The array of nested JSON parameters for the interventions to be distributed by this event coordinator.	{ "Intervention_Configs": [ { "Cost_To_Consumer": 1, "Dosing_Type": "FullTreatmentCourse", "Drug_Type": "DHA", "class": "AntimalarialDrug" }, { "Cost_To_Consumer": 1, "Dosing_Type": "FullTreatmentCourse", "Drug_Type": "Piperaquine", "class": "AntimalarialDrug" } ] }
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. You can specify AND and OR combinations of key:value pairs with this parameter.	The following example restricts the intervention to nodes that are urban and medium risk or rural and low risk. { "Node_Property_Restrictions": [ { "Place": "URBAN", "Risk": "MED" }, { "Place": "RURAL", "Risk": "LOW" } ] }
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 intervention. See NodeProperties and IndividualProperties 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.	{ "Property_Restrictions": [ "Risk:HIGH" ] }
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 intervention. See NodeProperties and IndividualProperties 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.	The following example restricts the intervention to individuals who are urban and high risk or urban and medium risk. { "Property_Restrictions_Within_Node": [ { "Risk": "HIGH", "Geographic": "URBAN" }, { "Risk": "MEDIUM", "Geographic": "URBAN" } ] }
Target_Age_Min	float	0	3.40E+3	0	The lower 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" }
Target_Demographic	enum	NA	NA	Everyone	The target demographic group. Possible values are: Everyone ExplicitAgeRanges ExplicitAgeRangesAndGender ExplicitGender ExplicitDiseaseState	{ "Target_Age_Max": 20, "Target_Age_Min": 10, "Target_Demographic": "ExplicitAgeRanges" }
Target_Gender	enum	NA	NA	All	Specifies the gender restriction for the intervention. Possible values are: Male Female All	{ "Target_Gender": "Male" }
Target_Residents_Only	boolean	0	1	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 }

{
    "Events": [{
        "class": "CampaignEvent",
        "Start_Day": 10,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "MultiInterventionEventCoordinator",
            "Intervention_Configs": [{
                    "class": "PropertyValueChanger",
                    "Target_Property_Key": "Risk",
                    "Target_Property_Value": "HIGH",
                    "Daily_Probability": 1.0,
                    "Maximum_Duration": 0,
                    "Revert": 0
                },
                {
                    "class": "BroadcastEvent",
                    "Broadcast_Event": "PVC_Distributed"
                }
            ]
        }
    }]
}