Admin Inpatient Module Behaviour Config Keys - hmislk/hmis GitHub Wiki

Admin โ€” Inpatient Module Behaviour (Config Keys)

The Inpatient module has many runtime behaviours that are toggled by configuration keys rather than by code changes. They are stored in the ConfigOption table and edited through Application Options.

This article lists the inpatient-relevant keys, what each one does, and the sensible default to keep.

How config keys are read

Beans call configOptionApplicationController.getBooleanValueByKey("<key>", defaultValue). The first time a key is requested, if it does not exist, the row is created with the default โ€” so simply opening a page with the right defaulting code is enough to seed the key into the DB.

Keys are typically edited from Admin โ†’ Application Options โ€” see Application Options and the System Configuration Guide.

Admission flow

Key Default Effect
BHT Number can be edited at the time of admission true Allows the clerk to override the auto-generated BHT. Set false to force system-generated BHT.
Patient admission and room assignment are simultaneous processes. (per institution) False = use a separate Admit Room page after admission. True = pick room on the Admit page.
Inward Admission - Show Claimable Field true Show the Claimable checkbox on the Admit page.
Inward Admission - Auto Apply Claimable For Credit false Auto-tick Claimable when payment method is a credit company.
Inward Admission - Auto Mark Claimable for Credit Admissions false Same intent โ€” auto-tick at save time.
Inward Admission - Find And Fill Last Used Credit Companies of a Patient false Pre-fill the patient's previously used credit company.
Inward Patient Admit - Credit Companies Require Reference Number false Reference No becomes required for credit-company admissions.
Patient Admit - Enable Referred From in Patient Admission false Show the "Referred From" dropdown on the Admit page.
Patient Admit - Referred From Methods custom list The dropdown options for "Referred From".

Mandatory-field gates

These promote optional fields to required at save time.

Key Default Forces required on
Inward Admission - Mandatory Fields Enabled false Master toggle for the per-field requireds below.
Inward Admission - Comments Required false Comments.
Inward Admission - Medical Officer Required false MO autocomplete.
Inward Admission - Primary Reason Required false Primary reason.
Inward Admission - Referral Institution Required false Referral institution.
Inward Admission - Referral Number Required false Referral number.
Inward Admission - Referring Doctor Required false Referring doctor.
Inward Admission - Referring Staff Required false Referring staff.
Inward Admission - Workplace Required false Workplace.
Patient Admit - Require Referred From in Patient Admission false Referred From dropdown.

Guardian sub-fields (each takes effect only if Guardian Details Required in Patient Admission is true):

Key Default Forces required on
Guardian Details Required in Patient Admission false Master toggle for guardian fields.
Guardian Title is Required in Patient Admission false Title.
Guardian Name is Required in Patient Admission false Name.
Guardian NIC is Required in Patient Admission false NIC / Passport.
Guardian Address is Required in Patient Admission false Address.
Guardian Mobile Number is Required in Patient Admission false Mobile.
Guardian Home Phone Number is Required in Patient Admission false Home phone.
Guardian Relationship is Required in Patient Admission false Relationship.

Patient sub-fields:

Key Default Forces required on
Patient Details Required in Patient Admission false Master toggle.
Patient Address is Required in Patient Admission false Address.
Patient Age is Required in Patient Admission false Age / DOB.
Patient Area is Required in Patient Admission false Area / locality.
Patient Gender is Required in Patient Admission false Sex.
Patient Mail is Required in Patient Admission false Email.
Patient NIC is Required in Patient Admission false NIC.

Final bill behaviour

Key Default Effect
Show an Intermediate Bill on Final Bill Edit false Replace Process with Process Bill that also generates an intermediate printable bill.
Show Print Button For Intermediate Bill on Final Bill Edit false Add a Check Final Bill button to print the intermediate.
Show Save Provisional on Final Bill Edit false Add a Save Provisional Bill button.
Need to check inward bills before discharge false If true, the system enforces the pending-bill pre-discharge check (#19307 / #19308).
Allow Final Bill Total Without Restrictions & Price Difference false Bypass the price-difference check at settle (needs care).
Disable Time Limit on Final Bill Cancellation false Permit cancelling a final bill regardless of how long ago it was settled.
Disable Time Limit on Provisional Bill Cancellation false Same, for provisional bills.
Inward Billing - Mandatory permission to cancel false Require a privilege check before cancellation.
Mandatory permission to cancel bills. false Generic mandatory-permission gate for cancellations.

Bill fee scope

Key Default Effect
Inward Bill Fees are the same for all departments, institutions and sites. true Single global fee per item โ€” simpler.
Inward Bill Fees are based on the site false Site-specific fee variations allowed.

Other inpatient-adjacent keys

Key Default Effect
Enable Collecting Payments on Add Services & Investigations on Inward false Adds the Add Services & Investigations with Payments menu / page.
Enable Drawer Manegment (typo intentional, kept) Drawer / cashier-drawer management overlay.
Enable blacklist patient management for inward from the system false Wire blacklist checks into inward admission.
Enable the Special Privilege of Canceling Inward Service Bills false Adds an extra privilege gate for service-bill cancel.
Inward Deposit Payment Bill Payment Type Required false Force the Payment Type field on deposit bills.
OPD Bill Number Generation Strategy - Single Number for OPD and Inpatient Investigations and Services false Share a single bill-number sequence across OPD + Inward investigations/services.
List Inward Items by Department false Item dropdowns scoped by department.
Get Payment Type Instead of Comment false Reuse the Payment Type field where some pages historically used the comment field.

Where keys are managed

See also

โš ๏ธ **GitHub.com Fallback** โš ๏ธ