Skip to navigation

Immunisation History Statement

View as Markdown
Can I give this person their official immunisation history statement?

This endpoint produces it: the Australian Immunisation Register (AIR) statement as a PDF, returned as a base64 string.

Generate the individual’s official AIR immunisation history statement as a PDF. The response carries the PDF as a base64-encoded string in immunisationHistoryStatement.fileContent.

Requires an individualIdentifier from a prior Identify Individual call.

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

What’s in the statement

The PDF shows every vaccine recorded on AIR (including overseas vaccines reported to the individual’s provider), assessed up-to-date status for under-7s and 14–19-year-olds, and any planned catch-up dates.

Decoding the PDF

Base64-decode fileContent into bytes and write them to a .pdf file. The result is a Services Australia-issued statement suitable for the individual to keep or print.

Status Codes

CodeMeaning
AIR-I-1100Statement generated. fileContent returned.
AIR-E-1005Validation errors (e.g. AIR-E-1061 invalid identifier).
AIR-E-1058Individual’s record cannot be viewed.
AIR-E-1078Statement cannot be generated or viewed at this time.

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.
individualDateOfBirthstringRequired
DDMMYYYY format.
informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
immunisationHistoryStatementobject or nullOptional

Present on success. null on errors.

errorslist of objects or nullOptional
correlationIdstringOptional