IVCalendar

The IVCalendar intervention class contains a list of ages when an individual will receive the actual intervention. In IVCalendar, there is a list of actual interventions where the distribution is dependent on whether the individual’s age matches the next date in the calendar. This implies that at a certain age, the list of actual interventions will be distributed according to a given probability. While a typical use case might involve the distribution of calendars by a BirthTriggeredIV in the context of a routine vaccination schedule, calendars may also be distributed directly to individuals.

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
Actual_IndividualIntervention_Configs array of JSON objects NA NA NA An array of interventions that will be distributed as specified in the calendar. This parameter selects a class for the intervention and configures the parameters specific for that intervention class.
{  
    "Actual_IndividualIntervention_Config": {
        "class": "IVCalendar",
        "Actual_IndividualIntervention_Configs": [{
            "class": "BCGVaccine",
            "Cost_To_Consumer": 10,
            "Vaccine_Take": 1,
            "Vaccine_Take_Age_Decay_Rate": 0,
             "Waning_Config": {
                "Initial_Effect": 1,
                "Box_Duration": 3650,
                "Decay_Rate_Factor": 3650,
                "class": "WaningEffectBoxExponential"
            }
        }]
    }
}    
Age float 0 45625 NA An array of ages (in days). In IVCalendar, there is a list of actual interventions where the distribution is dependent on whether the individual’s age matches the next date in the calendar.
{
    "Calendar": [{
            "Age": 60,
            "Probability": 1
        },
        {
            "Age": 120,
            "Probability": 1
        },
        {
            "Age": 180,
            "Probability": 1
        },
        {
            "Age": 510,
            "Probability": 0.9
        },
        {
            "Age": 1825,
            "Probability": 0.95
        },
        {
            "Age": 4200,
            "Probability": 0.95
        }
    ]
}
Calendar array of JSON objects NA NA NA An array of ages, days and the probabilities of receiving the list of interventions at each age. Calendar has two parameters: Probability and Age.
{
    "Calendar": [{
            "Age": 60,
            "Probability": 1
        },
        {
            "Age": 120,
            "Probability": 1
        },
        {
            "Age": 180,
            "Probability": 1
        },
        {
            "Age": 510,
            "Probability": 0.9
        },
        {
            "Age": 1825,
            "Probability": 0.95
        },
        {
            "Age": 4200,
            "Probability": 0.95
        }
    ]
}
Dropout boolean NA NA 0 If set to true (1), when an intervention distribution is missed, all subsequent interventions are also missed. If set to false (0), all calendar dates/doses are applied independently of each other.
{
    "Actual_IndividualIntervention_Config": {
        "class": "IVCalendar",
        "Dont_Allow_Duplicates": 0,
        "Dropout": 0,
        "Calendar": [{
            "Age": 12045,
            "Probability": 1
        }]
    }
}
Probability float 0 1 NA The probability of an individual receiving the list of actual interventions at the corresponding age.
{
    "Calendar": [{
            "Age": 60,
            "Probability": 1
        },
        {
            "Age": 120,
            "Probability": 1
        },
        {
            "Age": 180,
            "Probability": 1
        },
        {
            "Age": 510,
            "Probability": 0.9
        },
        {
            "Age": 1825,
            "Probability": 0.95
        },
        {
            "Age": 4200,
            "Probability": 0.95
        }
    ]
}
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": "BCG vaccination calendar distributed at birth",
    "Events": [{
        "Event_Name": "BCG vaccinations scheduled at birth",
        "class": "CampaignEvent",
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Start_Day": 1825,
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Target_Demographic": "Everyone",
            "Intervention_Config": {
                "class": "BirthTriggeredIV",
                "Demographic_Coverage": 0.9,
                "Actual_IndividualIntervention_Config": {
                    "class": "IVCalendar",
                    "Calendar": [{
                            "Age": 30,
                            "Probability": 1
                        },
                        {
                            "Age": 3650,
                            "Probability": 1
                        }
                    ],
                    "Dropout": 0,
                    "Actual_IndividualIntervention_Configs": [{
                        "class": "BCGVaccine",
                        "Cost_To_Consumer": 8,
                        "Vaccine_Take": 0.8,
                        "Vaccine_Take_Age_Decay_Rate": 0.2,
                        "Waning_Config": {
                            "Initial_Rate": 0.9,
                            "Decay_Time_Constant": 3650,
                            "class": "WaningEffectExponential"
                        }
                    }]
                }
            }
        }
    }]
}