IndividualNonDiseaseDeathRateModifier¶
The IndividualNonDiseaseDeathRateModifier intervention class provides a method of modifying an individual’s non-disease mortality rate over time, until an expiration event is reached. For example, this intervention could be given to people who have access to health care to model that they have a different life expectancy than those who do not. Different distribution patterns can be designated, and linear interpolation will be used to calculate values between time points.
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 |
Data type |
Minimum |
Maximum |
Default |
Description |
Example |
|---|---|---|---|---|---|---|
Cost_To_Consumer |
float |
999999 |
0 |
0 |
The cost of getting the non-disease death modifier each time it is distributed. |
{
"Cost_To_Consumer": 1
}
|
Disqualifying_Properties |
array of strings |
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"
]
}
|
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. |
{
"Dont_Allow_Duplicates": 0
}
|
Duration_To_Modifier |
array of json objects |
NA |
NA |
NA |
An array of Times and Values used to specify different modifiers over the duration of the intervention. Linear interpolation is used to find the values between time points. If the duration exceeds the max time, then the last modifier value will be used. |
{
"Duration_To_Modifier": {
"Times": [
0,
365,
730,
1095
],
"Values": [
2,
1,
0.5,
0
]
}
}
|
Expiration_Duration_Constant |
float |
0 |
3.40282e+38 |
6 |
Each instance will receive this constant/fixed value. |
{
"Expiration_Duration_Constant": 6
}
|
Expiration_Duration_Distribution |
enum |
NA |
NA |
NOT_INITIALIZED |
For the distribution of each intervention, a randomly selected duration from this distribution will determine when the person stops using the intervention. This is independent of how long the intervention is effective. Possible values are:
|
{
"Expiration_Duration_Distribution": "CONSTANT_DISTRIBUTION"
}
|
Expiration_Duration_Exponential |
float |
0 |
3.40282e+38 |
6 |
The mean for an exponential distribution. |
{
"Expiration_Duration_Exponential": 6
}
|
Expiration_Duration_Gaussian_Mean |
float |
0 |
3.40282e+38 |
6 |
The mean for a Gaussian distribution. |
{
"Expiration_Duration_Gaussian_Mean": 6
}
|
Expiration_Duration_Gaussian_Std_Dev |
float |
1.17549e-38 |
3.40282e+38 |
1 |
The standard deviation for a Gaussian distribution. |
{
"Expiration_Duration_Gaussian_Std_Dev": 1
}
|
Expiration_Duration_Kappa |
float |
1.17549e-38 |
3.40282e+38 |
1 |
The shape value in a Weibull distribution. |
{
"Expiration_Duration_Kappa": 1
}
|
Expiration_Duration_Lambda |
float |
1.17549e-38 |
3.40282e+38 |
1 |
The scale value in a Weibull distribution. |
{
"Expiration_Duration_Lambda": 1
}
|
Expiration_Duration_Log_Normal_Mu |
float |
-3.40282e+38 |
3.40282e+38 |
6 |
The mean for a log-normal distribution. |
{
"Expiration_Duration_Log_Normal_Mu": 6
}
|
Expiration_Duration_Log_Normal_Sigma |
float |
-3.40282e+38 |
3.40282e+38 |
1 |
The width for a log-normal distribution. |
{
"Expiration_Duration_Log_Normal_Sigma": 1
}
|
Expiration_Duration_Max |
float |
0 |
3.40282e+38 |
1 |
The maximum of the uniform distribution. |
{
"Expiration_Duration_Max": 1
}
|
Expiration_Duration_Mean_1 |
float |
1.17549e-38 |
3.40282e+38 |
1 |
The mean of the first exponential distribution. |
{
"Expiration_Duration_Mean_1": 1
}
|
Expiration_Duration_Mean_2 |
float |
1.17549e-38 |
3.40282e+38 |
1 |
The mean of the second exponential distribution. |
{
"Expiration_Duration_Mean_2": 1
}
|
Expiration_Duration_Min |
float |
0 |
3.40282e+38 |
0 |
The minimum of the uniform distribution. |
{
"Expiration_Duration_Min": 0
}
|
Expiration_Duration_Peak_2_Value |
float |
0 |
3.40282e+38 |
1 |
The value to assign to the remaining individuals. |
{
"Expiration_Duration_Peak_2_Value": 1
}
|
Expiration_Duration_Poisson_Mean |
float |
0 |
3.40282e+38 |
6 |
The mean for a Poisson distribution. |
{
"Expiration_Duration_Poisson_Mean": 6
}
|
Expiration_Duration_Proportion_0 |
float |
0 |
1 |
1 |
The proportion of individuals to assign a value of zero. |
{
"Expiration_Duration_Proportion_0": 1
}
|
Expiration_Duration_Proportion_1 |
float |
0 |
1 |
1 |
The proportion of individuals in the first exponential distribution. |
{
"Expiration_Duration_Proportion_1": 1
}
|
Expiration_Event |
string |
NA |
NA |
“” |
When the person stops using the intervention, this event will be broadcasted. See Event list for possible values or define custom events using config parameter Custom_Individual_Events. |
{
"Expiration_Event": "BackToNormalMortality"
}
|
Intervention_Name |
string |
NA |
NA |
IndividualNonDiseaseDeathRateModifier |
The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. |
{
"Intervention_Config": {
"Intervention_Name": "My Intervention",
"class": "IndividualNonDiseaseDeathRateModifier"
}
}
|
New_Property_Value |
string |
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,
"Events": [
{
"class": "CampaignEvent",
"Start_Day": 3000,
"Nodeset_Config": { "class": "NodeSetAll" },
"Event_Coordinator_Config": {
"class": "StandardInterventionDistributionEventCoordinator",
"Target_Demographic": "Everyone",
"Demographic_Coverage": 1.0,
"Intervention_Config": {
"class": "IndividualNonDiseaseDeathRateModifier",
"Cost_To_Consumer": 1,
"Duration_To_Modifier" : {
"Times" : [ 0.0, 365.0, 730.0, 1095.0 ],
"Values": [ 2.0, 1.0, 0.5, 0.0 ]
},
"Expiration_Duration_Distribution": "CONSTANT_DISTRIBUTION",
"Expiration_Duration_Constant": 1000,
"Expiration_Event": "BackToNormalMortality"
}
}
}
]
}