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
        • POSTRecord Medical Contraindication
        • POSTRecord Natural Immunity
  • Guides
    • Minor ID Setup
    • Architecture
    • Security & Governance
    • PRODA
    • DVA Integration
    • AIR Integration
    • Integration test data
    • Troubleshooting
LogoLogo
API ReferenceAIRMedical Exemptions

Record Natural Immunity

||View as Markdown|
POST
/AIR/v1/individual/natural-immunity/record
POST
/AIR/v1/individual/natural-immunity/record
$curl -X POST https://api.rebateright.com.au/AIR/v1/individual/natural-immunity/record \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "individualIdentifier": "wXrN7bKidsrEkh89yldqZb7ZN-BlMXQXfEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
>  "individualDateOfBirth": "18042016",
>  "immunity": {
>    "disease": "MUM",
>    "labTestDate": "15042024",
>    "diagnosisDate": "15042024"
>  },
>  "informationProvider": {
>    "providerNumber": "2447781L"
>  }
>}'
200Success
1{
2  "statusCode": "AIR-I-1100",
3  "codeType": "AIRIBU",
4  "message": "Your request was successfully processed.",
5  "correlationId": "urn:uuid:MDE00000e023ac2bd18f4644"
6}
Record a natural immunity for an individual — a disease they've contracted and are now immune to. Assessed only by a general practitioner, paediatrician, public health physician, infectious diseases physician, or clinical immunologist. Requires an `individualIdentifier` from a prior [Identify Individual](/api-reference/air/individual-details/identify-individual) call. The information provider must be authorised for `NATIMM` (check via [Authorisation](/api-reference/air/authorisation/authorisation)) — unauthorised providers return `AIR-E-1063`. For shared response patterns and the full status-code list, see [AIR Integration](/air). #### Eligible diseases Per the AIR spec, natural immunity can be recorded for: `HEP` (Hepatitis), `MEA` (Measles), `MUM` (Mumps), `QAX` (Q fever), `RUB` (Rubella), `VAR` (Varicella). #### Date format Date fields use **DDMMYYYY** with no separators. #### Status Codes | Code | Meaning | |---|---| | `AIR-I-1100` | Immunity recorded. | | `AIR-E-1005` | Validation errors. Common: `AIR-E-1063` provider not authorised, `AIR-E-1049` immunity for this disease already recorded. |
Was this page helpful?
Previous

Record Medical Contraindication

Next

Vaccines

Built with

Record a natural immunity for an individual — a disease they’ve contracted and are now immune to. Assessed only by a general practitioner, paediatrician, public health physician, infectious diseases physician, or clinical immunologist.

Requires an individualIdentifier from a prior Identify Individual call. The information provider must be authorised for NATIMM (check via Authorisation) — unauthorised providers return AIR-E-1063.

For shared response patterns and the full status-code list, see AIR Integration.

Eligible diseases

Per the AIR spec, natural immunity can be recorded for: HEP (Hepatitis), MEA (Measles), MUM (Mumps), QAX (Q fever), RUB (Rubella), VAR (Varicella).

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

CodeMeaning
AIR-I-1100Immunity recorded.
AIR-E-1005Validation errors. Common: AIR-E-1063 provider not authorised, AIR-E-1049 immunity for this disease already recorded.

Authentication

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

Request

This endpoint expects an object.
individualIdentifierstringRequired
Opaque token from a prior Identify Individual call.
individualDateOfBirthstringRequired
DDMMYYYY format.
immunityobjectRequired
informationProviderobjectRequired

Response

OK
statusCodestring
codeTypestring
messagestring
errorslist of objects or null
correlationIdstring