Benefit Calculator
This endpoint needs no patient details. To check whether a particular patient can claim the item, use Eligibility Check, which quotes the same benefit.
What you get back
The response also carries ItemNumber, PatientsSeen and InHospitalTreatment, with any
default filled in, so you always see which values were used.
Every request field is optional
An empty body {} is a valid request.
How the benefit is worked out
Published fee. The benefit is the amount the MBS publishes for the item. Where an item
pays differently in and out of hospital, InHospitalTreatment decides which amount applies.
Derived fee. Some attendance items, such as a general practitioner seeing several
residents in one visit to an aged care facility, have a fee that depends on PatientsSeen.
The fee follows the item’s rule in the MBS, as published in the Ready Reckoner, and Medicare
pays 100% of it. Reason shows the arithmetic.
When there is no figure
When the benefit cannot be worked out, the response is still 200: Benefit and
TotalBenefit are null, and Reason and ReasonCode say why. Only a body that cannot be
parsed, or that names a field this endpoint does not recognise, returns 400.
Authentication
Your Minor ID is three uppercase letters followed by five digits, such as MDE00001. Send the Minor ID exactly as issued. A malformed value gets a 400 with "The Minor ID is not valid." on every endpoint.
Request
The MBS item number. Defaults to 23, a standard GP consultation (Level B), when omitted.
How many patients the practitioner sees on the same occasion at the same place. TotalBenefit is the benefit multiplied by this number, and on group attendance items the fee itself depends on it. Defaults to 1 when omitted. A value below 1 returns 200 with ReasonCode InvalidRequest.
Whether the service is provided to an in-hospital patient. Decides the benefit on items that pay differently in and out of hospital. Defaults to false when omitted.
Response
The MBS schedule fee for one patient, in dollars, as a string such as "53.35". It is null when the fee could not be determined.
What Medicare pays for one patient, in dollars, as a string such as "53.35". It is null when the benefit could not be worked out, and Reason says why.
Benefit multiplied by PatientsSeen. It is null whenever Benefit is.
A code for that reason, for analytics only.
New codes appear as coverage grows and are not a breaking change.