Skip to navigation
RebateRight APIMedicare ClaimingIN Patient Claims

Status Report

Beta

Is the report for my in-patient claim ready to retrieve?

That is the question this endpoint answers, for up to 1,000 claims in one submission. It also finds the remittance advice that records what each claim was paid.

Test environment only. Services Australia is certifying this service, and it reaches production once certified.

The response to an in-patient claim acknowledges it. Medicare assesses the claim after lodgement, and so does the patient’s health fund for every claim type except Medicare Only. This endpoint tells you where each claim is up to, and when its report and its remittance advice are ready to retrieve. In-Patient Claim Report retrieves the claim’s report. Follow the claim to its outcome gives the steps from claim to remittance advice, and what Services Australia asks of your software.

A status request from a Minor ID other than the one that lodged the claim returns 2030, or REPORT_NOT_FOUND for a remittance advice lookup.

Report status

ValueMeaning
PROCESSINGMedicare or the health fund is still assessing the claim. processStatus says which. Check again later.
READYThe report is ready to retrieve. In a remittance advice lookup, the row’s transactionId is the remittance advice ID.
REPORTEDYou have retrieved the report before. You may retrieve it again.
REPORT_NOT_READYThe claim has no remittance advice yet. This value appears only in a remittance advice lookup. Check again later.
REPORT_NOT_FOUNDNo report exists for this transaction ID. Either no claim from this Minor ID has the ID, or the claim was lodged more than 6 months ago. In a remittance advice lookup, it can also mean the claim was rejected.

A malformed request, such as one that sends both transaction IDs and a date range, receives a 400. See the 400 response examples.

Authentication

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

Your Minor ID is 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Headers

x-minor-idstringRequired

The Minor ID of the clinic you act for. Send the Minor ID that lodged the claims. See Keys, Minor ID and environments.

Request

Send either transactionId or a date range in fromDateTime and toDateTime, never both.

transactionIdlist of stringsOptional

The transaction IDs of the claims to check, up to 1,000, each sent once. Send an array, even for one claim.

A transaction ID is the claim’s correlationId without urn:uuid:. It is 24 characters: the Minor ID that lodged the claim, then 16 letters or digits, as in MDE000005b864a2b5f7a4538. Rows come back in the order you send the IDs.

fromDateTimedatetimeOptional

The start of a range of lodgement times. The response covers the claims Medicare received from fromDateTime to toDateTime.

Send it with toDateTime, in place of transactionId. Give the local time with its Australian offset from UTC, as in 2026-10-21T00:00:00+11:00 for AEDT. It must not be in the future.

toDateTimedatetimeOptional

The end of the range, in the same format as fromDateTime. It must not be in the future, and must be no more than 31 days after fromDateTime.

Medicare returns at most 1,000 rows. A range that matches more returns none, so narrow the range or add a filter.

requestTransmissionTypeenumOptional

The kind of record to report on.

ValueReports onSend it with
mcp-in-patient-medical-claimIn-patient claimsA date range only. With transactionId, it returns 2030.
mcp-eclipse-remittance-adviceThe remittance advices for in-patient claimstransactionId or a date range

Leave it out to check claims by transactionId. With a date range, it limits the rows to one kind.

Allowed values:
associateNamestringOptional<=40 characters

Send it only with a date range. It limits the rows to one health fund, by the fund code the claims carried, as in TST. In a remittance advice range, it is the payer’s name.

Use letters, digits, spaces and ' - & . , /, with no space at the start or the end.

reportStatusenumOptional

Send it only with a date range. It limits the rows to one report status. A range with no row in that status returns REPORT_NOT_FOUND.

ValueRows returned
PROCESSINGClaims still being assessed
READYReports ready and not yet retrieved
REPORTEDReports retrieved at least once
Allowed values:

Response

OK
statusenum

Whether anything matched the request.

ValueMeaning
COMPLETEAt least one transaction ID or claim matched. transactionStatus holds one row for each.
REPORT_NOT_FOUNDNothing matched. transactionStatus is absent.
Allowed values:
correlationIdstring
The ID RebateRight generated for this status request. Quote it in a support enquiry. It is not a claim's transaction ID.
transactionStatuslist of objectsOptional
One row for each transaction ID you sent, in the same order, or one row for each claim in the date range.

Errors

400
Bad Request Error