For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • Home
  • API Reference
        • POSTIdentify Individual
        • POSTImmunisation History Details
        • POSTMedical Contraindication History
        • POSTNatural Immunity History
        • POSTVaccine Trial History
        • POSTAdd Additional Vaccine Indicator
        • POSTRemove Additional Vaccine Indicator
        • POSTIndigenous Status Update
        • POSTImmunisation History Statement
        • POSTUpdate Encounter
  • Guides
    • Minor ID Setup
    • Architecture
    • Security & Governance
    • PRODA
    • DVA Integration
    • AIR Integration
    • Integration test data
    • Troubleshooting
LogoLogo
API ReferenceAIRIndividual Details

Add Additional Vaccine Indicator

||View as Markdown|
POST
/AIR/v1/individual/additional-vaccine-indicator/add
POST
/AIR/v1/individual/additional-vaccine-indicator/add
$curl -X POST https://api.rebateright.com.au/AIR/v1/individual/additional-vaccine-indicator/add \
> -H "x-api-key: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "individualIdentifier": "wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
> "individualDateOfBirth": "18042016",
> "acknowledgement": true,
> "informationProvider": {
> "providerNumber": "T39126X"
> }
>}'
200Success
1{
2 "statusCode": "AIR-I-1100",
3 "codeType": "AIRIBU",
4 "message": "Your request was successfully processed.",
5 "correlationId": "urn:uuid:MDE000009e6048435dbf4cb3"
6}
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](/api-reference/air/individual-details/identify-individual) call. For shared response patterns and the full status-code list, see [AIR Integration](/air). #### 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). |
Was this page helpful?
Previous

Vaccine Trial History

Next

Remove Additional Vaccine Indicator

Built with

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

CodeMeaning
AIR-I-1100Indicator successfully added.
AIR-E-1005Validation 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
API Key authentication via header

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

OK
statusCodestring
codeTypestring
messagestring
errorslist of objects or null
correlationIdstring