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. AIR uses the status in clinical schedule decisions, such as additional vaccines under the National Immunisation Program for Aboriginal and Torres Strait Islander people. A status recorded here takes precedence over Medicare’s.

Send the individualIdentifier that Identify Individual returned. AIR decides whether to allow the update when it receives the request.

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

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, such as AIR-E-1061 (invalid identifier).
AIR-E-1067Action cannot be performed against the individual’s record. No Indigenous status 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.
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