Cases, Budgets and Sub Budgets

Similar to Nookal, The BOS stores the following data and it relates as follows:

Term	Example	Relation	Description
Client (aka Patient)	"Kim K"		A person
Case	"Back Pain 2025"	Each case belongs to one client. A client can have multiple cases.	A condition being treated. A client can have multiple cases for different conditions.
Payer	"5 session Medicare" or "$1500 NDIS"	Each payer belongs to one case. A case can have multiple payers (with same or different contacts) Each payer has one contact (EG: 'DVA', 'NDIA').	Tracks budgets, approved sessions, expiry dates and more.
Contact	"DVA", "NDIS", or <PatientName> if self managed	Multiple payers for different patients can have the same contact.	A contact is who pays the invoices.
SubBudget Category	"EP", "Dietician"		Created in Nookal settings. Allows Payer budgets to be split (EG: by profession)
SubBudget	"$500 EP for Kim"	A payer with a budget can be split into separate subbudgets. Often all the budget is allocated to a single subbudget.

We have the following reports available which report on different areas:

Report	Description	Useful for
Client Info Page	Accessible by hovering over a client name anywhere in The BOS.  Shows all appointments, invoices, cases etc for the client.
Funded Sessions Report	Reports on Payers (EG: if a client has two payers then both will appear as separate items, if they have no payers they won't appear).	Finding payers with sessions/budget remaining or that are expiring soon.
SubBudget Report	Reports on all subbudgets.  For simplicity: if a subbudget has zero allocated and zero spent it will not appear.	Finding subbudgets that have been underspent (budget remaining) or overspent.

Nookal SubBudget Remaining Calculation

Nookal does not expose the SubBudget remaining metric in the API. We can see the total budget. Therefore we need to calculate the budget remaining using the total budget and all client invoices. 

We've determined that Nookal appears to calculate the subbudget remaining by subtracting all invoices for the same Case and Contact. For example: if you make a Case with two Payers and they are both NDIS with $500 budgets each then any invoice for either payer will count towards the 'spend' on both budgets. 

To remain consistent with Nookal we are applying the same formula, rather than doing the more precise "subtrack from the subbudget of the appropriate payer only".