Record Immunisations #

The AIR Record Encounter function allows recognised vaccination providers to send an individual’s immunisation information to the AIR.

The air/record endpoint consists of:

One Information Provider Number
One Immunisation Provider Number (optional, if different to the Information Provider)
One Individual
One encounter (date of service) consisting of 1 or more vaccine ’episodes’ with the details such as dose, batch number, and serial number

From 1 March 2021 for COVID and Influenza, and from 1 July 2021 for all National Immunisation Program (NIP) vaccinations it is mandatory to report:

Date of vaccination
Vaccine brand
Dose number
Vaccine batch number
Provider details (including provider number)
Patient details (including name, date of birth and address)

Vaccination providers in Australia can also send information about immunisations received by individuals overseas and immunisations administered by another vaccination provider.

This request will process in real-time transaction and will update the data entered for an individual’s immunisation history as recorded in the AIR.

IMPORTANT AIR UPDATE #

From 1st of March 2024 two new fields must be accounted for in the Record an AIR Encounter and Encounters end point.

item.vaccine.vaccineType
item.vaccine.routeOfAdministration

These two fields can currently be tested by using the query string parameter submit=false but can not currently be supplied to production or without submit=false in the sandbox, as soon as this is updated it will be noted here.

vaccineType: This is a required field (as of March 1st 2024) which defines the funding type under which it was provided. The following strings are acceptable responses. “AEN” – Antenatal “NIP” – NIP/Commonwealth “PRV” – Private “STP” – State Program

routeOfAdministration: This is a required field (as of March 1st 2024) when the vaccine supplied in the event is JESPCT or IMOJEV. It is used indicate how the vaccine was supplied. The following strings are acceptable responses.

Note: “PO” - Oral “SC” - Subcutaneous “ID” - Intradermal “IM” – Intramuscular

All “Record AIR Encounter/s” examples have been updated. “Record AIR Encounter with route of administration” has been included.

`POST` - Record an AIR Encounter #

To record an AIR encounter, you’ll need to identify the individual by a combination of their Medicare card, name, date of birth and postcode.

The provider must be identified. You can use their provider number and/or their HPII or HPIO numbers.

You can include one or more vaccination ’episodes’ in a single transmission.

Vaccines are referred to by their code as published on this Services Australia page This list should be displayed to end users in a dropdown or similar format (see Vaccine Codes section above)

The dose number must be supplied; this is the ordinal number of the dose.

Vaccine batch number is optional.

Serial number if known is required for COVID vaccines. See below for an example.

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter ",
    "patient": {
        "medicare": {
            "number": "2953755441",
            "ref": 1
        },
        "dateOfBirth": "1976-09-08",
        "name": {
            "first": "Isabelle",
            "family": "ASHLEY"
        },
        "address": {
            "postcode": "2756"
        }
    },
    "provider": {
        "information": "2438081F",
        "immunisation": "2408271B"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1",
                "vaccineType": "AEN"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        },
        "dateOfBirth": "1976-09-08",
        "name": {
            "first": "Isabelle",
            "family": "ASHLEY"
        },
        "address": {
            "postcode": "2756"
        }
    },
    "provider": {
        "information": "2438081F",
        "immunisation": "2408271B"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    },
    "dateOfBirth": "1976-09-08",
    "name": {
      "first": "Isabelle",
      "family": "ASHLEY"
    },
    "address": {
      "postcode": "2756"
    }
  },
  "provider": {
    "information": "2438081F",
    "immunisation": "2408271B"
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "CDT",
        "dose": "1",
        "vaccineType": "AEN"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ]
    }
  ],
  "submissionId": 614,
  "transactionId": "SAP00000F62dq8IXhlWkvgfH",
  "medicareClaimId": "W210222$",
  "timeReceived": "2021-02-22 06:19:52",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	927
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter for a vaccine with routeOfAdministration #

From time to time you may find that the individual is not known to AIR, and the API will return a code AIR-W-1004 - “Individual was not found. Please either correct the individual details or confirm and accept individual details are correct.” In this situation you can still submit immunisation details, however there’s a confirmatory step required. See below - you will need the “submissionId” from this response.

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter - routeOfAdminstration required and provided",
    "patient": {
        "dateOfBirth": "2019-04-01",
        "gender": "M",
        "name": {
            "first": "Teddy",
            "family": "Heany"
        },
        "medicare": {
            "number": "3951025051",
            "ref": 6
        },
        "address": {
            "line1": "27 Arthur Pl",
            "line2": "Front House",
            "locality": "COKUM",
            "postcode": "3542"
        },
        "atsiIndicator": "N"
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "2021-02-02",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBOC",
                "dose": "1",
                "fundingType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter - individual unknown to AIR",
    "patient": {
        "dateOfBirth": "2019-04-01",
        "gender": "M",
        "name": {
            "first": "Teddy",
            "family": "Heany"
        },
        "medicare": {
            "number": "3951025051",
            "ref": 6
        },
        "address": {
            "line1": "27 Arthur Pl",
            "line2": "Front House",
            "locality": "COKUM",
            "postcode": "3542"
        },
        "atsiIndicator": "N"
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "2021-02-02",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBOC",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter - routeOfAdminstration required and provided",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    },
    "dateOfBirth": "1976-09-08",
    "name": {
      "first": "Isabelle",
      "family": "ASHLEY"
    },
    "address": {
      "postcode": "2756"
    }
  },
  "provider": {
    "information": "2438081F",
    "immunisation": "2408271B"
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "JESPCT",
        "dose": "1",
        "vaccineType": "NIP",
        "routeOfAdministration": "IM"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ]
    }
  ],
  "submissionId": 614,
  "transactionId": "SAP00000F62dq8IXhlWkvgfH",
  "medicareClaimId": "W210222$",
  "timeReceived": "2021-02-22 06:19:52",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	219
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record several AIR Encounters #

You can record several immunisations for the one individual and provider in a single call. Put as many as you need into the items aray. We can handle up to 50 should you ever need that many!

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record several AIR Encounters",
    "patient": {
        "medicare": {
            "number": "6951629201",
            "ref": 1
        }
    },
    "provider": {
        "information": "2438081F",
        "immunisation": "2438081F"
    },
    "items": [
        {
            "date": "2020-05-28",
            "vaccine": {
                "batch": "A12341234",
                "code": "PROQAD",
                "dose": "1",
                "vaccineType": "NIP"
            }
        },
        {
            "date": "2020-05-29",
            "vaccine": {
                "batch": "A12341234",
                "code": "PRPT",
                "dose": "2",
                "vaccineType": "AEN"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record several AIR Encounters",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        }
    },
    "provider": {
        "information": "2438081F",
        "immunisation": "2438081F"
    },
    "items": [
        {
            "date": "2020-05-28",
            "vaccine": {
                "batch": "A12341234",
                "code": "PROQAD",
                "dose": "1"
            }
        },
        {
            "date": "2020-05-29",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBV",
                "dose": "2"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record several AIR Encounters",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    }
  },
  "provider": {
    "information": "2438081F",
    "immunisation": "2438081F"
  },
  "items": [
    {
      "date": "2020-05-28",
      "vaccine": {
        "batch": "A12341234",
        "code": "PROQAD",
        "dose": "1",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ]
    },
    {
      "date": "2020-05-29",
      "vaccine": {
        "batch": "A12341234",
        "code": "HBV",
        "dose": "2",
        "vaccineType": "AEN"
      },
      "encounterId": "2",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ]
    }
  ],
  "submissionId": 616,
  "transactionId": "SAP00000aFARHhh24UCoWGf7",
  "medicareClaimId": "W210222$",
  "timeReceived": "2021-02-22 06:22:13",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    },
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 2: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	1162
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter using DoB and Medicare Card #

To record an AIR encounter when the Medicare details are not available, you can identify an individual by name and date of birth. We recommend that you also include postcode to further ensure a unique identification.

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter - DoB and Medicare card number",
    "patient": {
        "dateOfBirth": "2010-10-18",
        "name": {
            "first": "Everette",
            "family": "MOORE"
        },
        "medicare": {
            "number": "6951629201"
        },
        "address": {
            "postcode": "2752"
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "code": "ADCL",
                "dose": "2",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter - DoB and Address",
    "patient": {
        "dateOfBirth": "2002-09-25",
        "name": {
            "first": "Joseph",
            "family": "Aldridge"
        },
        "address": {
            "postcode": "2800"
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBV",
                "dose": "2"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter - DoB and Address",
  "patient": {
    "dateOfBirth": "2002-09-25",
    "name": {
      "first": "Joseph",
      "family": "Aldridge"
    },
    "address": {
      "postcode": "2800"
    }
  },
  "provider": {
    "information": "2438081F"
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "HBV",
        "dose": "2",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": []
    }
  ],
  "submissionId": 609,
  "transactionId": "SAP00000GIZTFix6wdeEqmGK",
  "medicareClaimId": "W210222$",
  "timeReceived": "2021-02-22 06:12:59",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	706
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter using Medicare Card Details #

To record an AIR encounter, the minimum requirement to identify an individual is a medicare number and ref (Individual Reference Number or IRN).

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter - Medicare Card",
    "patient": {
        "medicare": {
            "number": "2953755351",
            "ref": 1
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "HPV",
                "dose": "1",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter - Medicare Card",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "HPV",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter - Medicare Card",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    }
  },
  "provider": {
    "information": "2438081F"
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "HPV",
        "dose": "1",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ]
    }
  ],
  "submissionId": 619,
  "transactionId": "SAP00000qq2I7RxxYhS7ewNB",
  "medicareClaimId": "W210222$",
  "timeReceived": "2021-02-22 06:26:05",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	830
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter using DoB and Address #

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter - DoB and Address",
    "patient": {
        "dateOfBirth": "2010-10-18",
        "name": {
            "first": "Everette",
            "family": "MOORE"
        },
        "address": {
            "postcode": "2752"
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBV",
                "dose": "2",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter - DoB and Address",
    "patient": {
        "dateOfBirth": "2002-09-25",
        "name": {
            "first": "Joseph",
            "family": "Aldridge"
        },
        "address": {
            "postcode": "2800"
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBV",
                "dose": "2"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter - DoB and Address",
  "patient": {
    "dateOfBirth": "2002-09-25",
    "name": {
      "first": "Joseph",
      "family": "Aldridge"
    },
    "address": {
      "postcode": "2800"
    }
  },
  "provider": {
    "information": "2438081F"
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "HBV",
        "dose": "2",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": []
    }
  ],
  "submissionId": 609,
  "transactionId": "SAP00000GIZTFix6wdeEqmGK",
  "medicareClaimId": "W210222$",
  "timeReceived": "2021-02-22 06:12:59",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	706
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter using Last name, DoB and Medicare card #

It is also possible to use just the Medicare card number (without IRN), last name and date of birth to identify an individual. This scenario is the least preferred option as it may not return a unique match i.e., in the case of twins.

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter - Last Name, DoB and Medicare card",
    "patient": {
        "medicare": {
            "number": "6951629201"
        },
        "dateOfBirth": "2012-01-23",
        "name": {
            "family": "MOORE"
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "FLUVAX",
                "dose": "1",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter - Last Name, DoB and Medicare card",
    "patient": {
        "medicare": {
            "number": "2953755261"
        },
        "dateOfBirth": "1976-09-08",
        "name": {
            "family": "ASHLEY"
        }
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "FLUVAX",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter - Last Name, DoB and Medicare card",
  "patient": {
    "medicare": {
      "number": "2953755261"
    },
    "dateOfBirth": "1976-09-08",
    "name": {
      "family": "ASHLEY"
    }
  },
  "provider": {
    "information": "2438081F"
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "FLUVAX",
        "dose": "1",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ]
    }
  ],
  "submissionId": 620,
  "transactionId": "SAP00000cnivlFtmUI7je5Hb",
  "medicareClaimId": "W210222$",
  "timeReceived": "2021-02-22 06:28:38",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	899
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter with vaccine serial number #

Where a COVID vaccine serial number is available it must be recorded as a requirement of COVID-19 vaccination legislation. Serial numbers may be up to 108 characters long, so we recommend using label scanners or QR code readers to capture the data.

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter with serial number",
    "patient": {
        "medicare": {
            "number": "6951629201",
            "ref": 4
        },
        "dateOfBirth": "2014-07-04",
        "name": {
            "first": "Dominique",
            "family": "MOORE"
        },
        "address": {
            "postcode": "7011"
        }
    },
    "provider": {
        "information": "2433411Y"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "C3094583",
                "code": "COVAST",
                "dose": "1",
                "vaccineType": "NIP",
                "serialNumber": "018974018724719823740981741092837401983740198374019837401982374091872340198710298374"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter with serial number",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        },
        "dateOfBirth": "1976-09-08",
        "name": {
            "first": "Isabelle",
            "family": "ASHLEY"
        },
        "address": {
            "postcode": "2756"
        }
    },
    "provider": {
        "information": "2433411Y"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "C3094583",
                "code": "COVAST",
                "dose": "1",
                "serialNumber": "018974018724719823740981741092837401983740198374019837401982374091872340198710298374"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter with serial number",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    },
    "dateOfBirth": "1976-09-08",
    "name": {
      "first": "Isabelle",
      "family": "ASHLEY"
    },
    "address": {
      "postcode": "2756"
    }
  },
  "provider": {
    "information": "2433411Y"
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "C3094583",
        "code": "COVAST",
        "dose": "1",
        "vaccineType": "NIP",
        "serialNumber": "018974018724719823740981741092837401983740198374019837401982374091872340198710298374"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [],
      "claimSeqNumber": "6"
    }
  ],
  "submissionId": 1703,
  "transactionId": "SAP0000035PfIv8q8b0Z9bc0",
  "medicareClaimId": "W210304$",
  "timeReceived": "2021-03-04 13:38:24",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-W-1008",
  "medicareMessage": "There are encounter(s) that were not successfully recorded. Correct the details or submit confirmation accepting episode(s) status.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-W-1001",
      "note": "Encounter 1: Encounter was NOT successfully recorded. Correct the details or submit confirmation accepting episode(s) status."
    }
  ],
  "status": "REJECTED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	1156
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter with Immunizing Provider Number #

Optionally you can include the Immunising Provider Number in the request. This may be a Medicare provider number or an Ancillary provider number with a State Code prefix.

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

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "patient": {
        "dateOfBirth": "1968-08-22",
        "name": {
            "first": "Don",
            "family": "Middleton"
        },
        "address": {
            "postcode": "2911"
        }
    },
    "provider": {
        "information": "2408271B",
        "immunisation": "T45718B"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A141414",
                "code": "HBV",
                "dose": "1",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "patient": {
        "dateOfBirth": "1968-08-22",
        "name": {
            "first": "Don",
            "family": "Middleton"
        },
        "address": {
            "postcode": "2911"
        }
    },
    "provider": {
        "information": "2408271B",
        "immunisation": "T45718B"
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A141414",
                "code": "HBV",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "patient": {
    "dateOfBirth": "1968-08-22",
    "name": {
      "first": "Don",
      "family": "Middleton"
    },
    "address": {
      "postcode": "2911"
    }
  },
  "provider": {
    "information": "2408271B",
    "immunisation": "T45718B"
  },
  "items": [
    {
      "date": "2021-08-03",
      "vaccine": {
        "batch": "A141414",
        "code": "HBV",
        "dose": "1",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ],
      "claimSeqNumber": "1"
    }
  ],
  "submissionId": 399,
  "transactionId": "SAP00000svJ3uiVXlQdS08Cr",
  "medicareClaimId": "W210804$",
  "timeReceived": "2021-08-04 13:29:22",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	883
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an encounter using HI details #

If you have the IHI of the patient or the relevant HPII or HPIO of the provider you can add these to the request.

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

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an encounter - HI Details",
    "patient": {
        "medicare": {
            "number": "6951629201",
            "ref": 5
        },
        "ihi": "8003608500268550"
    },
    "provider": {
        "information": {
            "number": "2433411Y",
            "hpio": "8003624900033520",
            "hpii": "8003613233376029"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an encounter - HI Details",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        },
        "ihi": "8003608166933689"
    },
    "provider": {
        "information": {
            "number": "2433411Y",
            "hpio": "8003624900033520",
            "hpii": "8003613233376029"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an encounter - HI Details",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    },
    "ihi": "8003608166933689"
  },
  "provider": {
    "information": {
      "number": "2433411Y",
      "hpio": "8003624900033520",
      "hpii": "8003613233376029"
    }
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "CDT",
        "dose": "1",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ],
      "claimSeqNumber": "3"
    }
  ],
  "submissionId": 1699,
  "transactionId": "SAP00000I38JJcHHEoBgaALg",
  "medicareClaimId": "W210304$",
  "timeReceived": "2021-03-04 13:20:36",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	942
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record a vaccine with School ID #

To indicate that a vaccine was given at a school program, add schoolId at the item level. School IDs are 5 digits.

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

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record a vaccine given at school",
    "patient": {
        "medicare": {
            "number": "6951629201",
            "ref": 3
        }
    },
    "provider": {
        "information": {
            "number": "2433411Y"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "schoolId": "40000",
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record a vaccine given at school",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        }
    },
    "provider": {
        "information": {
            "number": "2433411Y"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "schoolId": "40000",
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record a vaccine given at school",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    }
  },
  "provider": {
    "information": {
      "number": "2433411Y"
    }
  },
  "items": [
    {
      "date": "2018-10-14",
      "schoolId": "40000",
      "vaccine": {
        "batch": "A12341234",
        "code": "CDT",
        "dose": "1",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ],
      "claimSeqNumber": "5"
    }
  ],
  "submissionId": 1701,
  "transactionId": "SAP00000DMN0c0iaX2CiN8jt",
  "medicareClaimId": "W210304$",
  "timeReceived": "2021-03-04 13:29:27",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	880
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record a vaccine given overseas #

To indciate that a vaccine was given overseas, add administeredOverseas - true at the item level

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

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record a vaccine given overseas",
    "patient": {
        "medicare": {
            "number": "6951629201",
            "ref": 4
        }
    },
    "provider": {
        "information": {
            "number": "2433411Y"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "administeredOverseas": true,
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record a vaccine given overseas",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        }
    },
    "provider": {
        "information": {
            "number": "2433411Y"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "administeredOverseas": true,
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "CDT",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record a vaccine given overseas",
  "patient": {
    "medicare": {
      "number": "2953755261",
      "ref": "1"
    }
  },
  "provider": {
    "information": {
      "number": "2433411Y"
    }
  },
  "items": [
    {
      "date": "2018-10-14",
      "administeredOverseas": true,
      "vaccine": {
        "batch": "A12341234",
        "code": "CDT",
        "dose": "1",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-I-1003",
          "note": "Dosage was adjusted to V"
        }
      ],
      "claimSeqNumber": "2"
    }
  ],
  "submissionId": 1696,
  "transactionId": "SAP00000MyQ5L4WtQ1D3yrdw",
  "medicareClaimId": "W210304$",
  "timeReceived": "2021-03-04 13:17:20",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-I-1000",
      "note": "Encounter 1: Encounter was successfully recorded."
    }
  ],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	894
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an encounter - handling errors #

When a request to record a vaccination returns a warning AIR-W-1008 “There are encounter(s) that were not successfully recorded. Correct the details or submit confirmation accepting episode(s) status.”, the end user should be advised to confirm the details. If an amendment is needed then it should be submitted as a new request. If the details are correct then a confirmation step is required, using the submission ID from the response. See below.

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

Headers

Header	Value
Content-Type	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an encounter - handling errors",
    "patient": {
        "medicare": {
            "number": "2953637411"
        },
        "dateOfBirth": "2002-11-13",
        "name": {
            "family": "Adamson"
        }
    },
    "provider": {
        "information": {
            "number": "2433411Y"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "MMR",
                "dose": "5",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an encounter - handling errors",
    "patient": {
        "medicare": {
            "number": "2953637411"
        },
        "dateOfBirth": "2002-11-13",
        "name": {
            "family": "Adamson"
        }
    },
    "provider": {
        "information": {
            "number": "2433411Y"
        }
    },
    "items": [
        {
            "date": "{{yesterday}}",
            "vaccine": {
                "batch": "A12341234",
                "code": "MMR",
                "dose": "5"
            }
        }
    ]
}'

Example Response:

Body:

{
  "_TestCase": "Record an encounter - handling errors",
  "patient": {
    "medicare": {
      "number": "2953637411"
    },
    "dateOfBirth": "2002-11-13",
    "name": {
      "family": "Adamson"
    }
  },
  "provider": {
    "information": {
      "number": "2433411Y"
    }
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "MMR",
        "dose": "5",
        "vaccineType": "NIP"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [
        {
          "assessor": "Medicare",
          "code": "AIR-W-0400",
          "note": "Accept and submit to AIR"
        }
      ],
      "claimSeqNumber": "1"
    }
  ],
  "submissionId": 1693,
  "transactionId": "SAP00000pw65Jz7LYvgop0ZS",
  "medicareClaimId": "W210304$",
  "timeReceived": "2021-03-04 13:01:54",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-W-1008",
  "medicareMessage": "There are encounter(s) that were not successfully recorded. Correct the details or submit confirmation accepting episode(s) status.",
  "assessmentNotes": [
    {
      "assessor": "Medicare",
      "code": "AIR-W-1001",
      "note": "Encounter 1: Encounter was NOT successfully recorded. Correct the details or submit confirmation accepting episode(s) status."
    }
  ],
  "status": "REJECTED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	1074
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`PUT` - Record an AIR Encounter with errors - CONFIRMATION STEP #

To confirm that the details are correct and you want to proceed to record the vaccine, you will need the submission ID from the initial request in the URL of this PUT statement, and “submitEncounter”: “Y” in the body.

{{base_url}}/{{version}}/air/record/{{submission_id}}?location={{location_id}}

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "submitEncounter": "Y"
}

Example Request:

curl --location --request PUT 'https://sandbox.claiming.com.au/v2/air/record/121?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "submitEncounter": "Y"
}'

Example Response:

Body:

{
  "_TestCase": "Record an encounter - handling errors",
  "patient": {
    "medicare": {
      "number": "2953637411"
    },
    "dateOfBirth": "2002-11-13",
    "name": {
      "family": "Adamson"
    }
  },
  "provider": {
    "information": {
      "number": "2433411Y"
    }
  },
  "items": [
    {
      "date": "2018-10-14",
      "vaccine": {
        "batch": "A12341234",
        "code": "MMR",
        "dose": "5"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": [],
      "claimSeqNumber": null
    }
  ],
  "submissionId": 2335,
  "transactionId": "SAP00000LWfCBORQa1KkJZGB",
  "medicareClaimId": "W210531$",
  "timeReceived": "2021-05-31 13:24:23",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	724
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`POST` - Record an AIR Encounter for a new patient #

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

Headers

Header	Value
Accept	application/json
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Record an AIR Encounter - individual unknown to AIR",
    "patient": {
        "dateOfBirth": "2019-04-01",
        "gender": "M",
        "name": {
            "first": "Teddy",
            "family": "Heany"
        },
        "medicare": {
            "number": "3951025051",
            "ref": 6
        },
        "address": {
            "line1": "27 Arthur Pl",
            "line2": "Front House",
            "locality": "COKUM",
            "postcode": "3542"
        },
        "atsiIndicator": "N"
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "2021-02-02",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBOC",
                "dose": "1",
                "vaccineType": "NIP"
            }
        }
    ]
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/record?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Record an AIR Encounter - individual unknown to AIR",
    "patient": {
        "dateOfBirth": "2019-04-01",
        "gender": "M",
        "name": {
            "first": "Teddy",
            "family": "Heany"
        },
        "medicare": {
            "number": "3951025051",
            "ref": 6
        },
        "address": {
            "line1": "27 Arthur Pl",
            "line2": "Front House",
            "locality": "COKUM",
            "postcode": "3542"
        },
        "atsiIndicator": "N"
    },
    "provider": {
        "information": "2438081F"
    },
    "items": [
        {
            "date": "2021-02-02",
            "vaccine": {
                "batch": "A12341234",
                "code": "HBOC",
                "dose": "1"
            }
        }
    ]
}'

Example Response:

Body:

{
  "status": "WARNING",
  "errors": [
    {
      "code": "AIR-W-1004",
      "message": "Individual was not found. Please either correct the individual details or confirm and accept individual details are correct."
    }
  ],
  "submissionId": 2417
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	219
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

`PUT` - Record an AIR Encounter for a unfound patient - CONFIRMATION STEP #

To confirm that the details are correct and you want to proceed to record the vaccine, you will need the claimID from the initial request in the URL of this PUT statement
To use this payload and endpoint you will need to ensure the record includes these details at a minimum.

“dateOfBirth”:"…",
“gender”:"…"

Name
“first”:"…",
“family”:"…"

Address
“line1”:"…",
“locality”:"… “,
“postcode”:”…"

If you attempt to use the payload submit individual Y without these details you will receive an error.

{{base_url}}/{{version}}/air/record/{{submission_id}}?location={{location_id}}

Headers

Header	Value
Accept	application/json

Headers

Content-Type	Value
Authorization	Bearer {{oauth_token}}

Params

Param	value
location	{{location_id}}

Body

{
    "submitIndividual": "Y"
}

Example Request:

curl --location --request PUT 'https://sandbox.claiming.com.au/v2/air/record121?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "submitIndividual": "Y"
}'

Example Response:

Body:

{
  "_TestCase": "Record an AIR Encounter - individual unknown to AIR",
  "patient": {
    "dateOfBirth": "2019-04-01",
    "gender": "M",
    "name": {
      "first": "Teddy",
      "family": "Heany"
    },
    "address": {
      "line1": "27 Arthur Pl",
      "line2": "Front House",
      "locality": "COKUM",
      "postcode": "3542"
    },
    "atsiIndicator": false
  },
  "provider": {
    "information": "2438081F"
  },
  "items": [
    {
      "date": "2021-02-02",
      "vaccine": {
        "batch": "A12341234",
        "code": "HBOC",
        "dose": "1"
      },
      "encounterId": "1",
      "episodeId": "1",
      "assessmentNotes": []
    }
  ],
  "submissionId": 1231,
  "transactionId": "SAP00000MUeQwB1xB5a2f71g",
  "medicareClaimId": "W210223$",
  "timeReceived": "2021-02-23 08:59:56",
  "submissionType": "RECORD_ENCOUNTER",
  "medicareResponse": "AIR-I-1007",
  "medicareMessage": "All encounter(s) were successfully recorded.",
  "assessmentNotes": [],
  "status": "PROCESSED"
}

Headers:

Header	Value
Server	nginx/1.19.3
Date	Tue, 08 Jun 2021 04:49:28 GMT
Content-Type	application/json
Content-Length	823
Connection	keep-alive
Access-Control-Allow-Origin	*
Access-Control-Allow-Methods	GET, POST, OPTIONS

Record Immunisations #

IMPORTANT AIR UPDATE #

POST - Record an AIR Encounter #

POST - Record an AIR Encounter for a vaccine with routeOfAdministration #

POST - Record several AIR Encounters #

POST - Record an AIR Encounter using DoB and Medicare Card #

POST - Record an AIR Encounter using Medicare Card Details #

POST - Record an AIR Encounter using DoB and Address #

POST - Record an AIR Encounter using Last name, DoB and Medicare card #

POST - Record an AIR Encounter with vaccine serial number #

POST - Record an AIR Encounter with Immunizing Provider Number #

POST - Record an encounter using HI details #

POST - Record a vaccine with School ID #

POST - Record a vaccine given overseas #

POST - Record an encounter - handling errors #

PUT - Record an AIR Encounter with errors - CONFIRMATION STEP #

POST - Record an AIR Encounter for a new patient #

PUT - Record an AIR Encounter for a unfound patient - CONFIRMATION STEP #

`POST` - Record an AIR Encounter #

`POST` - Record an AIR Encounter for a vaccine with routeOfAdministration #

`POST` - Record several AIR Encounters #

`POST` - Record an AIR Encounter using DoB and Medicare Card #

`POST` - Record an AIR Encounter using Medicare Card Details #

`POST` - Record an AIR Encounter using DoB and Address #

`POST` - Record an AIR Encounter using Last name, DoB and Medicare card #

`POST` - Record an AIR Encounter with vaccine serial number #

`POST` - Record an AIR Encounter with Immunizing Provider Number #

`POST` - Record an encounter using HI details #

`POST` - Record a vaccine with School ID #

`POST` - Record a vaccine given overseas #

`POST` - Record an encounter - handling errors #

`PUT` - Record an AIR Encounter with errors - CONFIRMATION STEP #

`POST` - Record an AIR Encounter for a new patient #

`PUT` - Record an AIR Encounter for a unfound patient - CONFIRMATION STEP #