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

Allowable Natural Immunity

||View as Markdown|
GET
/AIR/v1/refdata/antigen/allowable/naturalImmunity
GET
/AIR/v1/refdata/antigen/allowable/naturalImmunity
$curl https://api.rebateright.com.au/AIR/v1/refdata/antigen/allowable/naturalImmunity \
> -H "x-api-key: <apiKey>"
200Allowable Natural Immunity Antigens
1{
2 "statusCode": "AIR-I-1100",
3 "codeType": "AIRIBU",
4 "message": "Your request was successfully processed.",
5 "antigens": [
6 {
7 "antigenCode": "HEP",
8 "startDate": "0001-01-01",
9 "endDate": "9999-09-09"
10 },
11 {
12 "antigenCode": "MEA",
13 "startDate": "0001-01-01",
14 "endDate": "9999-09-09"
15 },
16 {
17 "antigenCode": "MUM",
18 "startDate": "0001-01-01",
19 "endDate": "9999-09-09"
20 },
21 {
22 "antigenCode": "QAX",
23 "startDate": "0001-01-01",
24 "endDate": "9999-09-09"
25 },
26 {
27 "antigenCode": "RUB",
28 "startDate": "0001-01-01",
29 "endDate": "9999-09-09"
30 },
31 {
32 "antigenCode": "VAR",
33 "startDate": "0001-01-01",
34 "endDate": "9999-09-09"
35 }
36 ],
37 "correlationId": "urn:uuid:MDE00000000000000000000000"
38}

List the antigens for which natural immunity can be recorded via Record Natural Immunity. Currently: HEP, MEA, MUM, QAX, RUB, VAR.

Was this page helpful?
Previous

Allowable Medical Contraindication

Next

Claiming

Built with

Authentication

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

Response

OK
statusCodestring
codeTypestring
messagestring
antigenslist of objects
correlationIdstring