Record Encounter | RebateRight

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

Modes

The endpoint accepts two request shapes against the same URL:

Add — the standard submission. Identify the individual, list the encounter(s), and submit.
Confirm — re-submit with the claimId from a previous response to accept pended episodes (when AIR returned warnings such as a dose adjustment) or to create a new individual that AIR couldn’t find on the first call (acceptAndConfirm: "Y").

Date format

Date fields (dateOfBirth, dateOfService) use DDMMYYYY with no separators (e.g. 18042016). This is different from the ISO YYYY-MM-DD used by Medicare and DVA endpoints.

Identifying the individual

Provide enough detail for AIR to match the individual. AIR returns AIR-W-1004 if it can’t match — resubmit with individual.acceptAndConfirm: "Y" and the personal details and address (no Medicare card or IHI) to create a new record.

Status Codes

Top-level outcomes for this endpoint:

Code	Meaning
`AIR-I-1007`	All encounter(s) successfully recorded.
`AIR-W-1004`	Individual not found. Resubmit with `acceptAndConfirm: "Y"` if the details are correct.
`AIR-W-1008`	Some encounter(s) not recorded. `claimDetails.encounters[]` shows which failed.
`AIR-E-1005`	Validation errors. See `errors[]`.
`AIR-E-1046`	Encounter-level errors — correct and resubmit, or remove the invalid encounter(s).

Encounter-level and episode-level codes (AIR-I-1000, AIR-W-1001, AIR-I-1002, AIR-I-1003, AIR-E-0102) appear in claimDetails.encounters[].information.code and claimDetails.encounters[].episodes[].information.code. See AIR Integration for the full list.

Record vaccinations to the Australian Immunisation Register (AIR). One request can carry up to 10 encounters; each encounter is a single visit and can hold up to five episodes (one per vaccine administered). For shared response patterns and the full status-code list, see [AIR Integration](/air). #### Modes The endpoint accepts two request shapes against the same URL: - **Add** — the standard submission. Identify the individual, list the encounter(s), and submit. - **Confirm** — re-submit with the `claimId` from a previous response to accept pended episodes (when AIR returned warnings such as a dose adjustment) or to create a new individual that AIR couldn't find on the first call (`acceptAndConfirm: "Y"`). #### Date format Date fields (`dateOfBirth`, `dateOfService`) use **DDMMYYYY** with no separators (e.g. `18042016`). This is different from the ISO `YYYY-MM-DD` used by Medicare and DVA endpoints. #### Identifying the individual Provide enough detail for AIR to match the individual. AIR returns `AIR-W-1004` if it can't match — resubmit with `individual.acceptAndConfirm: "Y"` and the personal details and address (no Medicare card or IHI) to create a new record. #### Status Codes Top-level outcomes for this endpoint: | Code | Meaning | |---|---| | `AIR-I-1007` | All encounter(s) successfully recorded. | | `AIR-W-1004` | Individual not found. Resubmit with `acceptAndConfirm: "Y"` if the details are correct. | | `AIR-W-1008` | Some encounter(s) not recorded. `claimDetails.encounters[]` shows which failed. | | `AIR-E-1005` | Validation errors. See `errors[]`. | | `AIR-E-1046` | Encounter-level errors — correct and resubmit, or remove the invalid encounter(s). | Encounter-level and episode-level codes (`AIR-I-1000`, `AIR-W-1001`, `AIR-I-1002`, `AIR-I-1003`, `AIR-E-0102`) appear in `claimDetails.encounters[].information.code` and `claimDetails.encounters[].episodes[].information.code`. See [AIR Integration](/air) for the full list.

Authentication

x-api-keystring

API Key authentication via header

x-minor-idstring

API Key authentication via header

Request

This endpoint expects an object.

informationProviderobjectRequired

encounterslist of objectsRequired

One or more encounters (visits). Up to 10 per request. Each can carry up to 5 episodes.

individualobjectOptional

The patient receiving the vaccinations. Required for the Add mode; not required when the request is a Confirm with claimId.

claimIdstringOptional

Set this on a Confirm request to the claimId returned by the initial Add response. Omit on Add requests.

Response

statusCodestring

AIR status code. See Status codes.

codeTypestring

Code-type category. AIRIBU on success, AIRWBU on warnings, AIREBU on validation errors.

messagestring

Status message from AIR.

errorslist of objects

Field-level validation problems. Present when statusCode is AIR-E-1005. See Validation codes.

claimDetailsobject

Claim summary. Present on success (AIR-I-1007) or partial success (AIR-W-1008, AIR-E-1046). null on validation failures and AIR-W-1004.

correlationIdstring

Unique request identifier. Include in support tickets so we can trace the request.