System Configuration Guide - hmislk/hmis GitHub Wiki

System Configuration Guide

Overview

The HMIS system provides extensive configuration options that allow administrators to customize system behavior according to organizational needs. This guide explains how to access and manage configuration settings effectively.

Configuration Types

1. Application Options

System-wide settings that affect all users and departments

2. Institution Options

Settings specific to your hospital or healthcare institution

3. Department Options

Settings that apply only to specific departments

4. User Options

Personal preferences that individual users can customize

How to Access Configuration Settings

Primary Configuration Access

Navigation Path: Administration โ†’ Manage Institutions โ†’ [Configuration Type]

Application Options

How to Access: Administration โ†’ Manage Institutions โ†’ Application Options
Purpose: System-wide settings affecting all users
Examples: Billing behavior, security settings, global display options

Institution Options

How to Access: Administration โ†’ Manage Institutions โ†’ Institution Options
Purpose: Settings specific to your healthcare facility
Examples: Institution-specific workflows, branding, policies

Department Options

How to Access: Administration โ†’ Manage Institutions โ†’ Department Options
Purpose: Department-specific customizations
Examples: Department billing rules, workflow variations

User Options

How to Access: Administration โ†’ Manage Institutions โ†’ User Options
Purpose: User-level preferences and personalization
Examples: Interface preferences, default values, personal settings

Key Configuration Categories

Billing and Financial Settings

Shift-Based Operations

Configuration Keys:

  • applicationPreference.opdBillingAftershiftStart
  • applicationPreference.pharmacyBillingAfterShiftStart

Impact:

  • When enabled, users must start a cashier shift before processing bills
  • Affects OPD billing, pharmacy billing, and channelling operations
  • Enables Financial Transaction Manager features

How to Configure:

  1. Access Application Options
  2. Search for "shift" or "billing"
  3. Enable/disable shift requirements as needed

Bill Search and Display

Configuration Keys:

  • OPD Bill Item Search By Autocomplete
  • Various display preference settings

Impact:

  • Changes how users search for items during billing
  • Affects interface appearance and workflow speed

Clinical Operations Settings

Laboratory Configuration

Configuration Keys:

  • The system uses the Laboratory Dashboard as its default interface
  • Lab Daily Summary Report - Legacy Method
  • Lab Daily Summary Report - Optimized Method

Impact:

  • Changes laboratory user interface layout
  • Affects report generation performance
  • Determines available menu options

Pharmacy Operations

Configuration Keys:

  • Display Colours for Stock Autocomplete Items
  • Pharmacy Analytics - Show Department Stock By Batch
  • Various pharmacy transfer settings

Impact:

  • Visual aids for stock management
  • Report display options
  • Transfer workflow behavior

Communication and Notifications

Cashier and Reconciliation

Configuration Keys:

  • Recording Shift End Cash is Required Before Viewing Shift Reports
  • Shift Shortage Bills are enabled
  • Shift Excess Bills are enabled

Impact:

  • Enforces cash reconciliation procedures
  • Controls financial accountability features
  • Affects end-of-shift workflows

Configuration Management Best Practices

1. Planning Configuration Changes

  • Document Current Settings: Export or record existing configurations before changes
  • Test Environment: Always test configuration changes in a non-production environment first
  • User Impact Assessment: Consider how changes will affect daily workflows
  • Training Requirements: Plan user training for significant interface changes

2. Implementation Process

  • Staged Rollout: Implement changes in phases, starting with less critical departments
  • Communication: Inform affected users about upcoming changes
  • Support Preparation: Ensure help desk staff understand new configurations
  • Rollback Planning: Have a plan to revert changes if issues arise

3. Monitoring and Maintenance

  • Performance Monitoring: Watch for performance impacts after configuration changes
  • User Feedback: Regularly collect feedback on system usability
  • Error Monitoring: Check system logs for configuration-related errors
  • Regular Reviews: Periodically review configurations to ensure they still meet organizational needs

Common Configuration Scenarios

Scenario 1: Implementing Shift-Based Billing

Objective: Require cashier shifts for financial accountability

Steps:

  1. Access Application Options
  2. Enable applicationPreference.opdBillingAftershiftStart
  3. Enable applicationPreference.pharmacyBillingAfterShiftStart if applicable
  4. Train users on shift start/end procedures
  5. Update Financial Transaction Manager access

Impact:

  • Users must start shifts before billing
  • Financial Transaction Manager becomes available in menus
  • Enhanced financial tracking and accountability

Scenario 2: Customizing Laboratory Interface

Objective: Optimize laboratory workflow with dashboard interface

Steps:

  1. Access Application Options
  2. Enable The system uses the Laboratory Dashboard as its default interface
  3. Train laboratory staff on new interface layout
  4. Update laboratory procedures and documentation

Impact:

  • Laboratory Dashboard becomes primary interface
  • Sample Management may be hidden from main menu
  • Centralized laboratory operations management

Scenario 3: Enhancing Pharmacy Visual Aids

Objective: Improve stock management with visual indicators

Steps:

  1. Access Application Options
  2. Enable Display Colours for Stock Autocomplete Items
  3. Configure color coding rules for stock status
  4. Train pharmacy staff on color meanings

Impact:

  • Color-coded stock items based on expiry dates
  • Improved visual identification of stock status
  • Reduced dispensing errors

Troubleshooting Configuration Issues

Common Problems and Solutions

Configuration Changes Not Visible

Symptoms: Changes made but users don't see them
Solutions:

  • Clear browser cache and refresh
  • Restart application server if needed
  • Verify configuration was saved correctly
  • Check user permissions for affected features

Performance Issues After Configuration

Symptoms: System slowdown after enabling new features
Solutions:

  • Review enabled display options (disable unnecessary ones)
  • Check system resource usage
  • Consider optimized versions of features where available
  • Monitor database query performance

User Access Problems

Symptoms: Users cannot access features after configuration changes
Solutions:

  • Verify user has required privileges
  • Check if shift requirements are enabled and met
  • Review department-specific settings
  • Confirm user is in correct user role

Conflicting Settings

Symptoms: Unexpected system behavior or errors
Solutions:

  • Review related configuration settings for conflicts
  • Ensure only one option is enabled for mutually exclusive settings
  • Check institution vs department vs application option priorities
  • Verify configuration key spelling and values

Security Considerations

Access Control

  • Limit Configuration Access: Only authorized administrators should modify system configurations
  • User Role Management: Ensure proper role-based access to configuration features
  • Audit Logging: Monitor who makes configuration changes and when

Change Management

  • Approval Process: Implement approval workflows for significant configuration changes
  • Documentation: Maintain records of all configuration modifications
  • Testing Requirements: Mandatory testing before production implementation

Data Protection

  • Sensitive Settings: Pay special attention to configurations affecting data visibility
  • Privacy Compliance: Ensure configurations align with healthcare privacy requirements
  • Backup Procedures: Regular backups of configuration settings

Getting Configuration Help

Internal Resources

  1. System Administrator: First point of contact for configuration questions
  2. Department Heads: For department-specific configuration needs
  3. User Training Materials: Updated documentation reflecting current configurations
  4. Help Desk: For user-level configuration support

Technical Support

  1. Configuration Documentation: Refer to this guide and related documentation
  2. System Logs: Check logs for configuration-related error messages
  3. Test Environment: Use test systems to experiment with configurations
  4. Vendor Support: Contact HMIS support for complex configuration issues

Related Resources


Important Notes:

  • Always test configuration changes in a non-production environment first
  • Document all changes and their business justification
  • Train users before implementing significant configuration changes
  • Monitor system performance after making configuration modifications
โš ๏ธ **GitHub.com Fallback** โš ๏ธ