Record a Catch Up date #

The AIR Planned Catch Up Date function is used to notify AIR that an individual under 20 years of age is on a planned catch up for overdue immunisations for the purposes of family assistance payments.

If a planned catchupDate is recorded via the AIR Web Service, it indicates that the individual is required to be up-to-date by that date with any vaccinations due. During the catch up perdiod the individual’s immunisation status is considered to be up-to-date for Family Assistance purposes for a period of up to 6 months.

Note 1: the individual’s AIR immunisation status will remain ‘not up to date’ until all scheduled catch up vaccinations are recorded.

Note 2: only 1 planned catch up for overdue immunisations can ever be recorded for an individual. If an individual already has a planned catch up recorded, the service will return a message stating it has already been recorded, and also the expiry date for the existing planned catch up will be returned and should be displayed to the end user.

POST - Record an AIR Catch Up date #

You don’t need to specify a date in the request. If successful the response will include the date on which the catch-up period expires. Note that the catchup date can only be set once per patient, so if it has already been set you will get a warning. You may need to try with a different patient to get a successful response.

{{base_url}}/{{version}}/air/catchup?location={{location_id}}

Headers

Params

Body

{
    "_TestCase": "Record AIR Catchup",
    "patient": {
        "medicare": {
            "number": "2953637871",
            "ref": 1
        }
    },
    "provider": {
        "information": "2433411Y"
    }
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/catchup?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record AIR Catchup",
    "patient": {
        "medicare": {
            "number": "2953637871",
            "ref": 1
        }
    },
    "provider": {
        "information": "2433411Y"
    }
}'

Example Response:

Body:

{
  "_TestCase": "Record AIR Catchup",
  "patient": {
    "medicare": {
      "number": "2953637871",
      "ref": "1"
    }
  },
  "provider": {
    "information": "2433411Y"
  },
  "submissionId": 1199,
  "transactionId": "SAP00000ucZODlUPjG2h8yyW",
  "timeReceived": "2021-02-23 08:34:36",
  "submissionType": "PLANNED_CATCH_UP",
  "medicareResponse": "AIR-W-1011",
  "medicareMessage": "Catch-up date period has expired.",
  "assessmentNotes": [],
  "catchupDate": "2021-01-14",
  "status": "WARNING"
}

Headers: