> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.rebateright.com.au/llms.txt.
> For full documentation content, see https://docs.rebateright.com.au/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.rebateright.com.au/_mcp/server.

# Immunisation History Details

POST https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details
Content-Type: application/json

Retrieve an individual's full immunisation history from the Australian Immunisation Register (AIR) — recorded encounters with episode detail, plus the list of vaccines currently due.

Requires an `individualIdentifier` from a prior [Identify Individual](/api-reference/air/individual-details/identify-individual) call. The identifier is opaque and bound to your information provider.

For shared response patterns and the full status-code list, see [AIR Integration](/air).

#### What's returned

- `immunisationDetails.dueList` — vaccines due, by disease, with the next due date.
- `immunisationDetails.encounters` — recorded encounters with episode details, in submission order. Each episode includes `editable` and `actionRequiredIndicator` flags so you can present a correction workflow when the individual's `actionRequiredIndicator` is `true`.

#### Date format

Date fields use **DDMMYYYY** with no separators (e.g. `18042016`).

#### Status Codes

Top-level outcomes for this endpoint:

| Code | Meaning |
|---|---|
| `AIR-I-1100` | Request was successfully processed. `immunisationDetails` returned (may be empty if no history). |
| `AIR-W-1059` | Individual's record has `endDateCode: LIMITED` — details cannot be viewed. |
| `AIR-E-1005` | Validation errors. Common: `AIR-E-1061` invalid or expired identifier. |
| `AIR-E-1058` | Individual's record cannot be viewed or updated. |


Reference: https://docs.rebateright.com.au/api-reference/air/individual-details/immunisation-history-details

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /AIR/v1.3/individual/immunisation-history/details:
    post:
      operationId: immunisation-history-details
      summary: Immunisation History Details
      description: >
        Retrieve an individual's full immunisation history from the Australian
        Immunisation Register (AIR) — recorded encounters with episode detail,
        plus the list of vaccines currently due.


        Requires an `individualIdentifier` from a prior [Identify
        Individual](/api-reference/air/individual-details/identify-individual)
        call. The identifier is opaque and bound to your information provider.


        For shared response patterns and the full status-code list, see [AIR
        Integration](/air).


        #### What's returned


        - `immunisationDetails.dueList` — vaccines due, by disease, with the
        next due date.

        - `immunisationDetails.encounters` — recorded encounters with episode
        details, in submission order. Each episode includes `editable` and
        `actionRequiredIndicator` flags so you can present a correction workflow
        when the individual's `actionRequiredIndicator` is `true`.


        #### Date format


        Date fields use **DDMMYYYY** with no separators (e.g. `18042016`).


        #### Status Codes


        Top-level outcomes for this endpoint:


        | Code | Meaning |

        |---|---|

        | `AIR-I-1100` | Request was successfully processed.
        `immunisationDetails` returned (may be empty if no history). |

        | `AIR-W-1059` | Individual's record has `endDateCode: LIMITED` —
        details cannot be viewed. |

        | `AIR-E-1005` | Validation errors. Common: `AIR-E-1061` invalid or
        expired identifier. |

        | `AIR-E-1058` | Individual's record cannot be viewed or updated. |
      tags:
        - subpackage_air.subpackage_air/individualDetails
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AIR_Individual Details_Immunisation
                  History Details_Response_200
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                individualIdentifier:
                  type: string
                  description: >-
                    Opaque token from a prior [Identify
                    Individual](/api-reference/air/individual-details/identify-individual)
                    call. Bound to your information provider — do not display to
                    end users.
                individualDateOfBirth:
                  type: string
                  description: >-
                    DDMMYYYY format. Must match the individual matched by
                    `individualIdentifier`.
                informationProvider:
                  $ref: >-
                    #/components/schemas/AirV13IndividualImmunisationHistoryDetailsPostRequestBodyContentApplicationJsonSchemaInformationProvider
              required:
                - individualIdentifier
                - individualDateOfBirth
                - informationProvider
servers:
  - url: https://api.rebateright.com.au
  - url: https://test-api.rebateright.com.au
components:
  schemas:
    AirV13IndividualImmunisationHistoryDetailsPostRequestBodyContentApplicationJsonSchemaInformationProvider:
      type: object
      properties:
        providerNumber:
          type: string
          description: >-
            Medicare provider number or AIR provider number. Must be the same
            provider used in the Identify Individual call.
        hpioNumber:
          type: string
          description: >-
            Optional. Healthcare Provider Identifier — Organisation (HPI-O). 16
            digits.
        hpiiNumber:
          type: string
          description: >-
            Optional. Healthcare Provider Identifier — Individual (HPI-I). 16
            digits.
      required:
        - providerNumber
      title: >-
        AirV13IndividualImmunisationHistoryDetailsPostRequestBodyContentApplicationJsonSchemaInformationProvider
    AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsDueListItems:
      type: object
      properties:
        disease:
          type: string
          description: >-
            Three-letter disease code (e.g. `HEP` Hepatitis, `TET` Tetanus,
            `MEA` Measles).
        vaccineDose:
          type: string
          description: Dose number that's due.
        dueDate:
          type: string
          description: DDMMYYYY format. The date the next dose is due.
      title: >-
        AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsDueListItems
    AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItemsEpisodesItemsInformation:
      type: object
      properties:
        status:
          type: string
          description: Episode-level status.
        code:
          type:
            - string
            - 'null'
        text:
          type:
            - string
            - 'null'
      title: >-
        AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItemsEpisodesItemsInformation
    AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItemsEpisodesItems:
      type: object
      properties:
        id:
          type: integer
        vaccineBatch:
          type: string
        vaccineCode:
          type: string
        vaccineDose:
          type: string
        routeOfAdministration:
          type: string
        vaccineType:
          type: string
        editable:
          type: boolean
          description: >-
            `true` when your information provider can edit or update this
            episode.
        actionRequiredIndicator:
          type: boolean
          description: >-
            `true` when this episode is in an invalid status and needs
            correction.
        information:
          $ref: >-
            #/components/schemas/AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItemsEpisodesItemsInformation
      title: >-
        AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItemsEpisodesItems
    AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItems:
      type: object
      properties:
        episodes:
          type: array
          items:
            $ref: >-
              #/components/schemas/AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItemsEpisodesItems
        editable:
          type: boolean
          description: >-
            `true` when your information provider can edit this encounter as a
            whole.
        dateOfService:
          type: string
          description: DDMMYYYY format.
        dateSubmitted:
          type: string
          description: DDMMYYYY format.
        schoolId:
          type: string
        administeredOverseas:
          type: boolean
        countryCode:
          type: string
          description: ICAO country/region code (e.g. `AUS`).
        claimSeqNum:
          type: integer
          description: Claim sequence number assigned by AIR.
        immEncSeqNum:
          type: integer
          description: Immunisation encounter sequence number assigned by AIR.
        claimId:
          type: string
          description: AIR claim identifier.
      title: >-
        AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItems
    AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetails:
      type: object
      properties:
        dueList:
          type: array
          items:
            $ref: >-
              #/components/schemas/AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsDueListItems
          description: Vaccines currently due for the individual, by disease.
        encounters:
          type: array
          items:
            $ref: >-
              #/components/schemas/AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetailsEncountersItems
          description: Past encounters in submission order.
      description: Present on success. `null` on validation errors.
      title: >-
        AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetails
    AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaErrorsItems:
      type: object
      properties:
        code:
          type: string
        field:
          type: string
        message:
          type: string
      title: >-
        AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaErrorsItems
    AIR_Individual Details_Immunisation History Details_Response_200:
      type: object
      properties:
        statusCode:
          type: string
          description: AIR status code. See [Status codes](/air#status-codes).
        codeType:
          type: string
          description: >-
            Code-type category. `AIRIBU` on success; `AIREBU` on validation
            errors.
        message:
          type: string
          description: Status message from AIR.
        immunisationDetails:
          oneOf:
            - $ref: >-
                #/components/schemas/AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaImmunisationDetails
            - type: 'null'
          description: Present on success. `null` on validation errors.
        errors:
          type:
            - array
            - 'null'
          items:
            $ref: >-
              #/components/schemas/AirV13IndividualImmunisationHistoryDetailsPostResponsesContentApplicationJsonSchemaErrorsItems
          description: >-
            Field-level validation problems. Present when `statusCode` is
            `AIR-E-1005`. See [Validation codes](/air#validation-codes).
        correlationId:
          type: string
          description: >-
            Unique request identifier. Include in support tickets so we can
            trace the request.
      title: AIR_Individual Details_Immunisation History Details_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 Success
import requests

url = "https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details"

payload = {
    "individualIdentifier": "wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
    "individualDateOfBirth": "18042016",
    "informationProvider": { "providerNumber": "T39126X" }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Success
const url = 'https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"individualIdentifier":"wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==","individualDateOfBirth":"18042016","informationProvider":{"providerNumber":"T39126X"}}'
};

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

```go Success
package main

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

func main() {

	url := "https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details"

	payload := strings.NewReader("{\n  \"individualIdentifier\": \"wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\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 Success
require 'uri'
require 'net/http'

url = URI("https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details")

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  \"individualIdentifier\": \"wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\n  }\n}"

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

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

HttpResponse<String> response = Unirest.post("https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"individualIdentifier\": \"wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details', [
  'body' => '{
  "individualIdentifier": "wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
  "individualDateOfBirth": "18042016",
  "informationProvider": {
    "providerNumber": "T39126X"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Success
using RestSharp;

var client = new RestClient("https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"individualIdentifier\": \"wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Success
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "individualIdentifier": "wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
  "individualDateOfBirth": "18042016",
  "informationProvider": ["providerNumber": "T39126X"]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details")! 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 Invalid Identifier
import requests

url = "https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details"

payload = {
    "individualIdentifier": "INVALID_TOKEN_VALUE",
    "individualDateOfBirth": "18042016",
    "informationProvider": { "providerNumber": "T39126X" }
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Invalid Identifier
const url = 'https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"individualIdentifier":"INVALID_TOKEN_VALUE","individualDateOfBirth":"18042016","informationProvider":{"providerNumber":"T39126X"}}'
};

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

```go Invalid Identifier
package main

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

func main() {

	url := "https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details"

	payload := strings.NewReader("{\n  \"individualIdentifier\": \"INVALID_TOKEN_VALUE\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\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 Invalid Identifier
require 'uri'
require 'net/http'

url = URI("https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details")

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  \"individualIdentifier\": \"INVALID_TOKEN_VALUE\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\n  }\n}"

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

```java Invalid Identifier
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"individualIdentifier\": \"INVALID_TOKEN_VALUE\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details', [
  'body' => '{
  "individualIdentifier": "INVALID_TOKEN_VALUE",
  "individualDateOfBirth": "18042016",
  "informationProvider": {
    "providerNumber": "T39126X"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

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

```csharp Invalid Identifier
using RestSharp;

var client = new RestClient("https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"individualIdentifier\": \"INVALID_TOKEN_VALUE\",\n  \"individualDateOfBirth\": \"18042016\",\n  \"informationProvider\": {\n    \"providerNumber\": \"T39126X\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Invalid Identifier
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "individualIdentifier": "INVALID_TOKEN_VALUE",
  "individualDateOfBirth": "18042016",
  "informationProvider": ["providerNumber": "T39126X"]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details")! 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()
```