DelayedIntervention
The DelayedIntervention intervention class introduces a delay between when the intervention is distributed to the individual and when they receive the actual intervention. This is due to the frequent occurrences of time delays as individuals seek care and receive treatment. This intervention allows configuration of the distribution type for the delay as well as the fraction of the population that receives the specified intervention.
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 |
|---|---|---|---|---|---|---|
| Actual_IndividualIntervention_Configs | link | An array of nested interventions to be distributed at the end of a delay period, to covered fraction of the population. | array of JSON objects | nan | nan | nan |
| Coverage | link | The proportion of individuals who receive the DelayedIntervention that actually receive the configured interventions. | float | 0 | 1 | 1 |
| Delay_Period_Constant | link | The delay period, in days, to use for all interventions when Delay_Period_Distribution is set to CONSTANT_DISTRIBUTION. | float | 0 | 3.40282e+38 | -1 |
| Delay_Period_Distribution | link | The distribution type to use for assigning the delay period for distributing interventions. Each assigned value is a random draw from the distribution. Possible values are: NOT_INITIALIZED No distribution set. CONSTANT_DISTRIBUTION Use the same value for each individual. Set Delay_Period_Constant. UNIFORM_DISTRIBUTION Use a uniform distribution with a given minimum and maximum. Set Delay_Period_Max and Delay_Period_Min.GAUSSIAN_DISTRIBUTION The distribution is Gaussian (or normal). Values are resampled to ensure >= 0. Set Delay_Period_Gaussian_Mean and Delay_Period_Gaussian_Std_Dev.EXPONENTIAL_DISTRIBUTION The distribution is exponential with a given mean. Set Delay_Period_Exponential.WEIBULL_DISTRIBUTION Use a Weibull distribution with a given shape and scale. Set Delay_Period_Kappa and Delay_Period_Lambda.LOG_NORMAL_DISTRIBUTION Use a log-normal distribution with a given mean and standard deviation of the natural log. Set Delay_Period_Log_Normal_Mu and Delay_Period_Log_Normal_Sigma.POISSON_DISTRIBUTION Use a Poisson distribution with a given mean. Set Delay_Period_Poisson_Mean. DUAL_CONSTANT_DISTRIBUTION Use a distribution where some individuals are set to a value of zero and the rest to a given value. Set Delay_Period_Proportion_0 and Peak_2_Value. DUAL_EXPONENTIAL_DISTRIBUTION Use two exponential distributions with given means. Set Delay_Period_Mean_1, Delay_Period_Mean_2, and Delay_Period_Proportion_1. .. _Gaussian: https://en.wikipedia.org/wiki/Normal_distribution .. _exponential: https://en.wikipedia.org/wiki/Exponential_distribution .. _Weibull: https://en.wikipedia.org/wiki/Weibull_distribution .. _log-normal: https://en.wikipedia.org/wiki/Log-normal_distribution .. _uniform: https://en.wikipedia.org/wiki/Uniform_distribution(continuous) .. _Poisson: https://en.wikipedia.org/wiki/Poisson_distribution |
enum | nan | nan | NOT_INITIALIZED |
| Delay_Period_Exponential | link | The mean of the delay period, in days, when Delay_Period_Distribution is set to EXPONENTIAL_DISTRIBUTION. | float | 0 | 3.40282e+38 | -1 |
| Delay_Period_Gaussian_Mean | link | The mean of the delay period, in days, when Delay_Period_Distribution is set to GAUSSIAN_DISTRIBUTION. | float | 0 | 3.40282e+38 | -1 |
| Delay_Period_Gaussian_Std_Dev | link | The standard deviation of the delay period, in days, when Delay_Period_Distribution is set to GAUSSIAN_DISTRIBUTION. | float | 1.17549e-38 | 3.40282e+38 | -1 |
| Delay_Period_Kappa | link | The shape value for the delay period, in days, when Delay_Period_Distribution is set to WEIBULL_DISTRIBUTION. | float | 1.17549e-38 | 3.40282e+38 | -1 |
| Delay_Period_Lambda | link | The scale value for the delay period, in days, when Delay_Period_Distribution is set to WEIBULL_DISTRIBUTION. | float | 1.17549e-38 | 3.40282e+38 | -1 |
| Delay_Period_Log_Normal_Mu | link | The mean of the natural log of the delay period, in days, when Delay_Period_Distribution is set to LOG_NORMAL_DISTRIBUTION. | float | -3.40282e+38 | 1.70141e+38 | 3.40282e+38 |
| Delay_Period_Log_Normal_Sigma | link | The standard deviation of the natural log of the delay period, in days, when Delay_Period_Distribution is set to LOG_NORMAL_DISTRIBUTION. | float | -3.40282e+38 | 1.70141e+38 | 3.40282E+38 |
| Delay_Period_Max | link | The maximum delay period, in days, when Delay_Period_Distribution is set to UNIFORM_DISTRIBUTION. | float | 0 | 3.40282e+38 | -1 |
| Delay_Period_Mean_1 | link | The mean of the first exponential distribution, in days, when Delay_Period_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION. | float | 1.17549e-38 | 3.40282e+38 | -1 |
| Delay_Period_Mean_2 | link | The mean of the second exponential distribution, in days, when Delay_Period_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION. | float | 1.17549e-38 | 3.40282e+38 | -1 |
| Delay_Period_Min | link | The minimum delay period, in days, when Delay_Period_Distribution is set to UNIFORM_DISTRIBUTION. | float | 0 | 3.40282e+38 | -1 |
| Delay_Period_Peak_2_Value | link | The delay period value to assign to the remaining interventions when Delay_Period_Distribution is set to DUAL_CONSTANT_DISTRIBUTION. | float | 0 | 3.40282e+38 | -1 |
| Delay_Period_Poisson_Mean | link | The mean of the delay period when Delay_Period_Distribution is set to POISSON_DISTRIBUTION. | float | 0 | 3.40282e+38 | -1 |
| Delay_Period_Proportion_0 | link | The proportion of interventions to assign a value of zero delay when Delay_Period_Distribution is set to DUAL_CONSTANT_DISTRIBUTION. | float | 0 | 1 | -1 |
| Delay_Period_Proportion_1 | link | The proportion of interventions in the first exponential distribution when Delay_Period_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION. | float | 0 | 1 | -1 |
| 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 | DelayedIntervention |
| 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 |