-
Notifications
You must be signed in to change notification settings - Fork 137
Inpatient Professional Payments Report
Sometimes a billing officer needs to stop payout of one specific professional fee on an admission — for example, one consultant's charge is disputed — without holding every other doctor's fee on the same BHT. The Professional Payments Report lists every ward and surgery professional fee for one admission and lets you hold or release each fee individually, as a finer-grained complement to Hold Professional Payments, which holds the whole BHT at once.
Page: Admission Profile → Billing → Professional Payments Report
XHTML: /inward/inward_professional_fee_hold.xhtml
Controller: ProfessionalFeeHoldController
Privilege (view/hold/release): InwardHoldProfessionalPayments — the same privilege used for the whole-BHT hold; there is no separate privilege for the per-item version
Fields on BillFee: feePaymentOnHold (Boolean), feePaymentHoldDateTime (Date), feePaymentHoldBy (WebUser), feePaymentHoldNotes (String)
| Hold Professional Payments | Professional Payments Report | |
|---|---|---|
| Scope | Whole BHT — every professional fee on the admission | One fee line at a time (multi-select for bulk hold/release) |
| Where held fees show on the due-fees search | Still listed, tagged "On Hold", blocked at settle | Excluded from the search results entirely — the fee just doesn't appear until released |
| Field holding the flag | PatientEncounter.professionalPaymentsOnHold |
BillFee.feePaymentOnHold |
| Typical use | "Don't pay anyone on this admission until the dispute is resolved" | "Don't pay this one consultant's fee, but the others are fine" |
Both mechanisms can be active at the same time on the same admission — a BHT-level hold and an item-level hold are independent flags, and either one alone is enough to block a payment attempt (see below).
The Professional Payments Report button appears wherever staff manage professional fees for an admission:
- Admission Profile → Billing panel (next to Hold Professional Payments)
- Nursing Workbench → the same admission's action row
- Surgery Professional Fees list (theatre module) → opens the report scoped to that surgery's admission
All three require the InwardHoldProfessionalPayments privilege to see the button.
The report lists every ward (Inward Service Bill) and surgery (Inward Professional) fee line for the admission, one row per BillFee:
| Column | Notes |
|---|---|
| Consultant | The staff member the fee is payable to |
| Speciality | The consultant's speciality, if recorded |
| Source | Which bill type generated the fee — ward service bill or surgery/professional bill |
| Bill No | The originating bill's department bill number |
| Fee Date | When the fee was charged (blank for older records created before this field existed) |
| Fee / Paid | The fee amount and how much has already been paid against it |
| Hold Status |
Payable (green) or On Hold since <date/time> by <user> (red, with the hold notes shown as a tooltip) |
Click any column header to sort — for example, sort by Consultant to review all of one doctor's fees together.
- Open the Professional Payments Report for the admission.
- Optionally enter a reason in Hold Notes — this note is applied to every fee you hold in the next step, not retroactively to fees already on hold.
- Tick the checkbox next to each fee to hold (the header checkbox selects the whole page).
- Click Hold Selected and confirm the dialog.
On success, for each selected fee that was not already on hold:
feePaymentOnHold = true-
feePaymentHoldDateTime= current timestamp -
feePaymentHoldBy= logged-in user -
feePaymentHoldNotes= the text entered in step 2 - An audit event ("Professional Fee Payment Hold") is recorded against the admission, visible on Event History.
Fees that were already on hold are left unchanged and do not count toward the success message.
- Tick the checkbox next to each held fee to release.
- Click Release Hold on Selected and confirm the dialog.
On success, feePaymentOnHold, feePaymentHoldDateTime, feePaymentHoldBy, and feePaymentHoldNotes are all cleared for each selected fee, and a "Professional Fee Payment Hold Released" audit event is recorded. The Hold Notes textbox is not used for release — any text left in it only affects future holds.
Unlike the whole-BHT hold, an individually held fee does not appear at all in the Inward Professional Payment or Inward Surgery Payment due-fees search — it is filtered out of the query rather than shown with a warning tag. If a professional's total looks lower than expected on the payment screen, check the Professional Payments Report for that admission before assuming the fee was never billed.
If a fee is somehow selected and paid anyway (for example, via the InwardPayProfessionalFeesWhileOnHold override privilege that also applies to the whole-BHT hold), the settlement is rejected with:
Cannot pay: this professional payment is individually on hold (BHT
<BHT No>).
- Inpatient — Hold Professional Payments — the whole-BHT equivalent of this flag
- Inpatient Admission Profile (Dashboard) — where the Professional Payments Report button lives
- Inward Professional and Surgery Payments — the two settlement screens this hold affects