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
        • POSTIdentify Individual
        • POSTImmunisation History Details
        • POSTMedical Contraindication History
        • POSTNatural Immunity History
        • POSTVaccine Trial History
        • POSTAdd Additional Vaccine Indicator
        • POSTRemove Additional Vaccine Indicator
        • POSTIndigenous Status Update
        • POSTImmunisation History Statement
        • POSTUpdate Encounter
  • Guides
    • Minor ID Setup
    • Architecture
    • Security & Governance
    • PRODA
    • DVA Integration
    • AIR Integration
    • Integration test data
    • Troubleshooting
LogoLogo
API ReferenceAIRIndividual Details

Update Encounter

||View as Markdown|
POST
/AIR/v1.3/encounter/update
POST
/AIR/v1.3/encounter/update
$curl -X POST https://api.rebateright.com.au/AIR/v1.3/encounter/update \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "individualIdentifier": "wXrN7bKidsrIHzwqkDkGJHDOYBHbiH_3fEgIe4PEaESYj0qNDFRSdnqCM0BvbRF-9maImeb7tXpSC50uqA-T_wGPH8QDag8rTHC-N11jTan2OY_92X9U6Q==",
>  "individualDateOfBirth": "18042016",
>  "encounter": {
>    "claimId": "WB021Y6$",
>    "claimSeqNum": 1,
>    "immEncSeqNum": 1,
>    "episodes": [
>      {
>        "id": 1,
>        "vaccineCode": "BEXO",
>        "vaccineDose": "2",
>        "vaccineBatch": "NEWBATCH",
>        "vaccineType": "NIP"
>      }
>    ],
>    "dateOfService": "20052026"
>  },
>  "informationProvider": {
>    "providerNumber": "T39126X"
>  }
>}'
200Success
1{
2  "statusCode": "AIR-I-1100",
3  "codeType": "AIRIBU",
4  "message": "Your request was successfully processed.",
5  "encounter": {
6    "claimId": "WB021Y6$",
7    "claimSeqNum": 1,
8    "immEncSeqNum": 1,
9    "episodes": [
10      {
11        "id": 1,
12        "vaccineBatch": "NEWBATCH",
13        "vaccineCode": "BEXO",
14        "vaccineDose": "2",
15        "routeOfAdministration": "",
16        "vaccineType": "NIP",
17        "information": {
18          "status": "VALID",
19          "code": "AIR-I-1002",
20          "text": "Vaccine was valid."
21        }
22      }
23    ],
24    "dateOfService": "20052026"
25  },
26  "correlationId": "urn:uuid:MDE00000bcf63866de2249c6"
27}
Update a single encounter previously submitted via [Record Encounter](/api-reference/air/record-encounter/record-encounter). Use this to correct mistakes — wrong batch, wrong dose, wrong vaccine — for encounters your information provider originally submitted. Identifies the encounter to update by `claimId` + `claimSeqNum` + `immEncSeqNum` (returned from Record Encounter or visible in [Immunisation History Details](/api-reference/air/individual-details/immunisation-history-details)). Only encounters where `editable: true` in the history response can be updated by your provider. Requires an `individualIdentifier` from a prior [Identify Individual](/api-reference/air/individual-details/identify-individual) call. For shared response patterns and the full status-code list, see [AIR Integration](/air). #### Date format Date fields use **DDMMYYYY** with no separators. #### Fields you can update Send the encounter's full new state — AIR replaces the existing encounter wholesale. Include all episodes, even unchanged ones; omitting an episode removes it. The episode-level and encounter-level fields are the same as on [Record Encounter](/api-reference/air/record-encounter/record-encounter) (vaccine code, dose, batch, type, route, antenatal indicator, overseas flag, etc.). The vaccine-mandatory rules also apply. #### Status Codes | Code | Meaning | |---|---| | `AIR-I-1100` | Update successful. The updated `encounter` is returned. | | `AIR-E-1005` | Validation errors (e.g. `AIR-E-1061` invalid identifier, `AIR-E-1052` encounter not found, `AIR-E-1064` not authorised to update). |
Was this page helpful?
Previous

Immunisation History Statement

Next

Record Medical Contraindication

Built with

Update a single encounter previously submitted via Record Encounter. Use this to correct mistakes — wrong batch, wrong dose, wrong vaccine — for encounters your information provider originally submitted.

Identifies the encounter to update by claimId + claimSeqNum + immEncSeqNum (returned from Record Encounter or visible in Immunisation History Details). Only encounters where editable: true in the history response can be updated by your provider.

Requires an individualIdentifier from a prior Identify Individual call.

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

Date format

Date fields use DDMMYYYY with no separators.

Fields you can update

Send the encounter’s full new state — AIR replaces the existing encounter wholesale. Include all episodes, even unchanged ones; omitting an episode removes it.

The episode-level and encounter-level fields are the same as on Record Encounter (vaccine code, dose, batch, type, route, antenatal indicator, overseas flag, etc.). The vaccine-mandatory rules also apply.

Status Codes

CodeMeaning
AIR-I-1100Update successful. The updated encounter is returned.
AIR-E-1005Validation errors (e.g. AIR-E-1061 invalid identifier, AIR-E-1052 encounter not found, AIR-E-1064 not authorised to update).

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

Response

OK
statusCodestring
codeTypestring
messagestring
encounterobject or null

The updated encounter state. Episode-level information.code (e.g. AIR-I-1002 valid, AIR-I-1003 dose adjusted) appears here.

errorslist of objects or null
correlationIdstring