Planned Catch-up Date

View as Markdown
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](/air). #### 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: | Code | Meaning | |---|---| | `AIR-I-1009` | Catch-up date successfully recorded. `catchupDate` returned. | | `AIR-W-1010` | Catch-up already exists for the individual. The existing `catchupDate` is returned. | | `AIR-W-1011` | A catch-up exists but has expired. The expired `catchupDate` is returned. | | `AIR-E-1005` | Validation errors. See `errors[]`. Common case: individual is over 20 (`AIR-E-1047`). | | `AIR-E-1006` | Unexpected error. Retry shortly. |

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring
API Key authentication via header

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
statusCodestring

AIR status code. See Status codes.

codeTypestring

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

messagestring
Status message from AIR.
catchupDatestring or null

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 null

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

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