Skip to navigation

Update Encounter

View as Markdown
How do I correct a vaccination I recorded on the AIR?

Through this endpoint, one encounter at a time, identified by the claim and sequence numbers Record Encounter returned.

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

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

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
encounterobject or nullOptional

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 nullOptional
correlationIdstringOptional