chore(ui-docs): add help/license links, favicon, and branding asset tracking

2026-04-02 12:23:22 +05:30 · 2026-04-02 12:23:22 +05:30 · bae07392d2
commit bae07392d2
parent d8f75b3a29
12 changed files with 515 additions and 4 deletions
--- a/.gitignore
+++ b/.gitignore
@ -129,3 +129,8 @@ _modules/*

 public/uploads/*
 !public/uploads/.gitkeep
+
+# Always allow branding assets to be committed when present
+!public/assets/
+!public/assets/img/
+!public/assets/img/**
--- a/OPEN_SOURCE_NOTICE.md
+++ b/OPEN_SOURCE_NOTICE.md
@ -0,0 +1,21 @@
+# Open Source Notice
+
+This application uses open-source software components.
+
+## Primary Framework
+- CodeIgniter 4
+- License: MIT
+- License Text: See LICENSE file in this repository
+
+## PHP Dependencies
+Installed dependency metadata and versions are maintained in:
+- composer.json
+- composer.lock
+
+Dependency source trees are available in vendor/ and remain subject to their original licenses.
+
+## Notice Rule
+Where required by an upstream license, copyright notices and license text must be preserved in all relevant distributions.
+
+## Conflict Rule
+If terms in SOFTWARE_USE_LICENSE.md differ from an upstream open-source license for a specific component, the upstream open-source license governs that component.
--- a/README.md
+++ b/README.md
@ -1,5 +1,11 @@
 # CodeIgniter 4 Application Starter

+## Project Documents
+
+- Complete software help guide: docs/HOSPITAL_STOCK_HELP.md
+- Software use license: SOFTWARE_USE_LICENSE.md
+- Open-source notice: OPEN_SOURCE_NOTICE.md
+
 ## What is CodeIgniter?

 CodeIgniter is a PHP full-stack web framework that is light, fast, flexible and secure.
--- a/SOFTWARE_USE_LICENSE.md
+++ b/SOFTWARE_USE_LICENSE.md
@ -0,0 +1,55 @@
+# Software Use License (Application Distribution)
+
+Version: 1.0  
+Effective Date: 2026-04-02
+
+## 1. Scope
+This Software Use License applies to the hospital management application customizations, modules, and business logic delivered in this repository, excluding third-party components that are licensed separately.
+
+## 2. License Grant
+Subject to compliance with this document, the copyright holder grants the licensed user a limited, non-exclusive, non-transferable right to:
+- Install and run the software for internal business operations.
+- Configure and use the software within the licensed organization.
+- Create internal backups for recovery and continuity.
+
+## 3. Restrictions
+Without prior written permission, the licensed user may not:
+- Resell, sublicense, or redistribute the custom application as a commercial product.
+- Remove copyright, attribution, or license notices.
+- Misrepresent authorship of custom code.
+- Use the software for unlawful activities.
+
+## 4. Third-Party Open-Source Components
+This application includes or depends on open-source software (for example, framework and package dependencies). Those components remain under their own original licenses.
+
+Important rules:
+- Open-source license terms are not replaced by this document.
+- Where open-source licenses require attribution or inclusion of notices, users must preserve them.
+- If any conflict exists, the third-party component license controls for that component.
+
+Refer to:
+- LICENSE (framework/base license text in repository)
+- composer.json and composer.lock (package dependency records)
+- OPEN_SOURCE_NOTICE.md (summary notice file)
+
+## 5. Ownership
+- Ownership of third-party components remains with their respective authors.
+- Ownership of custom HMS business modules and modifications remains with the custom code owner unless transferred by separate written agreement.
+
+## 6. Warranty Disclaimer
+The software is provided on an as-is and as-available basis, without express or implied warranties, including merchantability, fitness for a particular purpose, and non-infringement, except where prohibited by applicable law.
+
+## 7. Limitation of Liability
+To the maximum extent permitted by law, the copyright holder shall not be liable for indirect, incidental, special, consequential, or punitive damages, including data loss, business interruption, or procurement of substitute services.
+
+## 8. Compliance Responsibilities
+The deploying organization is responsible for:
+- Proper configuration and access control.
+- Backup and disaster recovery.
+- Compliance with local healthcare, data protection, and record retention regulations.
+
+## 9. Termination
+This license terminates automatically if material terms are breached. On termination, usage must stop, except where continuing rights are required under third-party open-source licenses.
+
+## 10. Contact and Custom Terms
+For commercial redistribution rights, OEM terms, or transfer of ownership rights, a separate signed agreement is required.
--- a/app/Views/auth/login.php
+++ b/app/Views/auth/login.php
@ -10,7 +10,8 @@
    <meta content="" name="description">
    <meta content="" name="keywords">

-    <link href="assets/img/favicon.png" rel="icon">
+    <link href="assets/img/logo.ico" rel="icon" type="image/x-icon">
+    <link href="assets/img/favicon.png" rel="alternate icon" type="image/png">
    <link href="assets/img/apple-touch-icon.png" rel="apple-touch-icon">

    <link href="https://fonts.gstatic.com" rel="preconnect">
@ -133,7 +134,9 @@
    </main>

    <footer class="py-3 text-center text-muted small">
-        &copy; 2017 - 2026 <strong>E-Atria</strong>. All Rights Reserved | Version: <?= esc($footerVersion) ?>
+        &copy; 2017 - 2026 <strong><a href="https://www.e-atria.in" target="_blank" rel="noopener">E-Atria</a></strong>. All Rights Reserved |
+        <a href="<?= base_url('software-use-license.html') ?>" target="_blank" rel="noopener">Software Use License</a> |
+        Version: <?= esc($footerVersion) ?>
    </footer>

    <a href="#" class="back-to-top d-flex align-items-center justify-content-center"><i class="bi bi-arrow-up-short"></i></a>
--- a/app/Views/partials/header.php
+++ b/app/Views/partials/header.php
@ -50,6 +50,12 @@
                $serverDisplayTime = $serverNow->format('d-m-Y h:i A') . ' (' . $serverTimeZoneLabel . ')';
            ?>
            <ul class="d-flex align-items-center">
+                <li class="nav-item pe-3 d-flex align-items-center text-nowrap">
+                    <a class="text-decoration-none" href="<?= base_url('help.html') ?>" target="_blank" rel="noopener">
+                        <i class="bi bi-question-circle me-1"></i>
+                        <span>Help</span>
+                    </a>
+                </li>
                <li class="nav-item pe-3 d-none d-md-flex align-items-center text-nowrap" title="Server time">
                    <i class="bi bi-clock me-1"></i>
                    <span id="header-server-datetime"
--- a/app/Views/welcome_message.php
+++ b/app/Views/welcome_message.php
@ -10,7 +10,8 @@
    <meta content="" name="description">
    <meta content="" name="keywords">

-    <link href="<?= base_url('assets/img/favicon.png') ?>" rel="icon">
+    <link href="<?= base_url('assets/img/logo.ico') ?>" rel="icon" type="image/x-icon">
+    <link href="<?= base_url('assets/img/favicon.png') ?>" rel="alternate icon" type="image/png">
    <link href="<?= base_url('assets/img/apple-touch-icon.png') ?>" rel="apple-touch-icon">

    <link href="https://fonts.gstatic.com" rel="preconnect">
@ -58,7 +59,9 @@

    <footer id="footer" class="footer">
        <div class="copyright">
-            &copy; 2017 - 2026 <strong><span>E-Atria</span></strong>. All Rights Reserved | Version: <?= esc($footerVersion) ?>
+            &copy; 2017 - 2026 <strong><span><a href="https://www.e-atria.in" target="_blank" rel="noopener">E-Atria</a></span></strong>. All Rights Reserved |
+            <a href="<?= base_url('software-use-license.html') ?>" target="_blank" rel="noopener">Software Use License</a> |
+            Version: <?= esc($footerVersion) ?>
        </div>
    </footer>
    <div id="wait"
--- a/docs/HOSPITAL_STOCK_HELP.md
+++ b/docs/HOSPITAL_STOCK_HELP.md
@ -0,0 +1,227 @@
+# HMS Software Complete Help Guide
+
+Version: 1.0  
+Last Updated: 2026-04-02
+
+## 1. Introduction
+This document is the complete usage help for HMS CI4 software. It covers:
+- Login and navigation
+- OPD, IPD, Billing, Diagnosis, Pharmacy, Finance and Reports
+- Hospital Stock Management
+- Admin setup and permissions
+- Security, compliance, backup and troubleshooting
+
+## 2. Login and Navigation
+1. Open the HMS login page.
+2. Enter your authorized credentials.
+3. After login, use:
+- Top bar: profile, help, server time
+- Left sidebar: module navigation
+- Main panel: module workspace
+
+## 3. User Roles and Permissions
+HMS works with permission-based access.
+Common groups:
+- Superadmin/Admin/Developer: full access
+- Billing users
+- Diagnosis users
+- Finance users
+- Stock Manager
+- Department Head
+- Storekeeper
+
+If you get "Access denied", ask admin to map proper permissions in user management.
+
+## 4. Core Daily Workflow
+1. Register or search patient.
+2. Create OPD/IPD service entries.
+3. Add charges and generate invoice.
+4. Collect payment / post credit.
+5. Process diagnostics and publish reports.
+6. Manage medicines/stock issue/receipts.
+7. Run end-of-day reconciliation reports.
+
+## 5. Billing Module Usage
+Sections:
+- Patient List
+- OPD Invoice
+- Charges Invoice
+- IPD Billing
+- Payment Request
+- Refund Request
+
+Best practice:
+- Verify patient identity before posting charges.
+- Use correction/cancel flow with remark where applicable.
+- Print and archive critical payment documents.
+
+## 6. IPD and Nursing Usage
+- Use IPD panel for admission lifecycle.
+- Capture nursing entries and bedside/visit charges.
+- Verify discharge process before invoice finalization.
+- Use print modes for final discharge and billing outputs.
+
+## 7. Diagnosis Module Usage
+Supports pathology and imaging report workflows.
+Typical flow:
+1. Select lab invoice/test.
+2. Enter or import findings.
+3. Save draft.
+4. Verify/finalize report.
+5. Print final report.
+
+Governance:
+- Use verification flow for report authenticity.
+- Keep edit reasons where audit policy requires.
+
+## 8. Pharmacy/Medical Usage
+- Search customer/patient and open invoice.
+- Add items, apply discount per policy.
+- Confirm payment and print invoice.
+- Use return and stock tools for inventory control.
+
+## 9. Finance Module Usage
+Major sections:
+- Vendor master
+- Purchase order
+- GRN entry
+- Vendor invoice booking
+- Cash and disbursement SOP
+- Doctor payout workflow
+- Bank deposit register
+- Compliance report
+
+Control points:
+- Maker-checker where required.
+- Keep documentary references in remarks.
+- Run periodic compliance report.
+
+## 10. Hospital Stock Management Usage
+Path: Setting -> Hospital Stock
+
+Menu sections:
+- Dashboard
+- Item Masters
+- Indent & Issue
+- Purchase
+- Reports
+
+### 10.1 Item Masters
+Configure:
+- Category, Supplier, Item
+- Item code and item type
+- UOM / Purchase UOM / Issue UOM
+- Issue per Purchase ratio
+- Min stock / reorder / current stock
+- Unit cost / expiry / daily use / location
+
+Example:
+- Purchase UOM: Box
+- Issue UOM: Piece
+- Issue per Purchase: 100
+=> 1 Box = 100 Pieces
+
+### 10.2 Indent and Issue
+1. Department creates indent.
+2. Authorized user approves indent.
+3. Storekeeper issues against approved quantity.
+4. System marks as issued or partial_issued based on stock.
+
+### 10.3 Purchase and Receive
+1. Create PO with supplier.
+2. Add PO item lines and rates.
+3. Receive PO.
+4. Stock and ledger update automatically.
+
+### 10.4 Dashboard and Reports
+Dashboard focus:
+- New requests
+- Near-expiry used items
+- Short items without replenishment
+- Daily-use item status
+
+Reports:
+- Department consumption
+- Monthly issue
+- Near expiry
+- Low/reorder alerts
+
+## 11. Settings and Master Configuration
+From Settings module, admins can manage:
+- Users and permissions
+- Doctors and reference masters
+- Bank and payment source masters
+- Bed management
+- Report/template settings
+- Stock module access and masters
+
+## 12. Report Usage
+Use Report panel for:
+- Billing collection reports
+- Diagnosis reports
+- Insurance/credit reports
+- Audit/compliance reports
+
+Guideline:
+- Use date filters carefully.
+- Export and archive monthly reports.
+
+## 13. Security and Compliance Guidelines
+- Do not share login credentials.
+- Use individual user IDs only.
+- Keep audit trail remarks meaningful.
+- Follow local data protection and healthcare retention requirements.
+- Restrict production DB direct edits.
+
+## 14. Backup and Recovery SOP
+Daily:
+- Database backup
+- Verify writable directory health
+
+Weekly:
+- Test backup restore on staging
+- Check storage and log growth
+
+Before deployment:
+- Apply migrations in order
+- Run smoke test for critical modules
+
+## 15. Common Troubleshooting
+1. Access denied:
+- Verify role permissions.
+
+2. Screen not loading:
+- Check route URL, session validity, browser console/network.
+
+3. Wrong totals/stock values:
+- Verify workflow actions and unit conversion fields.
+
+4. Report print mismatch:
+- Verify template/print settings.
+
+5. Upload or file errors:
+- Check folder permissions and PHP upload limits.
+
+## 16. Technical References
+Main stock files:
+- app/Controllers/Setting/HospitalStock.php
+- app/Views/Setting/Stock/index.php
+- app/Views/Setting/Stock/dashboard.php
+- app/Views/Setting/Stock/masters.php
+- app/Views/Setting/Stock/indents.php
+- app/Views/Setting/Stock/purchase.php
+- app/Views/Setting/Stock/reports.php
+
+License references:
+- SOFTWARE_USE_LICENSE.md
+- OPEN_SOURCE_NOTICE.md
+- LICENSE
+
+## 17. Support Escalation Template
+When raising support ticket, include:
+- User ID and role
+- Module name and URL
+- Steps performed
+- Expected vs actual behavior
+- Screenshot/error text
+- Time of incident
--- a/public/assets/img/logo.ico
+++ b/public/assets/img/logo.ico
--- a/public/assets/img/logo.png
+++ b/public/assets/img/logo.png
--- a/public/help.html
+++ b/public/help.html
@ -0,0 +1,121 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>HMS Software Help Guide</title>
+    <link href="assets/vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
+    <style>
+        body { background: #f5f7fb; color: #1f2937; }
+        .wrap { max-width: 980px; margin: 24px auto; }
+        .card { border: 1px solid #dbe3ee; }
+        h1, h2 { color: #0f3d7a; }
+        .toc a { text-decoration: none; }
+        .toc a:hover { text-decoration: underline; }
+    </style>
+</head>
+<body>
+<div class="container wrap">
+    <div class="card shadow-sm">
+        <div class="card-body p-4 p-md-5">
+            <h1 class="mb-3">HMS Software Help Guide</h1>
+            <p class="text-muted">Version 1.0 | Last updated: 2026-04-02</p>
+
+            <h2 class="h4 mt-4">Contents</h2>
+            <ul class="toc">
+                <li><a href="#getting-started">Getting Started</a></li>
+                <li><a href="#roles">User Roles and Access</a></li>
+                <li><a href="#daily-flow">Daily Operation Flow</a></li>
+                <li><a href="#billing">Billing and Cash Flow</a></li>
+                <li><a href="#diagnosis">Diagnosis and Reports</a></li>
+                <li><a href="#stock">Hospital Stock Module</a></li>
+                <li><a href="#admin">Admin and Configuration</a></li>
+                <li><a href="#security">Security and Compliance</a></li>
+                <li><a href="#backup">Backup and Maintenance</a></li>
+                <li><a href="#troubleshooting">Troubleshooting</a></li>
+            </ul>
+
+            <h2 id="getting-started" class="h4 mt-4">1. Getting Started</h2>
+            <ol>
+                <li>Login with your assigned user ID.</li>
+                <li>Use the left sidebar to open modules.</li>
+                <li>Use Dashboard for daily status.</li>
+                <li>Use My Profile to verify your name and login details.</li>
+            </ol>
+
+            <h2 id="roles" class="h4 mt-4">2. User Roles and Access</h2>
+            <p>Access is permission-based. Typical groups include Admin, Billing users, Diagnosis users, and Stock roles (Stock Manager, Department Head, Storekeeper). If you see "Access denied", contact administrator to assign correct permission.</p>
+
+            <h2 id="daily-flow" class="h4 mt-4">3. Daily Operation Flow</h2>
+            <ol>
+                <li>Patient registration and OPD/IPD workflow.</li>
+                <li>Charge posting and invoice generation.</li>
+                <li>Payment collection and receipt.</li>
+                <li>Lab/radiology processing and report verification.</li>
+                <li>Inventory issue/receipt for consumables and medicines.</li>
+            </ol>
+
+            <h2 id="billing" class="h4 mt-4">4. Billing and Cash Flow</h2>
+            <ul>
+                <li>Use Billing -> Patient List for patient-level work.</li>
+                <li>Use OPD Invoice and Charges Invoice to post/collect payments.</li>
+                <li>Use IPD Billing for admitted patients, package and discharge flow.</li>
+                <li>Use Payment Request and Refund Request for controlled approvals.</li>
+                <li>Use report screens for daily reconciliation.</li>
+            </ul>
+
+            <h2 id="diagnosis" class="h4 mt-4">5. Diagnosis and Reports</h2>
+            <ul>
+                <li>Diagnosis module supports pathology and imaging workflows.</li>
+                <li>Draft findings before final verification.</li>
+                <li>Use print templates for standardized report output.</li>
+                <li>Use audit trails and verification states for NABH-style controls.</li>
+            </ul>
+
+            <h2 id="stock" class="h4 mt-4">6. Hospital Stock Module</h2>
+            <ol>
+                <li>Item Masters: category, item, supplier setup.</li>
+                <li>Indent & Issue: departments raise request, approver approves, storekeeper issues.</li>
+                <li>Purchase: create PO and receive stock.</li>
+                <li>Dashboard: expiry risk, short stock, new requests, daily-use status.</li>
+                <li>Reports: consumption, monthly issue, near-expiry, low/reorder alerts.</li>
+            </ol>
+            <p>Key item fields: purchase unit, issue unit, issue-per-purchase ratio, min/reorder levels, expiry date, and store location.</p>
+
+            <h2 id="admin" class="h4 mt-4">7. Admin and Configuration</h2>
+            <ul>
+                <li>User management, password reset, and permission mapping.</li>
+                <li>Doctor/refer/master settings.</li>
+                <li>Template management for reports and print formats.</li>
+                <li>Bed management and hospital stock settings.</li>
+            </ul>
+
+            <h2 id="security" class="h4 mt-4">8. Security and Compliance</h2>
+            <ul>
+                <li>Use personal login only; do not share credentials.</li>
+                <li>Keep audit remarks clear for financial and clinical edits.</li>
+                <li>Follow organization policy for health data privacy.</li>
+            </ul>
+
+            <h2 id="backup" class="h4 mt-4">9. Backup and Maintenance</h2>
+            <ul>
+                <li>Take scheduled database backups.</li>
+                <li>Archive monthly reports.</li>
+                <li>Apply migrations in controlled deployment steps.</li>
+                <li>Validate writable folder permissions after server changes.</li>
+            </ul>
+
+            <h2 id="troubleshooting" class="h4 mt-4">10. Troubleshooting</h2>
+            <ul>
+                <li>Access denied: verify group permissions.</li>
+                <li>Form not loading: check session status and route URL.</li>
+                <li>Wrong stock: verify conversion fields and ledger actions.</li>
+                <li>Print mismatch: verify template and print setting configuration.</li>
+            </ul>
+
+            <div class="mt-4 text-muted small">For legal terms, see <a href="software-use-license.html">Software Use License</a>.</div>
+        </div>
+    </div>
+</div>
+</body>
+</html>
--- a/public/software-use-license.html
+++ b/public/software-use-license.html
@ -0,0 +1,64 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Software Use License</title>
+    <link href="assets/vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
+    <style>
+        body { background: #f6f8fc; color: #1f2937; }
+        .wrap { max-width: 980px; margin: 24px auto; }
+        h1, h2 { color: #0f3d7a; }
+    </style>
+</head>
+<body>
+<div class="container wrap">
+    <div class="card shadow-sm">
+        <div class="card-body p-4 p-md-5">
+            <h1>Software Use License</h1>
+            <p class="text-muted">Version 1.0 | Effective Date: 2026-04-02</p>
+
+            <h2 class="h5 mt-4">1. Scope</h2>
+            <p>This license applies to custom hospital management software modules and business logic in this distribution, excluding third-party software with separate licenses.</p>
+
+            <h2 class="h5 mt-4">2. License Grant</h2>
+            <p>You are granted a limited, non-exclusive, non-transferable right to install and use this software for internal operations of the licensed organization.</p>
+
+            <h2 class="h5 mt-4">3. Restrictions</h2>
+            <ul>
+                <li>No unauthorized resale, sublicensing, or redistribution as a commercial product.</li>
+                <li>No removal of copyright, attribution, or license notices.</li>
+                <li>No unlawful use.</li>
+            </ul>
+
+            <h2 class="h5 mt-4">4. Open-Source Components</h2>
+            <p>This software includes open-source components. Their original licenses remain fully applicable. If any term conflicts, upstream open-source license terms govern those components.</p>
+
+            <h2 class="h5 mt-4">5. Ownership</h2>
+            <p>Third-party component ownership remains with their original authors. Ownership of custom modules remains with the custom code owner unless separately transferred by written agreement.</p>
+
+            <h2 class="h5 mt-4">6. Warranty Disclaimer</h2>
+            <p>Software is provided on an "as is" basis, without implied warranties, to the maximum extent permitted by law.</p>
+
+            <h2 class="h5 mt-4">7. Limitation of Liability</h2>
+            <p>To the maximum extent permitted by law, the copyright holder is not liable for indirect or consequential damages.</p>
+
+            <h2 class="h5 mt-4">8. Compliance Responsibility</h2>
+            <p>The deploying organization is responsible for access control, backup, local regulatory compliance, and data protection obligations.</p>
+
+            <h2 class="h5 mt-4">9. Termination</h2>
+            <p>This license terminates on material breach. On termination, software use must stop, except rights required by third-party open-source licenses.</p>
+
+            <h2 class="h5 mt-4">10. References</h2>
+            <ul>
+                <li>Repository LICENSE file</li>
+                <li>OPEN_SOURCE_NOTICE.md</li>
+                <li>composer.json and composer.lock</li>
+            </ul>
+
+            <div class="mt-4 text-muted small">For usage instructions, see <a href="help.html">Software Help Guide</a>.</div>
+        </div>
+    </div>
+</div>
+</body>
+</html>