BirthTriggeredIV

Note: This intervention has been replaced by NodeLevelHealthTriggeredIV, which provides more flexibility and can be triggered by any individual event, including Births which mimics the BirthTriggeredIV. BirthTriggeredIV will continue to be supported for backward compatibility but will not receive new features.

The BirthTriggeredIV intervention class listens for births in a node and distributes an individual-level intervention to each newborn. It is a node-level intervention that persists on the node for the specified Duration (or indefinitely if set to -1), distributing the configured Actual_IndividualIntervention_Config to qualifying newborns based on demographic targeting and property restrictions.

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 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	Type	Min	Max	Default	Description
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.
Demographic_Coverage	float	0	1	1	The fraction of individuals in the target demographic that will receive this intervention.
Disqualifying_Properties	array of strings	NA	NA	[]	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 IndividualProperties and NodeProperties 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.
Dont_Allow_Duplicates	boolean	0	1	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.
Duration	float	-1	3.40282e+38	-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.
Intervention_Name	string	NA	NA	BirthTriggeredIV	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.
New_Property_Value	string	NA	NA	""	An optional NodeProperty key:value pair that will be assigned when the intervention is applied. See IndividualProperties and NodeProperties parameters for more information.
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 IndividualProperties and NodeProperties 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. See example.
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 IndividualProperties and NodeProperties 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. See example.
Target_Age_Max	float	0	9.3228e+35	9.3228e+35	The upper end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.
Target_Age_Min	float	0	9.3228e+35	0	The lower end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.
Target_Demographic	enum	NA	NA	Everyone	The target demographic group. Possible values are: Everyone ExplicitAgeRanges ExplicitAgeRangesAndGender ExplicitGender * ExplicitDiseaseState
Target_Gender	enum	NA	NA	All	Specifies the gender restriction for the intervention. Possible values are: Male Female * All
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).
Targeting_Config	json object	NA	NA	NA	Be more selective of individuals by using the Targeting_Config classes. See example.

{
    "Use_Defaults": 1,
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config": {
                    "class": "BirthTriggeredIV",
                    "Duration": -1,
                    "Demographic_Coverage": 0.95,
                    "Target_Demographic": "Everyone",
                    "Actual_IndividualIntervention_Config": {
                        "class": "SimpleVaccine",
                        "Cost_To_Consumer": 10,
                        "Vaccine_Type": "AcquisitionBlocking",
                        "Waning_Config": {
                            "class": "WaningEffectExponential",
                            "Decay_Time_Constant": 365,
                            "Initial_Effect": 0.8
                        }
                    }
                }
            }
        }
    ]
}