Skip to navigation

Record Medical Contraindication

View as Markdown
How do I record that a person should not receive a vaccine?

Through this endpoint, as a permanent or temporary contraindication against a specific vaccine.

Record a medical contraindication for an individual: a permanent or temporary reason a specific vaccine should not be administered. The contraindication must be assessed by a general practitioner, a general practice registrar on an approved 3GA training placement, a paediatrician, a public health physician, an infectious diseases physician or a clinical immunologist.

Send the individualIdentifier that Identify Individual returned. The information provider must be authorised for MEDCON, which Authorisation shows. A provider without that authorisation receives AIR-E-1063.

For shared response patterns and the full status-code list, see AIR Integration. For what your software must show, see Display requirements.

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

CodeMeaning
AIR-I-1100Contraindication recorded.
AIR-E-1005Validation errors, most often AIR-E-1063 (provider not authorised), AIR-E-1048 (reason not valid for the vaccine), AIR-E-1083 (a contraindication for this disease is already recorded), AIR-E-1066 (end date missing on a temporary contraindication, or anaphylaxis date missing) or AIR-E-1051 (end date earlier than the start date).

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring

Your Minor ID is 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Headers

x-minor-idstringRequired

The Minor ID of the clinic you act for. See Required headers and hosts.

Request

This endpoint expects an object.
individualIdentifierstringRequired
Opaque token that Identify Individual returned.
individualDateOfBirthstringRequired
DDMMYYYY format.
contraindicationobjectRequired
informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
errorslist of objects or nullOptional
correlationIdstringOptional