Update Individual Details

Update Individual Details #

You can use the API to update

  • vaccine encounter details, but only by the provider who initially recorded the vaccination, and only if that encounter and episode are marked as editable in the vaccination history
  • whether or not the individual is in a High Risk group
  • whether or not the individual identifies as Aboriginal or Torres Strait islander

Future releases of the AIR functionality may add additional features, and these will be added to the Claiming.com.au API as they become available.

POST - Add or remove the Additional Vaccine indicator #

The Additional Vaccines Required Indicator is an indicator for an individual who may require further follow up. Individuals may require additional vaccines as per the Australian Immunisation Handbook for special risk groups. For example, if they are:

  • Indigenous
  • Managing a chronic health condition
  • A low birth weight
  • Preterm babies

You can set or clear this indicator with the recordAdditionalData.additionalVaccineIndicator. Making a request to the air/individual endpoint with additionalVaccineIndicator set to true will add the indicator, while setting it to false will clear the indicator. Any provider can remove the Additional Vaccine indicator, even if they are not the provider who added it on the individual’s record.

Note: When setting or clearing the Additional Vaccine Indicator, display the text ‘Use this indicator for individuals who may require additional vaccines. Consult the Australian Immunisation Handbook for advice and recommendations when vaccinating special risk groups. By adding or removing this indicator, you acknowledge the individual has given consent to update their record.’

Any additional text and acknowledgements in the messages element must be displayed to the user.

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

Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Params

Paramvalue
location{{location_id}}

Body

{
    "_TestCase": "Add or remove the Additional Vaccine indicator",
    "patient": {
        "dateOfBirth": "2012-04-17",
        "name": {
            "family": "Edwards"
        },
        "medicare": {
            "number": "2953701051",
            "ref": 2
        }
    },
    "provider": {
        "information": "T45718B"
    },
    "recordAdditionalData": {
        "additionalVaccineIndicator": true
    }
}

Example Request:

curl --location -g 'https://sandbox.claiming.com.au/v2/air/individual?auth_group={{auth_group}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Add or remove the Additional Vaccine indicator",
    "patient": {
        "dateOfBirth": "2012-04-17",
        "name": {
            "family": "Edwards"
        },
        "medicare": {
            "number": "2953701051",
            "ref": 2
        }
    },
    "provider": {
        "information": "T45718B"
    },
    "recordAdditionalData": {
        "additionalVaccineIndicator": true
    }
}'

Example Response:

Body:

{
  "catchupDate": "2021-03-29",
  "additionalVaccineIndicator": true,
  "medContraindicationIndicator": true,
  "naturalImmunityIndicator": true,
  "vaccineTrialIndicator": true,
  "actionRequiredIndicator": false,
  "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"
    }
  },
  "transactionId": "SAP00000ZVLE3OTgwLdhRLsY",
  "status": "SUCCESS",
  "messages": [
    "Consult the Australian Immunisation Handbook for advice and recommendations when vaccinating special risk groups. By adding or removing this indicator, you acknowledge the individual has given consent to update their record."
  ],
  "_TestCase": "Add or remove the Additional Vaccine indicator",
  "indigenousStatusIndicator": false
}

Headers:

HeaderValue
Servernginx/1.19.3
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length846
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS

POST - Add or remove the Indigenous Status indicator #

Improving the health of Aboriginal and Torres Strait Islander peoples is a national priority. The National Immunisation Program (NIP) for all Aboriginal and Torres Strait Islander people provides additional vaccines to help improve the health of Indigenous people, and close the gap between Indigenous and non-Indigenous people in health and life expectancy. For more information, see this link to the National Immunisation Program schedule

To identify Indigenous people who may require additional vaccines, vaccination providers can record Indigenous status directly on the AIR and it will not be over-ridden by their status recorded by Medicare. AIR Indigenous status for the purposes of vaccination will not be recorded on any other government database and it does not need to be the same as Medicare. Recording an Indigenous status on the AIR helps vaccination providers to identify and give the clinically correct vaccination schedule. Vaccination providers should seek consent from the person at the time of a vaccination encounter before recording their Indigenous status on the AIR.

You can set or clear this indicator with the recordAdditionalData.indigenousStatusIndicator. Making a request to the air/individual endpoint with indigenousStatusIndicator set to true will add the indicator, while setting it to false will clear the indicator. Any provider can remove the Indigenous Status indicator, even if they are not the provider who added it on the individual’s record.

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

Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer {{oauth_token}}

Params

Paramvalue
location{{location_id}}

Body

{
    "_TestCase": "Add the Indigenous Status indicator",
    "patient": {
        "dateOfBirth": "2012-04-17",
        "name": {
            "family": "Edwards"
        },
        "medicare": {
            "number": "2953701051",
            "ref": 2
        }
    },
    "provider": {
        "information": "T45718B"
    },
    "recordAdditionalData": {
        "indigenousStatusIndicator": true
    }
}

Example Request:

curl --location -g 'https://sandbox.claiming.com.au/v2/air/individual?auth_group={{auth_group}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
    "_TestCase": "Add the Indigenous Status indicator",
    "patient": {
        "dateOfBirth": "2012-04-17",
        "name": {
            "family": "Edwards"
        },
        "medicare": {
            "number": "2953701051",
            "ref": 2
        }
    },
    "provider": {
        "information": "T45718B"
    },
    "recordAdditionalData": {
        "indigenousStatusIndicator": true
    }
}'

Example Response:

Body:

{
  "catchupDate": "2021-03-29",
  "additionalVaccineIndicator": true,
  "medContraindicationIndicator": true,
  "naturalImmunityIndicator": true,
  "vaccineTrialIndicator": true,
  "actionRequiredIndicator": false,
  "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"
    }
  },
  "transactionId": "SAP00000rwsvACvbPCVx9MfI",
  "status": "SUCCESS",
  "_TestCase": "Add the Indigenous Status indicator",
  "indigenousStatusIndicator": true
}

Headers:

HeaderValue
Servernginx/1.19.3
DateTue, 08 Jun 2021 04:49:28 GMT
Content-Typeapplication/json
Content-Length592
Connectionkeep-alive
Access-Control-Allow-Origin*
Access-Control-Allow-MethodsGET, POST, OPTIONS