Skip to navigation

Bulk Bill Processing Report

View as Markdown
How did Medicare assess each service on this bulk bill claim?

That is the question this endpoint answers, with the changes and exceptions for every medical event and service in the claim.

Retrieve a processing report for a Bulk Bill claim, detailing processing information (including changes and exception situations) for each medical event and associated service within the original claim.

📑 Response — status

ValueMeaning
COMPLETEReport is available; claimAssessment is populated.
REPORT_NOT_READYClaim located but assessment / payment is not finalised yet. Retry the next day.
REPORT_NOT_FOUNDNo matching claim for this location, provider, and identifiers.
REPORT_EXPIREDLodgement is outside the six-month retrieval window.

The report summarises how the claim was assessed: totals at claim level, and per medical event and service (assessment codes, benefit and charge amounts, Medicare patient details as held when assessed).

If the patient’s Medicare details differ from what was submitted, the corrected values come back here, flagged with a patient status code (8023–8028). Reconcile against those before resubmitting.

🕑 When to retrieve

A claim’s report becomes available the day after lodgement. A report requested on the day you submit returns REPORT_NOT_READY, so schedule a daily retrieval from the following day.

Reports can be retrieved for six months from the date the original claim was lodged, as many times as needed. Only the location that submitted the claim may request its report.

Malformed requests (for example an invalid correlationId) receive HTTP 400 — see the 400 response examples.

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

Transaction identifier from the successful Bulk Bill claim response; must match exactly what was returned when the claim was accepted. Format is urn:uuid: + Minor ID (8 characters) + 16 hexadecimal characters (33 characters total), for example urn:uuid:MDE00000ee97ff9fd17d4afc.

payeeProviderobjectRequired

Payee provider from the original claim transmission; use the same values as on that claim.

Response

OK
statusenum

Outcome of the report request.

ValueMeaning
COMPLETEReport returned with claim assessment data
REPORT_NOT_READYReport not ready yet — retry later
REPORT_NOT_FOUNDReport not found
REPORT_EXPIREDReport has expired
Allowed values:
correlationIdstring

Echo of the correlationId sent on the request.

claimAssessmentobjectOptional

Present when status is COMPLETE. Assessment snapshot for the claim; Medicare may include additional properties beyond those listed.

Errors

400
Bad Request Error