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

Indigenous Status Update

||View as Markdown|
POST
/AIR/v1/individual/indigenous-status/update
POST
/AIR/v1/individual/indigenous-status/update
$curl -X POST https://api.rebateright.com.au/AIR/v1/individual/indigenous-status/update \
> -H "x-api-key: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "individualIdentifier": "wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
> "individualDateOfBirth": "18042016",
> "indigenousStatus": true,
> "informationProvider": {
> "providerNumber": "T39126X"
> }
>}'
200Set Indigenous
1{
2 "statusCode": "AIR-I-1100",
3 "codeType": "AIRIBU",
4 "message": "Your request was successfully processed.",
5 "correlationId": "urn:uuid:MDE00000db924aae63f44eba"
6}
Record an individual's Indigenous status directly on AIR. The status drives clinical schedule decisions (additional vaccines under the National Immunisation Program for Aboriginal and Torres Strait Islander people) and won't be overridden by Medicare. Requires an `individualIdentifier` from a prior [Identify Individual](/api-reference/air/individual-details/identify-individual) call. AIR determines whether the update is allowed at the time of the call. For shared response patterns and the full status-code list, see [AIR Integration](/air). #### Consent Seek consent from the individual at the time of the vaccination encounter before recording their Indigenous status on AIR. #### Status Codes | Code | Meaning | |---|---| | `AIR-I-1100` | Status successfully updated. | | `AIR-E-1005` | Validation errors (e.g. `AIR-E-1061` invalid identifier, `AIR-E-1067` action not permitted for this record). |
Was this page helpful?
Previous

Remove Additional Vaccine Indicator

Next

Immunisation History Statement

Built with

Record an individual’s Indigenous status directly on AIR. The status drives clinical schedule decisions (additional vaccines under the National Immunisation Program for Aboriginal and Torres Strait Islander people) and won’t be overridden by Medicare.

Requires an individualIdentifier from a prior Identify Individual call. AIR determines whether the update is allowed at the time of the call.

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

Consent

Seek consent from the individual at the time of the vaccination encounter before recording their Indigenous status on AIR.

Status Codes

CodeMeaning
AIR-I-1100Status successfully updated.
AIR-E-1005Validation errors (e.g. AIR-E-1061 invalid identifier, AIR-E-1067 action not permitted for this record).

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.
indigenousStatusbooleanRequired

true if the individual identifies as Aboriginal or Torres Strait Islander; false otherwise.

informationProviderobjectRequired

Response

OK
statusCodestring
codeTypestring
messagestring
errorslist of objects or null
correlationIdstring