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 AIR: the recorded encounters with their episodes, and the vaccines currently due.

Send the individualIdentifier that Identify Individual returned. The identifier is opaque and bound to your information provider.

For shared response patterns and the full status-code list, see AIR Integration. For what your software must show, see Display requirements.

What’s returned

  • immunisationDetails.dueList: the vaccines due, by disease, with the next due date.
  • immunisationDetails.encounters: the recorded encounters with their episodes, in submission order. Each episode carries editable and actionRequiredIndicator flags, so you can offer a correction workflow when the individual’s actionRequiredIndicator is true.

Date format

Date fields use DDMMYYYY with no separators, such as 18042016.

Status Codes

Top-level outcomes for this endpoint:

CodeMeaning
AIR-I-1100Request was successfully processed. immunisationDetails returned, empty when no history is recorded.
AIR-W-1059Individual’s record has endDateCode: LIMITED. Details cannot be viewed.
AIR-E-1005Validation errors, most often 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 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Headers

x-minor-idstringRequired

The Minor ID of the clinic you act for. See Required headers and hosts.

Request

This endpoint expects an object.
individualIdentifierstringRequired

Opaque token that Identify Individual returned. It is bound to your information provider. Keep it hidden from end users.

individualDateOfBirthstringRequired

DDMMYYYY format. Must be the date of birth of the individual that individualIdentifier identifies.

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.