Skip to navigation
RebateRight APIAIRIndividual Details

Indigenous Status Update

View as Markdown
How do I record a person's Indigenous status on the AIR?

Through this endpoint, with the person’s consent, using the identifier from Identify Individual.

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.

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

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

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

informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
errorslist of objects or nullOptional
correlationIdstringOptional