Skip to navigation
RebateRight APIAIRMedical Exemptions

Record Natural Immunity

View as Markdown
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’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

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.
immunityobjectRequired
informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
errorslist of objects or nullOptional
correlationIdstringOptional