Skip to navigation
RebateRight APIAIRIndividual Details

Add Additional Vaccine Indicator

View as Markdown
How do I add the Additional Vaccines Required indicator to a person's record?

Through this endpoint, once the provider acknowledges the statement below.

Add an Additional Vaccines Required indicator to an individual’s AIR record. The indicator flags individuals who may need extra vaccines under the Australian Immunisation Handbook’s advice for special risk groups. These groups include Indigenous people, people with chronic conditions, and infants born preterm or with low birth weight.

Send the individualIdentifier that Identify Individual returned.

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

Acknowledgement text

Services Australia requires the provider to acknowledge a fixed statement before the indicator is added. Show this statement word for word:

Use this indicator for individuals who may require additional vaccines. Consult the Australian Immunisation Handbook for advice and recommendations when vaccinating special risk groups. By adding or removing this indicator, you acknowledge the individual has given consent to update their record.

Send acknowledgement: true only after the provider confirms the statement. Sending acknowledgement: false returns AIR-E-1065.

Status Codes

CodeMeaning
AIR-I-1100Indicator successfully added.
AIR-E-1005Validation errors, most often AIR-E-1065 (acknowledgement not set) or AIR-E-1061 (invalid identifier).
AIR-E-1067Action cannot be performed against the individual’s record. No Additional Vaccines Required update is allowed. AIR can return this code as the statusCode or in errors[].

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

Must be true. Set it only after the provider has read and agreed to the acknowledgement text. false returns AIR-E-1065.

informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
errorslist of objects or nullOptional
correlationIdstringOptional