Skip to navigation
RebateRight APIAIRPlanned Catch Up

Planned Catch-up Date

View as Markdown
How do I record a planned catch-up date for someone under 20?

Through this endpoint, for a person under 20 on a catch-up schedule. The Australian Immunisation Register (AIR) sets the date, and only one catch-up is ever recorded for each person.

Record a planned catch-up date for an individual under 20 who is on a vaccination catch-up schedule. AIR sets the date as today + 6 months or the individual’s 20th birthday, whichever is earlier, and returns it in catchupDate.

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

When to use this

Recording a planned catch-up gives the individual an up-to-date immunisation status for family assistance payments only, for the duration of the catch-up period. It does not mark the individual up-to-date for clinical purposes — their AIR immunisation status stays not up to date until every scheduled catch-up vaccination is recorded.

Only one catch-up can ever be recorded per individual. Resubmitting returns AIR-W-1010 with the existing date.

Not for general catch-up tracking

This is not the right endpoint to mark that an individual is on a vaccination catch-up schedule. For that, use the Additional Vaccines Required indicator (a special-risk-group flag, separate endpoint).

Acknowledgement text

Services Australia (NOI) requires the provider to read and agree to a fixed acknowledgement before submitting. Display this text in your interface verbatim:

Select this if you would like to commence a planned catch up for the individual as you:

  • were unable to administer all overdue vaccines today; or
  • are waiting on results to support testing of natural immunity; or
  • need to order in additional required vaccines.

Please note an individual can only ever have one catch up schedule recorded on the AIR.

You should not select this if:

  • you have vaccinated the individual and they are no longer overdue for any vaccines, or
  • you feel the parent/guardian does not intend to vaccinate the individual.

Date format

Date fields use DDMMYYYY with no separators (e.g. 24022011).

Status Codes

Top-level outcomes for this endpoint:

CodeMeaning
AIR-I-1009Catch-up date successfully recorded. catchupDate returned.
AIR-W-1010Catch-up already exists for the individual. The existing catchupDate is returned.
AIR-W-1011A catch-up exists but has expired. The expired catchupDate is returned.
AIR-E-1005Validation errors. See errors[]. Common case: individual is over 20 (AIR-E-1047).
AIR-E-1006Unexpected error. Retry shortly.

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

The patient the catch-up is being recorded for. Must be under 20 — over-20s return AIR-E-1047.

informationProviderobjectRequired

Response

OK
statusCodestringOptional

AIR status code. See Status codes.

codeTypestringOptional

Code-type category. AIRIBU on success; AIRWBU on warnings (already exists, expired); AIREBU on validation errors.

messagestringOptional
Status message from AIR.
catchupDatestring or nullOptional

DDMMYYYY format. Present on success (AIR-I-1009) and on the already exists / expired warnings (AIR-W-1010, AIR-W-1011). null on validation errors.

errorslist of objects or nullOptional

Field-level validation problems. Present when statusCode is AIR-E-1005. See Validation codes.

correlationIdstringOptional
Unique request identifier. Include in support tickets so we can trace the request.