tlo.methods.healthsystem module =============================== .. automodule:: tlo.methods.healthsystem .. autoclass:: HSI_Event **Class attributes:** bed_days_allocated_to_this_event : **Functions (defined or overridden in class HSI_Event):** .. automethod:: __init__ .. automethod:: apply .. automethod:: did_not_run .. automethod:: never_ran .. automethod:: post_apply_hook .. automethod:: run .. automethod:: get_consumables .. automethod:: make_beddays_footprint .. automethod:: is_all_beddays_allocated .. automethod:: make_appt_footprint .. automethod:: initialise .. automethod:: _check_if_appt_footprint_can_run .. autoclass:: HSIEventWrapper Bases: :class:`tlo.events.Event` **Functions (defined or overridden in class HSIEventWrapper):** .. automethod:: __init__ .. automethod:: run .. autoclass:: HealthSystem Bases: :class:`tlo.core.Module` **PARAMETERS:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - Master_Facilities_List - DATA_FRAME - Listing of all health facilities. * - Officer_Types_Table - DATA_FRAME - The names of the types of health workers ("officers") * - Appt_Types_Table - DATA_FRAME - The names of the type of appointments with the health system * - Appt_Offered_By_Facility_Level - DATA_FRAME - Table indicating whether or not each appointment is offered at each facility level. * - Appt_Time_Table - DATA_FRAME - The time taken for each appointment, according to officer and facility type. * - Daily_Capabilities_actual - DATA_FRAME - The capabilities (minutes of time available of each type of officer in each facility) based on the _estimated current_ number and distribution of staff estimated. * - Daily_Capabilities_funded - DATA_FRAME - The capabilities (minutes of time available of each type of officer in each facility) based on the _potential_ number and distribution of staff estimated (i.e. those positions that can be funded). * - Daily_Capabilities_funded_plus - DATA_FRAME - The capabilities (minutes of time available of each type of officer in each facility) based on the _potential_ number and distribution of staff estimated, with adjustments to permit each appointment type that should be run at facility level to do so in every district. * - item_and_package_code_lookups - DATA_FRAME - Data imported from the OneHealth Tool on consumable items, packages and costs. * - availability_estimates - DATA_FRAME - Estimated availability of consumables in the LMIS dataset. * - cons_availability - STRING - Availability of consumables. If 'default' then use the availability specified in the ResourceFile; if 'none', then let no consumable be ever be available; if 'all', then all consumables are always available. When using 'all' or 'none', requests for consumables are not logged. NB. This parameter is over-riddenif an argument is provided to the module initialiser. * - BedCapacity - DATA_FRAME - Data on the number of beds available of each type by facility_id * - beds_availability - STRING - Availability of beds. If 'default' then use the availability specified in the ResourceFile; if 'none', then let no beds be ever be available; if 'all', then all beds are always available. NB. This parameter is over-ridden if an argument is provided to the module initialiser. * - Service_Availability - LIST - List of services to be available. NB. This parameter is over-ridden if an argument is provided to the module initialiser. **PROPERTIES:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - hs_is_inpatient - BOOL - Whether or not the person is currently an in-patient at any medical facility **Class attributes:** INIT_DEPENDENCIES : {'Demography'} capabilities_today : **Functions (defined or overridden in class HealthSystem):** .. automethod:: __init__ .. automethod:: read_parameters .. automethod:: pre_initialise_population .. automethod:: initialise_population .. automethod:: initialise_simulation .. automethod:: on_birth .. automethod:: on_simulation_end .. automethod:: process_human_resources_files .. automethod:: format_daily_capabilities .. automethod:: get_service_availability .. automethod:: get_cons_availability .. automethod:: get_beds_availability .. automethod:: schedule_hsi_event .. automethod:: _add_hsi_event_queue_item_to_hsi_event_queue .. automethod:: check_hsi_event_is_valid .. automethod:: is_treatment_id_allowed .. automethod:: schedule_batch_of_individual_hsi_events .. automethod:: appt_footprint_is_valid .. automethod:: get_blank_appt_footprint .. automethod:: get_facility_info .. automethod:: get_appt_footprint_as_time_request .. automethod:: get_squeeze_factors .. automethod:: record_hsi_event .. automethod:: write_to_hsi_log .. automethod:: log_current_capabilities_and_usage .. automethod:: remove_beddays_footprint .. automethod:: find_events_for_person .. automethod:: reset_queue .. automethod:: get_item_codes_from_package_name .. automethod:: get_item_code_from_item_name .. automethod:: override_availability_of_consumables .. automethod:: on_end_of_day .. automethod:: on_end_of_year .. automethod:: run_population_level_events .. automethod:: run_individual_level_events .. autoclass:: HealthSystemScheduler Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Functions (defined or overridden in class HealthSystemScheduler):** .. automethod:: __init__ .. automethod:: _is_today_last_day_of_the_year .. automethod:: _get_events_due_today .. automethod:: apply .. autoclass:: HealthSystemChangeParameters Bases: :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Functions (defined or overridden in class HealthSystemChangeParameters):** .. automethod:: __init__ .. automethod:: apply