Record Natural Immunity | RebateRight

curl -X POST https://test-api.rebateright.com.au/AIR/v1/individual/natural-immunity/record \
     -H "x-minor-id: <minorId>" \
     -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"
  }
}'

How do I record that a person is immune to a disease they have had?

Through this endpoint, for the diseases the Australian Immunisation Register (AIR) accepts, listed below.

Record a natural immunity for an individual: a disease they have had and are now immune to. The immunity must be assessed by a general practitioner, a general practice registrar on an approved 3GA training placement, a paediatrician, a public health physician, an infectious diseases physician or a clinical immunologist.

Send the individualIdentifier that Identify Individual returned. The information provider must be authorised for NATIMM, which Authorisation shows. A provider without that authorisation receives AIR-E-1063.

For shared response patterns and the full status-code list, see AIR Integration. For what your software must show, see Display requirements.

Eligible diseases

Take the valid diseases from Allowable Natural Immunity when your software builds its pick list.

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

Code	Meaning
`AIR-I-1100`	Immunity recorded.
`AIR-E-1005`	Validation errors, most often `AIR-E-1063` (provider not authorised), `AIR-E-1049` (an active immunity for this disease is already recorded) or `AIR-E-1069` (neither `labTestDate` nor `diagnosisDate` sent).

Authentication

x-api-keystring

API Key authentication via header

x-minor-idstring

Your Minor ID is 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Request

This endpoint expects an object.

individualIdentifierstringRequired

Opaque token that Identify Individual returned.

individualDateOfBirthstringRequired

DDMMYYYY format.

immunityobjectRequired

informationProviderobjectRequired

Response

statusCodestringOptional

codeTypestringOptional

messagestringOptional

errorslist of objects or nullOptional

correlationIdstringOptional