Fetch Individual Details #

The AIR Individual Details functions allow authorised and recognised vaccination providers to:

Search for an individual on the AIR using a variety of identifiers
Retrieve an individual’s immunisation history as record on the AIR
Request an individual’s immunisation history statement as a PDF
Retrieve an individual’s medical contraindication and natural immunity history as recorded on the AIR
Update certain individual details
Update editable immunisations already recorded on the AIR

The Claiming.com.au API gives you simple yet powerful access to these features!

The request must contain sufficient patient data to uniquely identify them. The minimum requirements for a match are all of the parameters in any one of the following groups, in order of preference.

patient.medicare.number & patient.medicare.ref - names are ignored for the match, check the name and DoB in the response and display any differences.
patient.name.first, patient.name.family, patient.dateOfBirth and patient.address.postCode - used where Medicare Card is unknown.
patient.medicare.number, patient.dateOfBirth and patient.name.family - where IRN is unknown. Use with care, the match would not be unique for twins.

Important Note: The data from the response must be visible to the end user:

Vaccine Due List - Where there are no vaccines due in the response the following message must be displayed to the end user ‘There are no vaccinations due for this individual’. Where there are vaccines they must be displayed in order of the earliest due date (or have the ability for the end user to sort/filter).
Encounter History - Where there are no vaccines recorded in the history the following message must be displayed to the end user ‘No immunisation history is recorded for this individual’. Where there are records they must be displayed in order of the most recent date of service (or have the ability for the end user to sort/filter) and must display the following:
Date (dateOfService)
Vaccine/Brand (full name of the vaccineCode)
Dose (vaccineDose)
Status (status)
Reason Code (if applicable)
Message text (if applicable)

If any of the following indicators for an individual have a value of ‘true’ then display them to the end user as an alert or icon using the wording below, and where additional information for exemptions is present in the response, return that as a list that can be sorted and/or filtered.

catchupDate display as “Planned Catch Up” and show the date
medContraindicationIndicator display as “Medical Contraindication”
naturalImmuniyIndicator display as “Natural Immunity”
vaccineTrialIndicator display as “Vaccine Trial”
actionRequiredIndicator display as “Action Required”
additionalVaccineIndicator “display as “Special Risk Group”

Where Medical Contraindications exemption data are in the response, they must be displayed in start date ascending order (or have the ability for the end user to sort/filter). vaccineCode must be displayed as the full Vaccine/Brand name. Where there are no active Medical Contraindications the following message must be displayed to the end user ‘No active medical contraindication is recorded for this individual’

Where Natural Immunity exemptions are returend they must be displayed in notification date ascending order (or have the ability for the end user to sort/filter). disease must be displayed as the Antigen code description. Where there are no Natural Immunity exemptions the following message must be displayed to the end user ‘No active natural immunity is recorded for this individual’

Where Vaccine Trial data are returned they must be displayed in start date ascending order (or have the ability for the end user to sort/filter). antigenCode must be displayed as the Antigen code description. Where there are no active Vaccine Trials the following message must be displayed to the end user ‘No active vaccine trial is recorded for this individual’

Note: An endDateCode is returned to indicate that there may be certain restrictions on the viewing of an individual’s details and also that there may be limitations on what a provider can record in the AIR system against this particular individual. The endDateCode does not need to be displayed to the end user. Instead display the relevant description to the end user when endDateCode equals

ALL - “The individual’s record may not be active but no restrictions are placed on the viewing or updating of their record. (AIR-W-1062)”
LIMITED - “Individual details cannot be viewed, however some updates are still allowable. (AIR-W-1059)”
NONE - “Individual details cannot be viewed and their record cannot be updated. (AIR-E-1058)”

`POST` - Fetch immunisation details with Medicare Card #

To fetch immunisation details, the minimum requirement to identify an individual is a patient.medicare.number and patient.medicare.ref (Individual Reference Number or IRN).

The response will return

Confirmatory information about the patient, such as their name, address and date of birth
Any indicators that have been set in the AIR record
additionalVaccineIndicator - indicates if the individual is flagged in AIR as High Risk and Additional Vaccines Required (AVR)
indigenousStatusIndicator - indicates whether the individual identifies as indigenous or non-indigenous
medContraindicationIndicator - indicates if the individual has any medical contraindication recorded on the AIR
naturalImmunityIndicator - indicates if the individual has any natural immunity recorded on the AIR
vaccineTrialIndicator - indicates if the individual has any vaccine trial recorded on the AIR
actionRequiredIndicator - indicates that the individual has encounters that require correction. EG if there are encounters for this individual that are editable (created by this provider) and that are in an invalid status (partially processed or clarification required)
catchupDate if applicable, the date the individual is required to be up-to-date with any vaccinations due for Family Assistance purposes
endDateCode if set will indicate that the individual has restrictions placed on their record in the AIR system due to their end date reason
immunisationDetails including
dueList which is a list of any vaccines that may be becoming due for administration
immunisations that have been given to this individual, organised using AIR terminolgy into
- encounters which each represent an occasion on a specific day, and thus have dateOfService, dateSubmitted, claimId (used as a reference if the record needs updating), claimSeqNum (claim sequence number) and optionally schoolId
- episodes which are one or more vaccines given during that encounter, which have vaccineCode, vaccineDose, vaccineBatch, vaccineSerialNumber and supporting information about the episode; an editable flag to indicate if the episode can be updated; and an actionRequiredIndicator
vaccineTrialHistory with data on any vaccine trials this individual has been enrolled in
naturalImmunityHistory with data on any exemptions on the basis of demonstrated natural history
medicalContraindicationHistory with data on any exemptions on the basis of medical contraindications
a transactionId which is the reference for this request

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

Headers

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

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Fetch immunisation details with Medicare Card",
    "provider": {
        "information": "2433421X"
    },
    "patient": {
        "medicare": {
            "number": "2953701051",
            "ref": 2
        }
    }
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/individual?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Fetch immunisation details with Medicare Card",
    "provider": {
        "information": "2433421X"
    },
    "patient": {
        "medicare": {
            "number": "2953701051",
            "ref": 2
        }
    }
}'

Example Response:

Body:

{
  "_TestCase": "Fetch immunisation details with Medicare Card",
  "transactionId": "SAP00000zH5vjpfSeTfXMv8F",
  "actionRequiredIndicator": false,
  "additionalVaccineIndicator": false,
  "indigenousStatusIndicator": true,
  "medContraindicationIndicator": true,
  "naturalImmunityIndicator": true,
  "vaccineTrialIndicator": true,
  "catchupDate": "2021-03-29",
  "patient": {
    "address": {
      "line1": "1-3 WAYMAN PL",
      "line2": "",
      "locality": "MERRYLANDS",
      "postcode": "2160"
    },
    "medicare": {
      "number": "2953701051",
      "ref": 2
    },
    "dateOfBirth": "2012-04-17",
    "name": {
      "first": "KOBY",
      "family": "EDWARDS"
    }
  },
  "immunisationDetails": {
    "dueList": [
      {
        "disease": "Measles",
        "vaccineDose": "2",
        "dueDate": "2018-05-01"
      }
    ],
    "encounters": [
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "2254",
            "vaccineCode": "MMRCSL",
            "vaccineDose": "6",
            "vaccineSerialNumber": "123456",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-02-23",
        "dateSubmitted": "2021-02-26",
        "schoolId": "40001",
        "claimSeqNum": 2,
        "immEncSeqNum": 1,
        "claimId": "W210226$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "2254",
            "vaccineCode": "NIMRIX",
            "vaccineDose": "5",
            "vaccineSerialNumber": "123456",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-02-23",
        "dateSubmitted": "2021-02-26",
        "schoolId": "40001",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "W210226$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "2254",
            "vaccineCode": "COMIRN",
            "vaccineDose": "5",
            "vaccineSerialNumber": "123456",
            "information": {
              "status": "INVALID",
              "code": "AIR-W-0100",
              "text": "Antigen has been administered under the minimum required age"
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-02-23",
        "dateSubmitted": "2021-02-23",
        "schoolId": "40001",
        "claimSeqNum": 3,
        "immEncSeqNum": 1,
        "claimId": "W210223$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "HAVAD",
            "vaccineDose": "1",
            "vaccineSerialNumber": "12345",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-02-08",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "GNVAR",
            "vaccineDose": "1",
            "vaccineSerialNumber": "1",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-02-03",
        "dateSubmitted": "2021-02-24",
        "schoolId": "",
        "claimSeqNum": 6,
        "immEncSeqNum": 1,
        "claimId": "W210224$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "OPV",
            "vaccineDose": "1",
            "vaccineSerialNumber": "1",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-02-01",
        "dateSubmitted": "2021-02-24",
        "schoolId": "",
        "claimSeqNum": 3,
        "immEncSeqNum": 1,
        "claimId": "W210224$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "GNTET",
            "vaccineDose": "1",
            "vaccineSerialNumber": "123",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          },
          {
            "id": 2,
            "vaccineBatch": "1",
            "vaccineCode": "NEISVC",
            "vaccineDose": "1",
            "vaccineSerialNumber": "12",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-01-26",
        "dateSubmitted": "2021-02-24",
        "schoolId": "",
        "claimSeqNum": 5,
        "immEncSeqNum": 1,
        "claimId": "W210224$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "STAMRL",
            "vaccineDose": "1",
            "vaccineSerialNumber": "1",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-01-15",
        "dateSubmitted": "2021-02-24",
        "schoolId": "",
        "claimSeqNum": 4,
        "immEncSeqNum": 1,
        "claimId": "W210224$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "MENGO",
            "vaccineDose": "1",
            "vaccineSerialNumber": "1",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-01-01",
        "dateSubmitted": "2021-02-23",
        "schoolId": "",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "W210223$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "FQUAD",
            "vaccineDose": "V",
            "vaccineSerialNumber": "123456789",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-09-01",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 3,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "MMR",
            "vaccineDose": "1",
            "vaccineSerialNumber": "",
            "information": {
              "status": "INVALID",
              "code": "AIR-W-0102",
              "text": "Duplicate antigen dose"
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-09-01",
        "dateSubmitted": "2020-09-25",
        "schoolId": "",
        "claimSeqNum": 2,
        "immEncSeqNum": 1,
        "claimId": "W200925$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "ABCD",
            "vaccineDose": "1",
            "vaccineSerialNumber": "",
            "information": {
              "status": "INVALID",
              "code": "AIR-W-0032",
              "text": "The vaccine and/or dose number administered not supplied"
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-09-01",
        "dateSubmitted": "2020-09-28",
        "schoolId": "",
        "claimSeqNum": 6,
        "immEncSeqNum": 1,
        "claimId": "W200928$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "GNMEA",
            "vaccineDose": "1",
            "vaccineSerialNumber": "223344",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-04-01",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 2,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "1",
            "vaccineCode": "FLUVAX",
            "vaccineDose": "1",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-04-01",
        "dateSubmitted": "2020-09-25",
        "schoolId": "",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "W200925$"
      }
    ]
  },
  "vaccineTrialHistory": [
    {
      "antigenCode": "CHL",
      "dose": "1",
      "endDate": "",
      "startDate": "2020-09-29"
    },
    {
      "antigenCode": "DIP",
      "dose": "2",
      "endDate": "",
      "startDate": "2021-01-04"
    }
  ],
  "naturalImmunityHistory": [
    {
      "disease": "MUM",
      "notificationDate": "2020-09-24",
      "labTestDate": "2020-09-24",
      "diagnosisDate": ""
    },
    {
      "disease": "HEP",
      "notificationDate": "2020-09-24",
      "labTestDate": "2020-09-24",
      "diagnosisDate": ""
    },
    {
      "disease": "VAR",
      "notificationDate": "2020-09-24",
      "labTestDate": "2020-09-24",
      "diagnosisDate": "2020-09-23"
    },
    {
      "disease": "RUB",
      "notificationDate": "2020-10-13",
      "labTestDate": "2020-10-12",
      "diagnosisDate": ""
    }
  ],
  "medicalContraindicationHistory": [
    {
      "vaccineCode": "BOOST",
      "typeCode": "P",
      "startDate": "2020-09-24",
      "endDate": null,
      "reason": "I",
      "anaphylaxisDate": null,
      "vaccineBrandName": "Boostrix"
    },
    {
      "vaccineCode": "BOIPV",
      "typeCode": "P",
      "startDate": "2020-09-24",
      "endDate": null,
      "reason": "A",
      "anaphylaxisDate": "2020-09-23",
      "vaccineBrandName": "Boostrix-IPV"
    },
    {
      "vaccineCode": "ADT",
      "typeCode": "P",
      "startDate": "2020-10-14",
      "endDate": null,
      "reason": "I",
      "anaphylaxisDate": null,
      "vaccineBrandName": "ADT Booster"
    },
    {
      "vaccineCode": "HPV",
      "typeCode": "P",
      "startDate": "2021-02-23",
      "endDate": null,
      "reason": "A",
      "anaphylaxisDate": "2020-11-30",
      "vaccineBrandName": "Gardasil"
    },
    {
      "vaccineCode": "HPV",
      "typeCode": "T",
      "startDate": "2021-02-26",
      "endDate": "2021-12-12",
      "reason": "P",
      "anaphylaxisDate": null,
      "vaccineBrandName": "Gardasil"
    },
    {
      "vaccineCode": "BOOST",
      "typeCode": "P",
      "startDate": "2021-02-27",
      "endDate": null,
      "reason": "I",
      "anaphylaxisDate": null,
      "vaccineBrandName": "Boostrix"
    },
    {
      "vaccineCode": "BOOST",
      "typeCode": "P",
      "startDate": "2021-02-27",
      "endDate": null,
      "reason": "I",
      "anaphylaxisDate": null,
      "vaccineBrandName": "Boostrix"
    }
  ]
}

Headers:

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

`POST` - Fetch immunisation details using DoB and Address #

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/individual?location={{location_id}}

Headers

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

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Fetch immunisation details - DoB and Address",
    "patient": {
        "dateOfBirth": "1976-09-08",
        "name": {
            "first": "Isabelle",
            "family": "ASHLEY"
        },
        "address": {
            "postcode": "2752"
        }
    },
    "provider": {
        "information": "2433421X"
    }
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/individual?location=25' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Fetch immuisation details - DoB and Address",
    "patient": {
        "dateOfBirth": "1976-09-08",
        "name": {
            "first": "Isabelle",
            "family": "ASHLEY"
        },
        "address": {
            "postcode": "2752"
        }
    },
    "provider": {
        "information": "2433421X"
    },
    "fetchAdditionalData": {
        "medicalContraindicationHistory": true,
        "immunisationHistory": true,
        "naturalImmunityHistory": true,
        "vaccineTrialHistory": true
    }
}'

Example Response:

Body:

{
  "catchupDate": "",
  "additionalVaccineIndicator": false,
  "medContraindicationIndicator": false,
  "naturalImmunityIndicator": false,
  "vaccineTrialIndicator": false,
  "actionRequiredIndicator": false,
  "patient": {
    "address": {
      "line1": "47 BLAKE RD",
      "line2": "",
      "locality": "SILVERDALE",
      "postcode": "2752"
    },
    "dateOfBirth": "1976-09-08",
    "name": {
      "first": "ISABELLE",
      "family": "ASHLEY"
    }
  },
  "transactionId": "SAP00000HND5WzW3TrlZ6XWP",
  "immunisationDetails": {
    "encounters": [
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2021-02-21",
        "dateSubmitted": "2021-02-21",
        "schoolId": "",
        "claimSeqNum": 5,
        "immEncSeqNum": 1,
        "claimId": "W210221$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2020-05-29",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 6,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 2,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2020-05-28",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 11,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "PROQAD",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2020-05-28",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 4,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "FLUVAX",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 8,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HPV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 7,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "CDT",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 3,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      }
    ]
  },
  "messages": [
    "There are no vaccinations due for this individual",
    "No active vaccine trial is recorded for this individual",
    "No active natural immunity is recorded for this individual",
    "No active medical contraindication is recorded for this individual"
  ],
  "vaccineTrialHistory": [],
  "naturalImmunityHistory": [],
  "medicalContraindicationHistory": [],
  "_TestCase": "Fetch immuisation details - DoB and Address",
  "indigenousStatusIndicator": false
}

Headers:

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

`POST` - Fetch immunisation details 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/individual?location={{location_id}}

Headers

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

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Fetch immunisation details - Last Name, DoB and Medicare card",
    "patient": {
        "medicare": {
            "number": "2953755261"
        },
        "dateOfBirth": "1976-09-08",
        "name": {
            "family": "ASHLEY"
        }
    },
    "provider": {
        "information": "2433421X"
    }
}

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"
      },
      "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` - Fetch immunisation details with full details #

If you provde more than the minimum requirements to identify an individual the API will use the most appropriate combination, so there’s no harm in putting more idenitfying information.

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

Headers

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

Params

Param	value
location	{{location_id}}

Body

{
    "_TestCase": "Fetch immunisation details with full details",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        },
        "dateOfBirth": "1976-09-08",
        "name": {
            "first": "Isabelle",
            "family": "ASHLEY"
        },
        "address": {
            "postcode": "2756"
        }
    },
    "provider": {
        "information": "2433411Y"
    }
}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/individual?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Fetch immunisation details with full details",
    "patient": {
        "medicare": {
            "number": "2953755261",
            "ref": 1
        },
        "dateOfBirth": "1976-09-08",
        "name": {
            "first": "Isabelle",
            "family": "ASHLEY"
        },
        "address": {
            "postcode": "2756"
        }
    },
    "provider": {
        "information": "2433411Y"
    },
    "fetchAdditionalData": {
        "medicalContraindicationHistory": true,
        "immunisationHistory": true,
        "naturalImmunityHistory": true,
        "vaccineTrialHistory": true
    }
}'

Example Response:

Body:

{
  "catchupDate": "",
  "additionalVaccineIndicator": false,
  "medContraindicationIndicator": false,
  "naturalImmunityIndicator": false,
  "vaccineTrialIndicator": false,
  "actionRequiredIndicator": false,
  "patient": {
    "address": {
      "line1": "47 BLAKE RD",
      "line2": "",
      "locality": "SILVERDALE",
      "postcode": "2752"
    },
    "medicare": {
      "number": "2953755261",
      "ref": 1
    },
    "dateOfBirth": "1976-09-08",
    "name": {
      "first": "ISABELLE",
      "family": "ASHLEY"
    }
  },
  "transactionId": "SAP000004ZZaysJAUbSTXXJN",
  "immunisationDetails": {
    "encounters": [
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": true,
            "actionRequiredIndicator": false
          }
        ],
        "editable": true,
        "dateOfService": "2021-02-21",
        "dateSubmitted": "2021-02-21",
        "schoolId": "",
        "claimSeqNum": 5,
        "immEncSeqNum": 1,
        "claimId": "W210221$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2020-05-29",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 6,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 2,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2020-05-28",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 11,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "PROQAD",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2020-05-28",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 4,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "FLUVAX",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 8,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HPV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 7,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "CDT",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": true,
            "actionRequiredIndicator": false
          }
        ],
        "editable": true,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 1,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      },
      {
        "episodes": [
          {
            "id": 1,
            "vaccineBatch": "A12341234",
            "vaccineCode": "HBV",
            "vaccineDose": "V",
            "vaccineSerialNumber": "",
            "information": {
              "status": "VALID",
              "code": null,
              "text": null
            },
            "editable": false,
            "actionRequiredIndicator": false
          }
        ],
        "editable": false,
        "dateOfService": "2018-10-14",
        "dateSubmitted": "2021-02-22",
        "schoolId": "",
        "claimSeqNum": 3,
        "immEncSeqNum": 1,
        "claimId": "W210222$"
      }
    ]
  },
  "messages": [
    "There are no vaccinations due for this individual",
    "No active vaccine trial is recorded for this individual",
    "No active natural immunity is recorded for this individual",
    "No active medical contraindication is recorded for this individual"
  ],
  "vaccineTrialHistory": [],
  "naturalImmunityHistory": [],
  "medicalContraindicationHistory": [],
  "_TestCase": "Fetch immunisation details with full details",
  "indigenousStatusIndicator": false
}

Headers:

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

`POST` - Handling the “Individual not found” response #

When an attempt to fetch immunisation individual details returns an Individual not found error message this may mean:

there is an error in the details you have entered, check them or try with alternate information such as name, date of birth and postcode
if it still fails, the individual may not be known to AIR. In these circumstances you will be receive a response requiring a confirmatory step. See aboce under Record Immunisations
at times, usually overnight, the AIR infrastructure needed to identify indivuduals may not be available. In this case, you will need to wait and try again later.

See the errors element of the response for details.

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

Headers

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

Body

{
    "_TestCase": "Handling the 'Individual not found' response",
    "provider": {
        "information": "2433421X"
    },
    "patient": {
        "medicare": {
            "number": "3951149821",
            "ref": 1
        }
    }
}

Params

Param	value
location	{{location_id}}

Example Request:

curl --location 'https://sandbox.claiming.com.au/v2/air/individual?location=25' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Fetch immunisation details with Medicare Card",
    "provider": {
        "information": "2433421X"
    },
    "patient": {
        "medicare": {
            "number": "2953701051",
            "ref": 2
        }
    }
}'

Example Response:

Body:

{
  "status": "INVALID",
  "errors": [
    {
      "code": "AIR-E-1005",
      "message": "The request contains validation errors."
    },
    {
      "code": "AIR-E-1035",
      "message": "Individual not found."
    }
  ]
}

Headers:

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

Fetch Individual Details #

POST - Fetch immunisation details with Medicare Card #

POST - Fetch immunisation details using DoB and Address #

POST - Fetch immunisation details using Last name, DoB and Medicare card #

POST - Fetch immunisation details with full details #

POST - Handling the “Individual not found” response #

`POST` - Fetch immunisation details with Medicare Card #

`POST` - Fetch immunisation details using DoB and Address #

`POST` - Fetch immunisation details using Last name, DoB and Medicare card #

`POST` - Fetch immunisation details with full details #

`POST` - Handling the “Individual not found” response #