For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • Home
  • API Reference
        • POSTIdentify Individual
        • POSTImmunisation History Details
        • POSTMedical Contraindication History
        • POSTNatural Immunity History
        • POSTVaccine Trial History
        • POSTAdd Additional Vaccine Indicator
        • POSTRemove Additional Vaccine Indicator
        • POSTIndigenous Status Update
        • POSTImmunisation History Statement
        • POSTUpdate Encounter
  • Guides
    • Minor ID Setup
    • Architecture
    • Security & Governance
    • PRODA
    • DVA Integration
    • AIR Integration
    • Integration test data
    • Troubleshooting
LogoLogo
API ReferenceAIRIndividual Details

Immunisation History Details

||View as Markdown|
POST
/AIR/v1.3/individual/immunisation-history/details
POST
/AIR/v1.3/individual/immunisation-history/details
$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"
>  }
>}'
200Success
1{
2  "statusCode": "AIR-I-1100",
3  "codeType": "AIRIBU",
4  "message": "Your request was successfully processed.",
5  "immunisationDetails": {
6    "dueList": [
7      {
8        "disease": "HEP",
9        "vaccineDose": "1",
10        "dueDate": "18062016"
11      },
12      {
13        "disease": "TET",
14        "vaccineDose": "502",
15        "dueDate": "20062026"
16      },
17      {
18        "disease": "MUM",
19        "vaccineDose": "1",
20        "dueDate": "18042017"
21      },
22      {
23        "disease": "VAR",
24        "vaccineDose": "1",
25        "dueDate": "18102017"
26      },
27      {
28        "disease": "MEN",
29        "vaccineDose": "1",
30        "dueDate": "18042017"
31      },
32      {
33        "disease": "MEA",
34        "vaccineDose": "1",
35        "dueDate": "18042017"
36      },
37      {
38        "disease": "DIP",
39        "vaccineDose": "502",
40        "dueDate": "20062026"
41      },
42      {
43        "disease": "POL",
44        "vaccineDose": "1",
45        "dueDate": "18062016"
46      },
47      {
48        "disease": "RUB",
49        "vaccineDose": "1",
50        "dueDate": "18042017"
51      }
52    ],
53    "encounters": [
54      {
55        "episodes": [
56          {
57            "id": 1,
58            "vaccineBatch": "ABC123",
59            "vaccineCode": "BEXO",
60            "vaccineDose": "1",
61            "routeOfAdministration": "",
62            "vaccineType": "NIP",
63            "editable": true,
64            "actionRequiredIndicator": false,
65            "information": {
66              "status": "VALID",
67              "code": null,
68              "text": null
69            }
70          }
71        ],
72        "editable": true,
73        "dateOfService": "20052026",
74        "dateSubmitted": "20052026",
75        "schoolId": "",
76        "administeredOverseas": false,
77        "countryCode": "AUS",
78        "claimSeqNum": 1,
79        "immEncSeqNum": 1,
80        "claimId": "WB021Y6$"
81      },
82      {
83        "episodes": [
84          {
85            "id": 2,
86            "vaccineBatch": "BATCH2",
87            "vaccineCode": "BOOST",
88            "vaccineDose": "501",
89            "routeOfAdministration": "",
90            "vaccineType": "NIP",
91            "editable": true,
92            "actionRequiredIndicator": false,
93            "information": {
94              "status": "VALID",
95              "code": null,
96              "text": null
97            }
98          }
99        ],
100        "editable": true,
101        "dateOfService": "20052026",
102        "dateSubmitted": "20052026",
103        "schoolId": "",
104        "administeredOverseas": false,
105        "countryCode": "AUS",
106        "claimSeqNum": 1,
107        "immEncSeqNum": 1,
108        "claimId": "WB021Y8$"
109      }
110    ]
111  },
112  "correlationId": "urn:uuid:MDE000002aff99ce670140b4"
113}
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. |
Was this page helpful?
Previous

Identify Individual

Next

Medical Contraindication History

Built with

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:

CodeMeaning
AIR-I-1100Request was successfully processed. immunisationDetails returned (may be empty if no history).
AIR-W-1059Individual’s record has endDateCode: LIMITED — details cannot be viewed.
AIR-E-1005Validation errors. Common: AIR-E-1061 invalid or expired identifier.
AIR-E-1058Individual’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

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