Skip to navigation

Medical Contraindication History

View as Markdown
Which vaccines should this person not receive, and why?

That is the question this endpoint answers: each recorded contraindication, whether it is temporary or permanent, and the reason.

Retrieve the individual’s recorded medical contraindications — vaccines they should not receive, with the type (temporary or permanent), the reason, and any anaphylaxis date.

Requires an individualIdentifier from a prior Identify Individual call. If medContraindicationIndicator on that response is false, this endpoint returns success with no list field.

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

Date format

Date fields use DDMMYYYY with no separators.

Status Codes

Top-level outcomes for this endpoint:

CodeMeaning
AIR-I-1100Request was successfully processed. medContraindicationList returned (omitted entirely when no contraindications are recorded).
AIR-E-1005Validation errors (e.g. AIR-E-1061 invalid or expired identifier).
AIR-E-1058Individual’s record cannot be viewed or updated.

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. Must match the individual matched by individualIdentifier.

informationProviderobjectRequired

Response

OK
statusCodestringOptional
codeTypestringOptional
messagestringOptional
medContraindicationListlist of objectsOptional
Recorded medical contraindications. The whole field is omitted when no contraindications exist.
errorslist of objects or nullOptional

Field-level validation problems. See Validation codes.

correlationIdstringOptional
Unique request identifier.