For clean Markdown of any page, append .md to the page URL. For a complete documentation index, see https://docs.rebateright.com.au/api-reference/medicare-claiming/bulk-bill-claim/llms.txt. For full documentation content, see https://docs.rebateright.com.au/api-reference/medicare-claiming/bulk-bill-claim/llms-full.txt.

# Bulk Bill Processing Report

POST https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1
Content-Type: application/json

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.

This report is available for six months after its initial generation 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.

<hr />

#### 🔸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

<hr />

## 📑 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:

<hr />

#### 🔸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`)

<hr />

#### 🔸claimAssessment.chargeAmount

The total amount charged for all services in the claim, returned in cents.

- **Format:** Numeric cents (e.g., $1.00 → `100`)

<hr />

#### 🔸claimAssessment.claimId

A unique identifier generated by the practice management software for DBS claims, or by the agency for BBSW claims.

<hr />

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

<hr />

#### 🔸medicalEvent.id

An identifier used to define the occurrence of the medical event.

<hr />

#### 🔸medicalEvent.patient.status.code

A code which identifies the problem with the Medicare card details supplied.

<hr />

#### 🔸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

<hr />

#### 🔸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.

<hr />

#### 🔸medicalEvent.patient.currentMember.familyName

The patient's family name as identified or corrected at the time of assessment.

<hr />

#### 🔸medicalEvent.patient.currentMember.givenName

The patient's first given name as recorded with Medicare.

<hr />

### medicalEvent.service up to 14 per medical event

#### 🔸medicalEvent.service.assessmentCode

Medicare assessment result explanation code (Medicare Reason Code).

<hr />

#### 🔸medicalEvent.service.benefitPaid

The amount of benefit assessed as payable for the service, returned in cents.

- **Format:** Numeric cents (e.g., $1.00 → `100`)

<hr />

#### 🔸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`)

<hr />

#### 🔸medicalEvent.service.id

Unique identifier used to define the occurrence of the service within the claim.

<hr />

#### 🔸medicalEvent.service.itemNumber

The MBS item number against which the Medicare benefit was assessed.

<hr />

#### 🔸medicalEvent.service.numberOfPatientsSeen

The number of patients seen for the service in a group attendance scenario.

- **Valid values:** `1–99`

<hr />

#### 🔸serviceProvider.providerNumber

Service provider.

Reference: https://docs.rebateright.com.au/api-reference/medicare-claiming/bulk-bill-claim/bulk-bill-processing-report

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /Medicare/bulkbillprocessingreport/v1:
    post:
      operationId: bulk-bill-processing-report
      summary: Bulk Bill Processing Report
      description: >-
        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.


        This report is available for six months after its initial generation 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.


        <hr />


        #### 🔸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


        <hr />


        ## 📑 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:


        <hr />


        #### 🔸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`)


        <hr />


        #### 🔸claimAssessment.chargeAmount


        The total amount charged for all services in the claim, returned in
        cents.


        - **Format:** Numeric cents (e.g., $1.00 → `100`)


        <hr />


        #### 🔸claimAssessment.claimId


        A unique identifier generated by the practice management software for
        DBS claims, or by the agency for BBSW claims.


        <hr />


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


        <hr />


        #### 🔸medicalEvent.id


        An identifier used to define the occurrence of the medical event.


        <hr />


        #### 🔸medicalEvent.patient.status.code


        A code which identifies the problem with the Medicare card details
        supplied.


        <hr />


        #### 🔸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

        <hr />


        #### 🔸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.


        <hr />


        #### 🔸medicalEvent.patient.currentMember.familyName


        The patient's family name as identified or corrected at the time of
        assessment.


        <hr />


        #### 🔸medicalEvent.patient.currentMember.givenName


        The patient's first given name as recorded with Medicare.


        <hr />


        ### medicalEvent.service up to 14 per medical event


        #### 🔸medicalEvent.service.assessmentCode


        Medicare assessment result explanation code (Medicare Reason Code).


        <hr />


        #### 🔸medicalEvent.service.benefitPaid


        The amount of benefit assessed as payable for the service, returned in
        cents.


        - **Format:** Numeric cents (e.g., $1.00 → `100`)


        <hr />


        #### 🔸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`)


        <hr />


        #### 🔸medicalEvent.service.id


        Unique identifier used to define the occurrence of the service within
        the claim.


        <hr />


        #### 🔸medicalEvent.service.itemNumber


        The MBS item number against which the Medicare benefit was assessed.


        <hr />


        #### 🔸medicalEvent.service.numberOfPatientsSeen


        The number of patients seen for the service in a group attendance
        scenario.


        - **Valid values:** `1–99`


        <hr />


        #### 🔸serviceProvider.providerNumber


        Service provider.
      tags:
        - subpackage_medicareClaiming.subpackage_medicareClaiming/bulkBillClaim
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Medicare Claiming_Bulk Bill Claim_Bulk
                  Bill Processing Report_Response_200
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                correlationId:
                  type: string
                  description: >-
                    The `correlationId` from the original Bulk Bill claim
                    submission.
                payeeProvider:
                  $ref: >-
                    #/components/schemas/MedicareBulkbillprocessingreportV1PostRequestBodyContentApplicationJsonSchemaPayeeProvider
              required:
                - correlationId
                - payeeProvider
servers:
  - url: https://api.rebateright.com.au
  - url: https://test-api.rebateright.com.au
components:
  schemas:
    MedicareBulkbillprocessingreportV1PostRequestBodyContentApplicationJsonSchemaPayeeProvider:
      type: object
      properties:
        providerNumber:
          type: string
          description: >-
            Must be filled with leading zeros if greater than 2 characters but
            less than 8 characters.
      required:
        - providerNumber
      title: >-
        MedicareBulkbillprocessingreportV1PostRequestBodyContentApplicationJsonSchemaPayeeProvider
    Medicare Claiming_Bulk Bill Claim_Bulk Bill Processing Report_Response_200:
      type: object
      properties:
        status:
          type: string
        correlationId:
          type: string
      required:
        - status
        - correlationId
      title: >-
        Medicare Claiming_Bulk Bill Claim_Bulk Bill Processing
        Report_Response_200
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    minorId:
      type: apiKey
      in: header
      name: x-minor-id

```

## SDK Code Examples

```python Complete
import requests

url = "https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1"

payload = {
    "correlationId": "urn:uuid:MDE00000ee97ff9fd17d4afc",
    "payeeProvider": { "providerNumber": "2447781L" }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Complete
const url = 'https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"correlationId":"urn:uuid:MDE00000ee97ff9fd17d4afc","payeeProvider":{"providerNumber":"2447781L"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Complete
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1"

	payload := strings.NewReader("{\n  \"correlationId\": \"urn:uuid:MDE00000ee97ff9fd17d4afc\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Complete
require 'uri'
require 'net/http'

url = URI("https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"correlationId\": \"urn:uuid:MDE00000ee97ff9fd17d4afc\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Complete
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"correlationId\": \"urn:uuid:MDE00000ee97ff9fd17d4afc\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}")
  .asString();
```

```php Complete
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1', [
  'body' => '{
  "correlationId": "urn:uuid:MDE00000ee97ff9fd17d4afc",
  "payeeProvider": {
    "providerNumber": "2447781L"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Complete
using RestSharp;

var client = new RestClient("https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"correlationId\": \"urn:uuid:MDE00000ee97ff9fd17d4afc\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Complete
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "correlationId": "urn:uuid:MDE00000ee97ff9fd17d4afc",
  "payeeProvider": ["providerNumber": "2447781L"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

```python Report Not Ready
import requests

url = "https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1"

payload = {
    "correlationId": "urn:uuid:MDE000009bb6cd1c92674e1c",
    "payeeProvider": { "providerNumber": "2447781L" }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Report Not Ready
const url = 'https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"correlationId":"urn:uuid:MDE000009bb6cd1c92674e1c","payeeProvider":{"providerNumber":"2447781L"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Report Not Ready
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1"

	payload := strings.NewReader("{\n  \"correlationId\": \"urn:uuid:MDE000009bb6cd1c92674e1c\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Report Not Ready
require 'uri'
require 'net/http'

url = URI("https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"correlationId\": \"urn:uuid:MDE000009bb6cd1c92674e1c\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Report Not Ready
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"correlationId\": \"urn:uuid:MDE000009bb6cd1c92674e1c\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}")
  .asString();
```

```php Report Not Ready
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1', [
  'body' => '{
  "correlationId": "urn:uuid:MDE000009bb6cd1c92674e1c",
  "payeeProvider": {
    "providerNumber": "2447781L"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Report Not Ready
using RestSharp;

var client = new RestClient("https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"correlationId\": \"urn:uuid:MDE000009bb6cd1c92674e1c\",\n  \"payeeProvider\": {\n    \"providerNumber\": \"2447781L\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Report Not Ready
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "correlationId": "urn:uuid:MDE000009bb6cd1c92674e1c",
  "payeeProvider": ["providerNumber": "2447781L"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.rebateright.com.au/Medicare/bulkbillprocessingreport/v1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```