API ReferenceMedicare Eligibility

Eligibility Check Disclaimer (PDF)

Beta
View as Markdown
> 🚧 **Coming Soon** — This endpoint is not yet available in production. Returns **`application/pdf`**: a printable **Online Eligibility Check (OEC) Report** for the patient. The PDF follows the layout that Services Australia requires when handing an OECW result to the patient — header, patient details, per-service rebate estimate, and the mandated disclaimer and privacy notice wording. Quote only — not for claiming. ## No live check This endpoint **does not call Medicare**. It formats the values you supply into the approved OEC layout. Run the live eligibility check first via `POST /CalculateRebate`, then feed the resulting per-item figures (`ItemScheduleFee`, `Benefit`, an explanation code) and the overall `Reason` into this request. ## 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
API Key authentication via header

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).