Natural Immunity History | RebateRight

curl -X POST https://api.rebateright.com.au/AIR/v1/individual/natural-immunity/history \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "individualIdentifier": "wXrN7bKidsrEkh89yldqZRw99uzP6WZJfEgIe4PEaEQ1TyUZsqOSEnqCM0BvbRF-FoHdgZgtg4iynmUuQamZdgGPH8QDag8rwFax7MI0zBpBaQnsaznfCA==",
  "individualDateOfBirth": "17042012",
  "informationProvider": {
    "providerNumber": "T39126X"
  }
}'

{
  "statusCode": "AIR-I-1100",
  "codeType": "AIRIBU",
  "message": "Your request was successfully processed.",
  "naturalImmunityList": [
    {
      "disease": "HEP",
      "notificationDate": "14122021",
      "labTestDate": "14122021",
      "diagnosisDate": "14122021"
    },
    {
      "disease": "VAR",
      "notificationDate": "10032022",
      "labTestDate": "08032022",
      "diagnosisDate": ""
    },
    {
      "disease": "MUM",
      "notificationDate": "21032022",
      "labTestDate": "01022022",
      "diagnosisDate": "02032022"
    },
    {
      "disease": "MEA",
      "notificationDate": "14042022",
      "labTestDate": "11042022",
      "diagnosisDate": "14042022"
    },
    {
      "disease": "RUB",
      "notificationDate": "13102022",
      "labTestDate": "11102022",
      "diagnosisDate": "12102022"
    }
  ],
  "correlationId": "urn:uuid:MDE00000f456373cea204dba"
}

Which diseases is this person already immune to?

That is the question this endpoint answers: each recorded natural immunity, with its notification, test and diagnosis dates.

Retrieve the individual’s recorded natural immunities — diseases they’re assessed as immune to, with notification, lab test, and diagnosis dates.

Requires an individualIdentifier from a prior Identify Individual call. If naturalImmunityIndicator on that response is false, this endpoint returns success with no list field.

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

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

Top-level outcomes for this endpoint:

Code	Meaning
`AIR-I-1100`	Request was successfully processed. `naturalImmunityList` returned (omitted entirely when no records exist).
`AIR-E-1005`	Validation errors (e.g. `AIR-E-1061` invalid or expired identifier).
`AIR-E-1058`	Individual’s record cannot be viewed or updated.

Authentication

x-api-keystring

API Key authentication via header

x-minor-idstring

Your Minor ID is three uppercase letters followed by five digits, such as MDE00001. Send the Minor ID exactly as issued. A malformed value gets a 400 with “The Minor ID is not valid.” on every endpoint.

Request

This endpoint expects an object.

individualIdentifierstringRequired

Opaque token from a prior Identify Individual call.

individualDateOfBirthstringRequired

DDMMYYYY format. Must match the individual matched by individualIdentifier.

informationProviderobjectRequired

Response

statusCodestringOptional

codeTypestringOptional

messagestringOptional

naturalImmunityListlist of objectsOptional

Recorded natural immunities. The whole field is omitted when no records exist.

errorslist of objects or nullOptional

Field-level validation problems. See Validation codes.

correlationIdstringOptional

Unique request identifier.