PropertyValueChanger

The PropertyValueChanger intervention class assigns new individual property values to individuals. You must update one property value and have the option to update another using New_Property_Value. This parameter is generally used to move patients from one intervention state in the health care cascade (InterventionStatus) to another, though it can be used for any individual property. Individual property values are user-defined in the demographics file (see NodeProperties and IndividualProperties for more information). Note that the HINT feature does not need to be enabled to use this intervention. To instead change node properties, use NodePropertyValueChanger.

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
Daily_Probability	float	0	1	1	The daily probability that an individual will move to the Target_Property_Value.	{ "Intervention_Config": { "class": "PropertyValueChanger", "Disqualifying_Properties": [], "New_Property_Value": "", "Target_Property_Key": "Risk", "Target_Property_Value": "LOW", "Daily_Probability": 1.0, "Maximum_Duration": 0, "Revert": 0 } }
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 nodes 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 }
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_Config": { "class": "PropertyValueChanger", "Intervention_Name": "Diagnosed HIV+ to ART" } }
Maximum_Duration	float	-1	3.40E+38	3.40E+38	The maximum amount of time individuals have to move to a new group. This timing works in conjunction with Daily_Probability.	{ "Intervention_Config": { "class": "PropertyValueChanger", "Disqualifying_Properties": [], "New_Property_Value": "", "Target_Property_Key": "Risk", "Target_Property_Value": "LOW", "Daily_Probability": 1.0, "Maximum_Duration": 0, "Revert": 0 } }
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" }
Revert	float	0	10000	0	The number of days before an individual moves back to their original group.	{ "Intervention_Config": { "class": "PropertyValueChanger", "Disqualifying_Properties": [], "New_Property_Value": "", "Target_Property_Key": "Risk", "Target_Property_Value": "LOW", "Daily_Probability": 1.0, "Maximum_Duration": 0, "Revert": 0 } }
Target_Property_Key	string	NA	NA	NA	The name of the individual property type whose value will be updated by the intervention.	{ "Intervention_Config": { "class": "PropertyValueChanger", "Disqualifying_Properties": [], "New_Property_Value": "", "Target_Property_Key": "Risk", "Target_Property_Value": "LOW", "Daily_Probability": 1.0, "Maximum_Duration": 0, "Revert": 0 } }
Target_Property_Value	string	NA	NA	NA	The user-defined value of the individual property that will be assigned to the individual.	{ "Intervention_Config": { "class": "PropertyValueChanger", "Disqualifying_Properties": [], "Target_Property_Key": "Risk", "Target_Property_Value": "LOW", "New_Property_Value": "", "Daily_Probability": 1.0, "Maximum_Duration": 0, "Revert": 0 } }

{
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 10,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Target_Demographic": "Everyone",
                "Demographic_Coverage": 1.0,
                "Property_Restrictions": [
                    "Risk:LOW"
                ],
                "Intervention_Config": {
                    "class": "PropertyValueChanger",
                    "Disqualifying_Properties": [ "InterventionStatus:Diagnosed"],
                    "New_Property_Value": "InterventionStatus:Monitor",
                    "Target_Property_Key" : "Risk",
                    "Target_Property_Value" : "HIGH",
                    "Daily_Probability" : 1.0,
                    "Maximum_Duration" : 0,
                    "Revert" : 10
                }
            }
        }
    ],
    "Use_Defaults": 1
}