For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • Home
  • API Reference
        • GETVaccines
        • GETVaccine by Code
        • GETVaccine Categories
        • GETVaccine Funding Types
        • GETVaccine Types
        • GETRoutes of Administration
        • GETAntigens
        • GETAntigen by Code
        • GETCountries
        • GETGenders
        • GETAntenatal Age Range
        • GETMandatory Vaccine Batch
        • GETMandatory Route of Administration
        • GETMandatory Vaccine Type
        • GETMandatory Antenatal Indicator
        • GETAllowable Medical Contraindication
        • GETAllowable Natural Immunity
  • Guides
    • Minor ID Setup
    • Architecture
    • Security & Governance
    • PRODA
    • DVA Integration
    • AIR Integration
    • Integration test data
    • Troubleshooting
LogoLogo
API ReferenceAIRReference Data

Vaccine Types

||View as Markdown|
GET
/AIR/v1/refdata/vaccineType
GET
/AIR/v1/refdata/vaccineType
$curl https://api.rebateright.com.au/AIR/v1/refdata/vaccineType \
>     -H "x-api-key: <apiKey>"
200All Vaccine Types
1{
2  "statusCode": "AIR-I-1100",
3  "codeType": "AIRIBU",
4  "message": "Your request was successfully processed.",
5  "vaccineTypes": [
6    {
7      "vaccineTypeCode": "NIP",
8      "vaccineTypeDescription": "NIP/Commonwealth"
9    },
10    {
11      "vaccineTypeCode": "OTH",
12      "vaccineTypeDescription": "Other"
13    }
14  ],
15  "correlationId": "urn:uuid:MDE000005638bcd246ae464c"
16}

List the AIR vaccine type values used on encounter episodes (NIP, OTH).

Was this page helpful?
Previous

Vaccine Funding Types

Next

Routes of Administration

Built with

Authentication

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

Response

OK
statusCodestring
codeTypestring
messagestring
vaccineTypeslist of objects
correlationIdstring