Bulk Bill Processing Report

View as Markdown
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` | Value | Meaning | |---|---| | `COMPLETE` | Report is available; `claimAssessment` is populated. | | `REPORT_NOT_READY` | Claim located but assessment / payment is not finalised yet — retry later. | | `REPORT_NOT_FOUND` | No matching claim for this location, provider, and identifiers. | | `REPORT_EXPIRED` | Lodgement 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). 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
API Key authentication via header

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.

claimAssessmentobject

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

Errors

400
Bad Request Error