Skip to navigation
RebateRight APIAIRIndividual Details

Immunisation History Details

View as Markdown
What vaccinations has this person had, and what is due?

That is the question this endpoint answers: every encounter recorded on the Australian Immunisation Register (AIR), and the vaccines due by disease with the next due date.

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

Your Minor ID is three uppercase letters followed by five digits, such as MDE00001. Send the Minor ID exactly as issued. A malformed value gets a 400 with “The Minor ID is not valid.” on every endpoint.

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
statusCodestringOptional

AIR status code. See Status codes.

codeTypestringOptional

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

messagestringOptional
Status message from AIR.
immunisationDetailsobject or nullOptional

Present on success. null on validation errors.

errorslist of objects or nullOptional

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

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