Inpatient Professional Payment Report - hmislk/hmis GitHub Wiki

Inpatient Professional Payment Report

An admission-grouped report showing every doctor/speciality professional fee charged on an inpatient admission, alongside how much of it has been paid — used to see at a glance which consultants are still owed money on which BHTs, filtered by date range or by a BHT-number range.

Page: Inward → Inpatient Analytics → Professional Payment Reports tab → Inpatient Professional Payment Report XHTML: /inward/reports/inward_professional_payment_report_dto.xhtml Controller: InwardReportControllerBht Favorite key: inpatientAnalytics_professionalPaymentReport (star it from the Inpatient Analytics tab to also pin it to the ⭐ Favorites tab)

Report Type

  • Summary — one row per admission, per doctor+speciality combination: total fee added, total paid, and balance still owing.
  • Detailed — the same grouping, but broken out one row per individual added-fee/paid-fee entry, with dates and payment bill numbers, plus a running total and balance per doctor.

Admissions with no professional fees at all still appear in the report (their fee columns show -), so a doctor's-fee gap on an admission isn't silently hidden — unless you tick List admissions without any professional fees, which flips the report to show only those admissions.

Search By

  • Date Range — filter admissions using Date Basis (see below) plus From Date / To Date. When you open the report, From Date defaults to the start of today (00:00:00) and To Date to the end of today (23:59:59), so the whole of today is covered. Dates you change are kept for the rest of your session.

Inpatient Professional Payment Report opened from the menu, with From Date at 00:00:00 and To Date at 23:59:59 today

On opening, the date range covers the whole of today: From Date 00:00:00, To Date 23:59:59.

  • BHT Range — filter by picking a From BHT and To BHT admission (autocomplete by BHT number); every admission with an internal ID between the two, inclusive, is included. Date Basis and Admission Type still narrow the results in this mode where applicable (Admission Type still applies; Date Basis fields are hidden and not used).

Date Basis

Controls which date on the admission the From Date/To Date range is matched against:

Date Basis What it filters on
Admission Date (default) PatientEncounter.dateOfAdmission — the original behavior before this filter existed
Discharge Date PatientEncounter.dateOfDischarge
Final Bill Created Date The admission's confirmed Final Bill's createdAt. Admissions with no final bill yet are excluded from the results under this basis — there's no bill-creation date to compare against.
Professional Fee Added Date BillFee.createdAt on the charge-side professional fee. Only admissions with at least one professional fee added inside the date range appear — an admission with fees but none added in that window won't show, even if the admission itself falls in range.

Use Discharge Date to match the same date used on the interim-bill discharge calendar. Use Final Bill Created Date to reconcile against when the final bill was actually issued rather than when the patient was admitted or discharged. Use Professional Fee Added Date to find fees entered during a specific period regardless of when the underlying admission happened.

Institution, Site and Department

(Issue #24441) Three dropdowns choose which admissions the report covers. They filter on the institution, site and department the admission was made under:

  • Institution opens set to the institution you are logged into. Choose All Institutions to include every institution, including older admissions that have no institution recorded.
  • Site opens as All Sites.
  • Department opens as All Departments. Its list shows only departments of the chosen institution and site.

The Date Basis, date range, BHT Range and Admission Type filters work inside this scope. The BHT Range autocomplete only offers admissions within it.

Before this change, the report showed only admissions made from the department you were logged into. An admission made while logged into another department (for example, a laboratory or pharmacy) never appeared, whatever the Date Basis, so a fee added to it looked missing:

Before: Professional Fee Added Date search for one day lists only one admission

Before: only the admission made from the Inward department appears. A fee added the same day to an admission made from the laboratory is missing.

After: the same search lists both admissions

After: with All Sites and All Departments, both admissions appear, including the older one admitted from the laboratory. Consultant names are blurred.

After: Department set to Main Laboratory lists only that admission

Choosing a Department limits the report to admissions made from that department. Here it is Main Laboratory.

Admission Type

A dropdown to restrict the report to one admission type — BHT, OPD Card, or any other admission type configured for the hospital (e.g. CT Card) — or leave it on All to include every type. Useful for hospitals like Galle Co-Operative that admit patients under both a physical BHT and an OPD-card-based short admission, where the two need to be reported on separately.

Columns (Summary)

Column Notes
BHT Number The admission's BHT/OPD-card number
Admitted / Discharged From the admission record
Final Bill Number The admission's first confirmed final bill, if any
Consultant / Speciality One row per doctor+speciality combination on the admission
Sum Added Fee Total professional fee charged to this doctor+speciality on this admission
Sum Paid Fee Total already paid against those charges
Balance to Pay Added minus Paid

The Detailed view adds per-entry Added Fee Date, Paid Date, Paid Bill Number, and per-line fee/paid values underneath each doctor+speciality block, with a Total and Balance to Pay row per doctor.

Configure Columns

(Issue #23515) Some hospitals don't need every column on this report. Each of the Summary and Detailed views has its own Configure Columns panel — a collapsible "Configure Columns" bar directly above its table — with one checkbox per column. Unchecking a column hides it from that table immediately; the choice is saved automatically per user (no separate "Save" step) and is remembered the next time you open the report.

Inpatient Professional Payment Report, Detailed view, with every column checked

Detailed view with every column visible — the default state.

Inpatient Professional Payment Report, Detailed view, with the Comments column unchecked

Same report with the "Comments" column unchecked via Configure Columns — the column disappears from the table and the remaining columns shift left.

Whichever columns you uncheck are omitted consistently from the on-screen table, Print, Excel, and PDF — all four surfaces always agree. The Summary and Detailed views remember their column choices separately, since they have different column sets.

Export

Both Summary and Detailed views can be exported to Excel or PDF, or sent to Print, using the buttons above each table — these respect whichever filters (report type, date basis, institution/site/department, admission type, etc.) were used for the on-screen results.

Related Articles

  • Inpatient — Professional Payments Report — a different, per-admission page for holding/releasing individual professional fee payments, not to be confused with this analytics report despite the similar name