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

Vaccine Trial History

||View as Markdown|
POST
/AIR/v1/individual/vaccine-trial/history
POST
/AIR/v1/individual/vaccine-trial/history
$curl -X POST https://api.rebateright.com.au/AIR/v1/individual/vaccine-trial/history \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "individualIdentifier": "wXrN7bKidsrEkh89yldqZRw99uzP6WZJfEgIe4PEaEQ1TyUZsqOSEnqCM0BvbRF-FoHdgZgtg4iynmUuQamZdgGPH8QDag8rwFax7MI0zBpBaQnsaznfCA==",
>  "individualDateOfBirth": "17042012",
>  "informationProvider": {
>    "providerNumber": "T39126X"
>  }
>}'
200With History
1{
2  "statusCode": "AIR-I-1100",
3  "codeType": "AIRIBU",
4  "message": "Your request was successfully processed.",
5  "vaccineTrialList": [
6    {
7      "antigenCode": "CHL",
8      "dose": "1",
9      "startDate": "29092020",
10      "endDate": ""
11    },
12    {
13      "antigenCode": "DIP",
14      "dose": "2",
15      "startDate": "04012021",
16      "endDate": ""
17    }
18  ],
19  "correlationId": "urn:uuid:MDE000008cf529112a724e92"
20}
Retrieve vaccine trials the individual is participating in or has participated in, with the antigen code, dose, and trial period. Requires an `individualIdentifier` from a prior [Identify Individual](/api-reference/air/individual-details/identify-individual) call. If `vaccineTrialIndicator` on that response is `false`, this endpoint returns success with no list field. For shared response patterns and the full status-code list, see [AIR Integration](/air). #### Date format Date fields use **DDMMYYYY** with no separators. #### Status Codes Top-level outcomes for this endpoint: | Code | Meaning | |---|---| | `AIR-I-1100` | Request was successfully processed. `vaccineTrialList` returned (omitted entirely when no records exist). | | `AIR-E-1005` | Validation errors (e.g. `AIR-E-1061` invalid or expired identifier). | | `AIR-E-1058` | Individual's record cannot be viewed or updated. |
Was this page helpful?
Previous

Natural Immunity History

Next

Add Additional Vaccine Indicator

Built with

Retrieve vaccine trials the individual is participating in or has participated in, with the antigen code, dose, and trial period.

Requires an individualIdentifier from a prior Identify Individual call. If vaccineTrialIndicator on that response is false, this endpoint returns success with no list field.

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

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

Top-level outcomes for this endpoint:

CodeMeaning
AIR-I-1100Request was successfully processed. vaccineTrialList returned (omitted entirely when no records exist).
AIR-E-1005Validation errors (e.g. 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.
individualDateOfBirthstringRequired

DDMMYYYY format. Must match the individual matched by individualIdentifier.

informationProviderobjectRequired

Response

OK
statusCodestring
codeTypestring
messagestring
vaccineTrialListlist of objects
Recorded vaccine trials. The whole field is omitted when no records exist.
errorslist of objects or null

Field-level validation problems. See Validation codes.

correlationIdstring
Unique request identifier.