Immunisation History Details | RebateRight

curl -X POST https://api.rebateright.com.au/AIR/v1.3/individual/immunisation-history/details \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "individualIdentifier": "wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
  "individualDateOfBirth": "18042016",
  "informationProvider": {
    "providerNumber": "T39126X"
  }
}'

{
  "statusCode": "AIR-I-1100",
  "codeType": "AIRIBU",
  "message": "Your request was successfully processed.",
  "immunisationDetails": {
    "dueList": [
      {
        "disease": "HEP",
        "vaccineDose": "1",
        "dueDate": "18062016"
      },
      {
        "disease": "TET",
        "vaccineDose": "502",
        "dueDate": "20062026"
      },
      {
        "disease": "MUM",
        "vaccineDose": "1",
        "dueDate": "18042017"
      },
      {
        "disease": "VAR",
        "vaccineDose": "1",
        "dueDate": "18102017"
      },
      {
        "disease": "MEN",
        "vaccineDose": "1",
        "dueDate": "18042017"
      },
      {
        "disease": "MEA",
        "vaccineDose": "1",
        "dueDate": "18042017"
      },
      {
        "disease": "DIP",
        "vaccineDose": "502",
        "dueDate": "20062026"
      },
      {
        "disease": "POL",
        "vaccineDose": "1",
        "dueDate": "18062016"
      },
      {
        "disease": "RUB",
        "vaccineDose": "1",
        "dueDate": "18042017"
      }
    ],
    "encounters": [
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "ABC123",
            "vaccineCode": "BEXO",
            "vaccineDose": "1",
            "routeOfAdministration": "",
            "vaccineType": "NIP",
            "editable": true,
            "actionRequiredIndicator": false,
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            }
          }
        ],
        "editable": true,
        "dateOfService": "20052026",
        "dateSubmitted": "20052026",
        "schoolId": "",
        "administeredOverseas": false,
        "countryCode": "AUS",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "WB021Y6$"
      },
      {
        "episodes": [
          {
            "id": 2,
            "vaccineBatch": "BATCH2",
            "vaccineCode": "BOOST",
            "vaccineDose": "501",
            "routeOfAdministration": "",
            "vaccineType": "NIP",
            "editable": true,
            "actionRequiredIndicator": false,
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            }
          }
        ],
        "editable": true,
        "dateOfService": "20052026",
        "dateSubmitted": "20052026",
        "schoolId": "",
        "administeredOverseas": false,
        "countryCode": "AUS",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "WB021Y8$"
      }
    ]
  },
  "correlationId": "urn:uuid:MDE000002aff99ce670140b4"
}

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 call. The identifier is opaque and bound to your information provider.

For shared response patterns and the full status-code list, see AIR Integration.

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.

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

Authentication

x-api-keystring

API Key authentication via header

x-minor-idstring

API Key authentication via header

Request

This endpoint expects an object.

individualIdentifierstringRequired

Opaque token from a prior Identify Individual call. Bound to your information provider — do not display to end users.

individualDateOfBirthstringRequired

DDMMYYYY format. Must match the individual matched by individualIdentifier.

informationProviderobjectRequired

Response

statusCodestring

AIR status code. See Status codes.

codeTypestring

Code-type category. AIRIBU on success; AIREBU on validation errors.

messagestring

Status message from AIR.

immunisationDetailsobject or null

Present on success. null on validation errors.

errorslist of objects or null

Field-level validation problems. Present when statusCode is AIR-E-1005. See Validation codes.

correlationIdstring

Unique request identifier. Include in support tickets so we can trace the request.