Bulk Bill Processing Report

View as Markdown
Bulk Bill Processing Report Web Service (BPRW) is used to retrieve a processing report for a Bulk Bill claim/s, which details processing information (including changes and exception situations) for each medical event and associated service/s within the original BBSW claim. This report is available for six months after its initial generation (date of lodgement for claim) and can be retrieved in real time as many times as required. The report can only be requested by the same transmitting location that submitted the claim. ## 📑 Request Fields #### 🔸correlationId The correlationId from the original Bulk Bill claim. --- #### 🔸payeeProvider.providerNumber Details of the health professional to whom the Medicare benefit is to be paid, as submitted in the original claim transmission. - Must be filled with leading zeros if the provider number is greater than 2 characters but less than 8 characters --- ## 📑 Bulk Bill Report Response Fields ### 🔸status Indicates the status of the report being requested. - **Valid values:** - `COMPLETE` - `REPORT_NOT_READY` - `REPORT_NOT_FOUND` - `REPORT_EXPIRED` When `status = COMPLETE`, the following objects/values may be returned: --- #### 🔸claimAssessment.benefitPaid The total amount of Medicare benefit paid for all services in the claim, returned in cents. - **Format:** Numeric cents (e.g., $1.00 → `100`) --- #### 🔸claimAssessment.chargeAmount The total amount charged for all services in the claim, returned in cents. - **Format:** Numeric cents (e.g., $1.00 → `100`) --- #### 🔸claimAssessment.claimId A unique identifier generated by the practice management software for DBS claims, or by the agency for BBSW claims. --- ### medicalEvent – up to 80 per claim #### 🔸medicalEvent.eventDate The date of service applicable to the medical event, as submitted in the original Bulk Bill claim. --- #### 🔸medicalEvent.id An identifier used to define the occurrence of the medical event. --- #### 🔸medicalEvent.patient.status.code A code which identifies the problem with the Medicare card details supplied. --- #### 🔸medicalEvent.patient.status.text Text explaining the patient status code. Provides additional information to assist with service assessment and can be used to suggest changes to the Medicare patient record. - **Values:** - `8023` = Patient identification amended - `8024` = Patient Medicare Issue number changed - `8025` = Patient Medicare Number changed - `8026` = Patient card used will expire shortly - `8027` = Patient card expired. Future services may be rejected - `8028` = Old Medicare issue number for patient. Future services may be rejected --- #### 🔸medicalEvent.patient.currentMembership.memberNumber The patient's Medicare Card Number as recorded with Medicare at the time of the claim. #### 🔸medicalEvent.patient.currentMembership.memberRefNumber The patient’s Medicare Reference Number (IRN) as recorded with Medicare in the original claim. --- #### 🔸medicalEvent.patient.currentMember.familyName The patient's family name as identified or corrected at the time of assessment. --- #### 🔸medicalEvent.patient.currentMember.givenName The patient's first given name as recorded with Medicare. --- ### medicalEvent.service – up to 14 per medical event #### 🔸medicalEvent.service.assessmentCode Medicare assessment result explanation code (Medicare Reason Code). --- #### 🔸medicalEvent.service.benefitPaid The amount of benefit assessed as payable for the service, returned in cents. - **Format:** Numeric cents (e.g., $1.00 → `100`) --- #### 🔸medicalEvent.service.chargeAmount The amount charged for the service in cents, as submitted in the original claim. - **Format:** Numeric cents (e.g., $1.00 → `100`) --- #### 🔸medicalEvent.service.id Unique identifier used to define the occurrence of the service within the claim. --- #### 🔸medicalEvent.service.itemNumber The MBS item number against which the Medicare benefit was assessed. --- #### 🔸medicalEvent.service.numberOfPatientsSeen The number of patients seen for the service in a group attendance scenario. - **Valid values:** `1–99` --- #### 🔸serviceProvider.providerNumber Service provider.

Authentication

x-api-keystring
API Key authentication via header

Headers

x-minor-idstringOptional

Request

This endpoint expects an object.
correlationIdstringRequired
payeeProviderobjectRequired

Response

OK
statusstring
correlationIdstring