Skip to navigation

Eligibility Report (PDF)

View as Markdown
What do I give the patient after an eligibility check?

This endpoint produces it: the Online Eligibility Check report as a PDF, in the layout and wording Services Australia prescribes.

Generates the PDF you hand the patient after an eligibility check: the printable Online Eligibility Check (OEC) Report — header, patient details, per-service rebate estimate, and the mandated disclaimer and privacy notice wording. Quote only — not for claiming.

Handing the patient a printed report is optional. A written estimate is encouraged informed-financial-consent practice, not an obligation. When you do hand one over, Services Australia prescribes this layout and wording — which is what this endpoint produces.

How it works

The live check happens in Eligibility Check: run it first, then feed the per-item figures it returned (ItemScheduleFee, Benefit, an explanation code) and the overall Reason into this request. This endpoint makes no Medicare call of its own — it formats the result you already hold into the approved report.

Request body

The shape mirrors /CalculateRebate so the same payload can drive both calls with small additions. Identical field names are reused (PascalCase) for patient and service fields. Three per-item fields (ItemScheduleFee, Benefit, MedicareExplanationCode) are echoed from the /CalculateRebate response, and two root fields (AccountReferenceId, Reason) are specific to the disclaimer.

Only MedicareItems (with at least one item) and each item’s ItemNumber are required. Missing optional fields render as blank cells on the PDF.

Location on the report

The Location ID printed on the report is taken from the x-minor-id request header (the same header as other RebateRight endpoints), not from the JSON body.

Response

On success the response body is application/pdf. The download is offered as MedicareEligibilityCheckReport.pdf.

Errors

Validation failures return HTTP 400 with a plain-text message describing the problem (not a JSON error envelope).

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring

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

This endpoint expects an object.
DateOfServicedateOptional

Date of service printed against every row on the report. ISO date YYYY-MM-DD.

PatientFamilyNamestringOptional

Patient family name as it appears on the Medicare card. Printed in the patient-details section of the report.

PatientGivenNamestringOptional

Patient first given name as it appears on the Medicare card. Printed in the patient-details section of the report.

PatientMedicareNumberstringOptional

Patient's 10-digit Medicare card number.

PatientMedicareRefNumberstringOptional

Individual Reference Number (IRN) from the patient's Medicare card.

AccountReferenceIdstringOptional

Caller-supplied reference identifying this OECW quote (e.g. invoice or visit id).

ReasonstringOptional

Outcome text printed under Outcome / Fund Explanation Text. Typically the Reason returned by /CalculateRebate.

MedicareItemslist of objectsOptional

Response

PDF document — Online Eligibility Check (OEC) Report (MedicareEligibilityCheckReport.pdf).