tlo.methods.cardio_metabolic_disorders module ============================================= .. automodule:: tlo.methods.cardio_metabolic_disorders .. autoclass:: CardioMetabolicDisorders Bases: :class:`tlo.core.Module` **PARAMETERS:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - diabetes_onset - DICT - all the parameters that specify the linear models for onset of diabetes * - hypertension_onset - DICT - all the parameters that specify the linear models for onset of hypertension * - chronic_kidney_disease_onset - DICT - all the parameters that specify the linear models for onset of chronic_kidney_disease * - chronic_lower_back_pain_onset - DICT - all the parameters that specify the linear models for onset of chronic_lower_back_pain * - chronic_ischemic_hd_onset - DICT - all the parameters that specify the linear models for onset of chronic_ischemic_hd * - diabetes_removal - DICT - all the parameters that specify the linear models for removal of diabetes * - hypertension_removal - DICT - all the parameters that specify the linear models for removal of hypertension * - chronic_kidney_disease_removal - DICT - all the parameters that specify the linear models for removal of chronic_kidney_disease * - chronic_lower_back_pain_removal - DICT - all the parameters that specify the linear models for removal of chronic_lower_back_pain * - chronic_ischemic_hd_removal - DICT - all the parameters that specify the linear models for removal of chronic_ischemic_hd * - diabetes_hsi - DICT - all the parameters that specify diagnostic tests and treatments for diabetes * - hypertension_hsi - DICT - all the parameters that specify diagnostic tests and treatments for hypertension * - chronic_kidney_disease_hsi - DICT - all the parameters that specify diagnostic tests and treatments for chronic_kidney_disease * - chronic_lower_back_pain_hsi - DICT - all the parameters that specify diagnostic tests and treatments for chronic_lower_back_pain * - chronic_ischemic_hd_hsi - DICT - all the parameters that specify diagnostic tests and treatments for chronic_ischemic_hd * - ever_stroke_onset - DICT - all the parameters that specify the linear models for onset of ever_stroke * - ever_heart_attack_onset - DICT - all the parameters that specify the linear models for onset of ever_heart_attack * - diabetes_death - DICT - all the parameters that specify the linear models for death from diabetes * - hypertension_death - DICT - all the parameters that specify the linear models for death from hypertension * - chronic_kidney_disease_death - DICT - all the parameters that specify the linear models for death from chronic_kidney_disease * - chronic_lower_back_pain_death - DICT - all the parameters that specify the linear models for death from chronic_lower_back_pain * - chronic_ischemic_hd_death - DICT - all the parameters that specify the linear models for death from chronic_ischemic_hd * - ever_stroke_death - DICT - all the parameters that specify the linear models for death from ever_stroke * - ever_heart_attack_death - DICT - all the parameters that specify the linear models for death from ever_heart_attack * - ever_stroke_hsi - DICT - all the parameters that specify diagnostic tests and treatments for ever_stroke * - ever_heart_attack_hsi - DICT - all the parameters that specify diagnostic tests and treatments for ever_heart_attack * - diabetes_initial_prev - DICT - initial prevalence of condition * - hypertension_initial_prev - DICT - initial prevalence of condition * - chronic_kidney_disease_initial_prev - DICT - initial prevalence of condition * - chronic_lower_back_pain_initial_prev - DICT - initial prevalence of condition * - chronic_ischemic_hd_initial_prev - DICT - initial prevalence of condition * - interval_between_polls - INT - months between the main polling event * - pr_bmi_reduction - INT - probability of an individual having a reduction in BMI following weight loss treatment * - prob_care_provided_given_seek_emergency_care - REAL - The probability that correct care is fully provided to persons that have sought emergency care for a Cardio-metabolic disorder. **PROPERTIES:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - nc_diabetes - BOOL - Whether or not someone has diabetes * - nc_hypertension - BOOL - Whether or not someone has hypertension * - nc_chronic_kidney_disease - BOOL - Whether or not someone has chronic_kidney_disease * - nc_chronic_lower_back_pain - BOOL - Whether or not someone has chronic_lower_back_pain * - nc_chronic_ischemic_hd - BOOL - Whether or not someone has chronic_ischemic_hd * - nc_ever_stroke - BOOL - Whether or not someone has had a ever_stroke * - nc_ever_heart_attack - BOOL - Whether or not someone has had a ever_heart_attack * - nc_diabetes_ever_diagnosed - BOOL - Whether or not someone has ever been diagnosed with diabetes * - nc_hypertension_ever_diagnosed - BOOL - Whether or not someone has ever been diagnosed with hypertension * - nc_chronic_kidney_disease_ever_diagnosed - BOOL - Whether or not someone has ever been diagnosed with chronic_kidney_disease * - nc_chronic_lower_back_pain_ever_diagnosed - BOOL - Whether or not someone has ever been diagnosed with chronic_lower_back_pain * - nc_chronic_ischemic_hd_ever_diagnosed - BOOL - Whether or not someone has ever been diagnosed with chronic_ischemic_hd * - nc_diabetes_date_diagnosis - DATE - When someone has been diagnosed with diabetes * - nc_hypertension_date_diagnosis - DATE - When someone has been diagnosed with hypertension * - nc_chronic_kidney_disease_date_diagnosis - DATE - When someone has been diagnosed with chronic_kidney_disease * - nc_chronic_lower_back_pain_date_diagnosis - DATE - When someone has been diagnosed with chronic_lower_back_pain * - nc_chronic_ischemic_hd_date_diagnosis - DATE - When someone has been diagnosed with chronic_ischemic_hd * - nc_diabetes_date_last_test - DATE - When someone has last been tested for diabetes * - nc_hypertension_date_last_test - DATE - When someone has last been tested for hypertension * - nc_chronic_kidney_disease_date_last_test - DATE - When someone has last been tested for chronic_kidney_disease * - nc_chronic_lower_back_pain_date_last_test - DATE - When someone has last been tested for chronic_lower_back_pain * - nc_chronic_ischemic_hd_date_last_test - DATE - When someone has last been tested for chronic_ischemic_hd * - nc_diabetes_on_medication - BOOL - Whether or not someone is on medication for diabetes * - nc_hypertension_on_medication - BOOL - Whether or not someone is on medication for hypertension * - nc_chronic_kidney_disease_on_medication - BOOL - Whether or not someone is on medication for chronic_kidney_disease * - nc_chronic_lower_back_pain_on_medication - BOOL - Whether or not someone is on medication for chronic_lower_back_pain * - nc_chronic_ischemic_hd_on_medication - BOOL - Whether or not someone is on medication for chronic_ischemic_hd * - nc_diabetes_medication_prevents_death - BOOL - Whether or not medication (if provided) will prevent death from diabetes * - nc_hypertension_medication_prevents_death - BOOL - Whether or not medication (if provided) will prevent death from hypertension * - nc_chronic_kidney_disease_medication_prevents_death - BOOL - Whether or not medication (if provided) will prevent death from chronic_kidney_disease * - nc_chronic_lower_back_pain_medication_prevents_death - BOOL - Whether or not medication (if provided) will prevent death from chronic_lower_back_pain * - nc_chronic_ischemic_hd_medication_prevents_death - BOOL - Whether or not medication (if provided) will prevent death from chronic_ischemic_hd * - nc_ever_stroke_date_last_event - DATE - Date of last ever_stroke * - nc_ever_heart_attack_date_last_event - DATE - Date of last ever_heart_attack * - nc_ever_stroke_ever_diagnosed - BOOL - Whether or not someone has ever been diagnosed with ever_stroke * - nc_ever_heart_attack_ever_diagnosed - BOOL - Whether or not someone has ever been diagnosed with ever_heart_attack * - nc_ever_stroke_date_diagnosis - DATE - When someone has last been diagnosed with ever_stroke * - nc_ever_heart_attack_date_diagnosis - DATE - When someone has last been diagnosed with ever_heart_attack * - nc_ever_stroke_on_medication - BOOL - Whether or not someone has ever been diagnosed with ever_stroke * - nc_ever_heart_attack_on_medication - BOOL - Whether or not someone has ever been diagnosed with ever_heart_attack * - nc_ever_stroke_medication_prevents_death - BOOL - Whether or not medication will prevent death from ever_stroke * - nc_ever_heart_attack_medication_prevents_death - BOOL - Whether or not medication will prevent death from ever_heart_attack * - nc_ever_stroke_scheduled_date_death - DATE - Scheduled date of death from ever_stroke * - nc_ever_heart_attack_scheduled_date_death - DATE - Scheduled date of death from ever_heart_attack * - nc_ever_weight_loss_treatment - BOOL - whether or not the person has ever had weight loss treatment * - nc_weight_loss_worked - BOOL - whether or not weight loss treatment worked * - nc_risk_score - INT - score to represent number of risk conditions the person has **Class attributes:** ADDITIONAL_DEPENDENCIES : {'Depression'} CAUSES_OF_DEATH : {'diabetes': , 'chronic_ischemic_hd': , 'ever_heart_attack': , 'ever_stroke': , 'chronic_kidney_disease': } CAUSES_OF_DISABILITY : {'diabetes': , 'chronic_ischemic_hd': , 'heart_attack': , 'stroke': , 'chronic_kidney_disease': , 'lower_back_pain': } INIT_DEPENDENCIES : {'SymptomManager', 'HealthSystem', 'Demography', 'Lifestyle'} METADATA : {, , , } OPTIONAL_INIT_DEPENDENCIES : {'HealthBurden'} condition_date_diagnosis_list : {'nc_diabetes_date_diagnosis': DATE === When someone has been diagnosed with diabetes, 'nc_hypertension_date_diagnosis': DATE === When someone has been diagnosed with hypertension, 'nc_chronic_kidney_disease_date_diagnosis': DATE === When someone has been diagnosed with chronic_kidney_disease, 'nc_chronic_lower_back_pain_date_diagnosis': DATE === When someone has been diagnosed with chronic_lower_back_pain, 'nc_chronic_ischemic_hd_date_diagnosis': DATE === When someone has been diagnosed with chronic_ischemic_hd} condition_date_of_last_test_list : {'nc_diabetes_date_last_test': DATE === When someone has last been tested for diabetes, 'nc_hypertension_date_last_test': DATE === When someone has last been tested for hypertension, 'nc_chronic_kidney_disease_date_last_test': DATE === When someone has last been tested for chronic_kidney_disease, 'nc_chronic_lower_back_pain_date_last_test': DATE === When someone has last been tested for chronic_lower_back_pain, 'nc_chronic_ischemic_hd_date_last_test': DATE === When someone has last been tested for chronic_ischemic_hd} condition_diagnosis_list : {'nc_diabetes_ever_diagnosed': BOOL === Whether or not someone has ever been diagnosed with diabetes, 'nc_hypertension_ever_diagnosed': BOOL === Whether or not someone has ever been diagnosed with hypertension, 'nc_chronic_kidney_disease_ever_diagnosed': BOOL === Whether or not someone has ever been diagnosed with chronic_kidney_disease, 'nc_chronic_lower_back_pain_ever_diagnosed': BOOL === Whether or not someone has ever been diagnosed with chronic_lower_back_pain, 'nc_chronic_ischemic_hd_ever_diagnosed': BOOL === Whether or not someone has ever been diagnosed with chronic_ischemic_hd} condition_list : {'nc_diabetes': BOOL === Whether or not someone has diabetes, 'nc_hypertension': BOOL === Whether or not someone has hypertension, 'nc_chronic_kidney_disease': BOOL === Whether or not someone has chronic_kidney_disease, 'nc_chronic_lower_back_pain': BOOL === Whether or not someone has chronic_lower_back_pain, 'nc_chronic_ischemic_hd': BOOL === Whether or not someone has chronic_ischemic_hd} condition_medication_death_list : {'nc_diabetes_medication_prevents_death': BOOL === Whether or not medication (if provided) will prevent death from diabetes, 'nc_hypertension_medication_prevents_death': BOOL === Whether or not medication (if provided) will prevent death from hypertension, 'nc_chronic_kidney_disease_medication_prevents_death': BOOL === Whether or not medication (if provided) will prevent death from chronic_kidney_disease, 'nc_chronic_lower_back_pain_medication_prevents_death': BOOL === Whether or not medication (if provided) will prevent death from chronic_lower_back_pain, 'nc_chronic_ischemic_hd_medication_prevents_death': BOOL === Whether or not medication (if provided) will prevent death from chronic_ischemic_hd} condition_medication_list : {'nc_diabetes_on_medication': BOOL === Whether or not someone is on medication for diabetes, 'nc_hypertension_on_medication': BOOL === Whether or not someone is on medication for hypertension, 'nc_chronic_kidney_disease_on_medication': BOOL === Whether or not someone is on medication for chronic_kidney_disease, 'nc_chronic_lower_back_pain_on_medication': BOOL === Whether or not someone is on medication for chronic_lower_back_pain, 'nc_chronic_ischemic_hd_on_medication': BOOL === Whether or not someone is on medication for chronic_ischemic_hd} conditions : ['diabetes', 'hypertension', 'chronic_kidney_disease', 'chronic_lower_back_pain', 'chronic_ischemic_hd'] death_conditions_param_dicts : {'diabetes_death': DICT === all the parameters that specify the linear models for death from diabetes, 'hypertension_death': DICT === all the parameters that specify the linear models for death from hypertension, 'chronic_kidney_disease_death': DICT === all the parameters that specify the linear models for death from chronic_kidney_disease, 'chronic_lower_back_pain_death': DICT === all the parameters that specify the linear models for death from chronic_lower_back_pain, 'chronic_ischemic_hd_death': DICT === all the parameters that specify the linear models for death from chronic_ischemic_hd} death_events_param_dicts : {'ever_stroke_death': DICT === all the parameters that specify the linear models for death from ever_stroke, 'ever_heart_attack_death': DICT === all the parameters that specify the linear models for death from ever_heart_attack} event_date_diagnosis_list : {'nc_ever_stroke_date_diagnosis': DATE === When someone has last been diagnosed with ever_stroke, 'nc_ever_heart_attack_date_diagnosis': DATE === When someone has last been diagnosed with ever_heart_attack} event_date_last_list : {'nc_ever_stroke_date_last_event': DATE === Date of last ever_stroke, 'nc_ever_heart_attack_date_last_event': DATE === Date of last ever_heart_attack} event_diagnosis_list : {'nc_ever_stroke_ever_diagnosed': BOOL === Whether or not someone has ever been diagnosed with ever_stroke, 'nc_ever_heart_attack_ever_diagnosed': BOOL === Whether or not someone has ever been diagnosed with ever_heart_attack} event_list : {'nc_ever_stroke': BOOL === Whether or not someone has had a ever_stroke, 'nc_ever_heart_attack': BOOL === Whether or not someone has had a ever_heart_attack} event_medication_death_list : {'nc_ever_stroke_medication_prevents_death': BOOL === Whether or not medication will prevent death from ever_stroke, 'nc_ever_heart_attack_medication_prevents_death': BOOL === Whether or not medication will prevent death from ever_heart_attack} event_medication_list : {'nc_ever_stroke_on_medication': BOOL === Whether or not someone has ever been diagnosed with ever_stroke, 'nc_ever_heart_attack_on_medication': BOOL === Whether or not someone has ever been diagnosed with ever_heart_attack} event_scheduled_date_death_list : {'nc_ever_stroke_scheduled_date_death': DATE === Scheduled date of death from ever_stroke, 'nc_ever_heart_attack_scheduled_date_death': DATE === Scheduled date of death from ever_heart_attack} events : ['ever_stroke', 'ever_heart_attack'] hsi_conditions_param_dicts : {'diabetes_hsi': DICT === all the parameters that specify diagnostic tests and treatments for diabetes, 'hypertension_hsi': DICT === all the parameters that specify diagnostic tests and treatments for hypertension, 'chronic_kidney_disease_hsi': DICT === all the parameters that specify diagnostic tests and treatments for chronic_kidney_disease, 'chronic_lower_back_pain_hsi': DICT === all the parameters that specify diagnostic tests and treatments for chronic_lower_back_pain, 'chronic_ischemic_hd_hsi': DICT === all the parameters that specify diagnostic tests and treatments for chronic_ischemic_hd} hsi_events_param_dicts : {'ever_stroke_hsi': DICT === all the parameters that specify diagnostic tests and treatments for ever_stroke, 'ever_heart_attack_hsi': DICT === all the parameters that specify diagnostic tests and treatments for ever_heart_attack} initial_prev_param_dicts : {'diabetes_initial_prev': DICT === initial prevalence of condition, 'hypertension_initial_prev': DICT === initial prevalence of condition, 'chronic_kidney_disease_initial_prev': DICT === initial prevalence of condition, 'chronic_lower_back_pain_initial_prev': DICT === initial prevalence of condition, 'chronic_ischemic_hd_initial_prev': DICT === initial prevalence of condition} onset_conditions_param_dicts : {'diabetes_onset': DICT === all the parameters that specify the linear models for onset of diabetes, 'hypertension_onset': DICT === all the parameters that specify the linear models for onset of hypertension, 'chronic_kidney_disease_onset': DICT === all the parameters that specify the linear models for onset of chronic_kidney_disease, 'chronic_lower_back_pain_onset': DICT === all the parameters that specify the linear models for onset of chronic_lower_back_pain, 'chronic_ischemic_hd_onset': DICT === all the parameters that specify the linear models for onset of chronic_ischemic_hd} onset_events_param_dicts : {'ever_stroke_onset': DICT === all the parameters that specify the linear models for onset of ever_stroke, 'ever_heart_attack_onset': DICT === all the parameters that specify the linear models for onset of ever_heart_attack} other_params_dict : {'interval_between_polls': INT === months between the main polling event, 'pr_bmi_reduction': INT === probability of an individual having a reduction in BMI following weight loss treatment} removal_conditions_param_dicts : {'diabetes_removal': DICT === all the parameters that specify the linear models for removal of diabetes, 'hypertension_removal': DICT === all the parameters that specify the linear models for removal of hypertension, 'chronic_kidney_disease_removal': DICT === all the parameters that specify the linear models for removal of chronic_kidney_disease, 'chronic_lower_back_pain_removal': DICT === all the parameters that specify the linear models for removal of chronic_lower_back_pain, 'chronic_ischemic_hd_removal': DICT === all the parameters that specify the linear models for removal of chronic_ischemic_hd} **Functions (defined or overridden in class CardioMetabolicDisorders):** .. automethod:: __init__ .. automethod:: read_parameters .. automethod:: initialise_population .. automethod:: initialise_simulation .. automethod:: build_linear_model .. automethod:: build_linear_model_symptoms .. automethod:: on_birth .. automethod:: update_risk_score .. automethod:: report_daly_values .. automethod:: on_hsi_alert .. automethod:: determine_if_will_be_investigated .. automethod:: determine_if_will_be_investigated_events .. autoclass:: CardioMetabolicDisorders_MainPollingEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class CardioMetabolicDisorders_MainPollingEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: CardioMetabolicDisordersEvent Bases: :class:`tlo.events.Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class CardioMetabolicDisordersEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: CardioMetabolicDisordersDeathEvent Bases: :class:`tlo.events.Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class CardioMetabolicDisordersDeathEvent):** .. automethod:: __init__ .. automethod:: apply .. automethod:: check_if_event_and_do_death .. autoclass:: CardioMetabolicDisordersWeightLossEvent Bases: :class:`tlo.events.Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class CardioMetabolicDisordersWeightLossEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: CardioMetabolicDisorders_LoggingEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class CardioMetabolicDisorders_LoggingEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_CardioMetabolicDisorders_CommunityTestingForHypertension Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_CardioMetabolicDisorders_CommunityTestingForHypertension):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_CardioMetabolicDisorders_Investigations Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_CardioMetabolicDisorders_Investigations):** .. automethod:: __init__ .. automethod:: do_for_each_condition .. automethod:: apply .. autoclass:: HSI_CardioMetabolicDisorders_StartWeightLossAndMedication Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_CardioMetabolicDisorders_StartWeightLossAndMedication):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_CardioMetabolicDisorders_Refill_Medication Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_CardioMetabolicDisorders_Refill_Medication):** .. automethod:: __init__ .. automethod:: apply .. automethod:: did_not_run .. autoclass:: HSI_CardioMetabolicDisorders_SeeksEmergencyCareAndGetsTreatment Bases: :class:`tlo.methods.healthsystem.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Functions (defined or overridden in class HSI_CardioMetabolicDisorders_SeeksEmergencyCareAndGetsTreatment):** .. automethod:: __init__ .. automethod:: do_for_each_event_to_be_investigated .. automethod:: apply .. automethod:: did_not_run