Add Additional Vaccine Indicator | RebateRight

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 per the Australian Immunisation Handbook for special risk groups (Indigenous, chronic conditions, low birth weight, preterm infants).

Requires an individualIdentifier from a prior Identify Individual call.

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

Acknowledgement text

Services Australia (NOI) requires the provider to acknowledge a fixed statement before the indicator is added. Display this verbatim and pass acknowledgement: true only when the provider confirms:

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.

Sending acknowledgement: false returns AIR-E-1065.

Status Codes

Code	Meaning
`AIR-I-1100`	Indicator successfully added.
`AIR-E-1005`	Validation errors. Common: `AIR-E-1065` (acknowledgement not set), `AIR-E-1061` (invalid identifier).

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.

acknowledgementbooleanRequired

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

informationProviderobjectRequired

Response

statusCodestringOptional

codeTypestringOptional

messagestringOptional

errorslist of objects or nullOptional

correlationIdstringOptional