> ## Documentation Index > Fetch the complete documentation index at: https://docs.clinikehr.com/llms.txt > Use this file to discover all available pages before exploring further. # Submit an allergy > **Permission:** `allergies:write` Submit an allergy for a clinician to confirm. The allergy is held for review and answers 202 Accepted with a `Location` header pointing at the submission; it is not on the chart until a clinician confirms it. The `Idempotency-Key` header is REQUIRED - a retry with the same key returns the original submission, never a second one. An allergy the patient already has is not refused: it is held for a clinician like any other, who rejects the duplicate. JSON only: a FHIR AllergyIntolerance body is not accepted. ## OpenAPI ````yaml /openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/allergies openapi: 3.1.0 info: title: ClinikEHR API version: 1.0.0 description: >- Server-to-server REST API for a clinic's own data, reached with a key the clinic (or a developer workspace) creates in the developer portal. Authenticate every request with `Authorization: Bearer `. Test keys reach only your workspace's own synthetic sandbox; live keys reach the clinic that created them. Lists wrap their rows as `{ data, has_more, next_cursor }`; single resources are returned directly. Errors are `application/problem+json` (RFC 9457) with a stable `code`. Write requests accept an `Idempotency-Key` header so a retry never repeats a change. See the guides for authentication, permissions, pagination, rate limits and retries. servers: - url: https://api.clinikehr.com security: - ApiKey: [] paths: /v1/clinics/{clinic_id}/allergies: post: tags: - Allergies summary: Submit an allergy description: >- **Permission:** `allergies:write` Submit an allergy for a clinician to confirm. The allergy is held for review and answers 202 Accepted with a `Location` header pointing at the submission; it is not on the chart until a clinician confirms it. The `Idempotency-Key` header is REQUIRED - a retry with the same key returns the original submission, never a second one. An allergy the patient already has is not refused: it is held for a clinician like any other, who rejects the duplicate. JSON only: a FHIR AllergyIntolerance body is not accepted. operationId: createAllergy parameters: - $ref: '#/components/parameters/IdempotencyKeyRequired' - name: clinic_id in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AllergyCreate' responses: '202': description: >- Accepted - waiting for a clinician. If the clinic has chosen to accept this kind of item from your key or connection without review, the body already shows `review_status: confirmed` and `accepted_automatically: true`; read `review_status`, not the status code. headers: Location: description: The submission, `.../submissions/{submission_id}`. schema: type: string content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/Submission' idempotent_replay: type: boolean description: >- Present and true when this Idempotency-Key was already used and the original submission is returned. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/TooManyRequests' security: - ApiKey: [] components: parameters: IdempotencyKeyRequired: name: Idempotency-Key in: header required: true description: >- A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with `409 idempotency_key_conflict`, and retrying while the first request is still running with `409 idempotency_key_reused`. See Retries and idempotency. schema: type: string minLength: 1 schemas: AllergyCreate: type: object additionalProperties: false description: >- An outside allergy, or a "no known allergies" statement, submitted for a clinician to confirm. It does not enter the chart until then. To record that the patient has no known allergies, send `no_known_allergies: true` INSTEAD of a substance (the two cannot be combined); it is also held for a clinician to confirm. Sending `none` or similar as a substance is refused. `client_reference` (your own id, up to 200 characters) makes a second submission of the same record with different content a `client_reference_conflict`. An allergy the patient already has is not refused: it is held for a clinician like any other. required: - patient_id properties: patient_id: type: string format: uuid substance: $ref: '#/components/schemas/AllergyCreateSubstance' no_known_allergies: type: boolean enum: - true description: >- Record that the patient has no known allergies. Send this INSTEAD of `substance`; one of the two is required and they cannot be combined. category: type: array maxItems: 4 items: type: string enum: - food - medication - environment - biologic criticality: type: string enum: - low - high - unable_to_assess type: type: string enum: - allergy - intolerance default: allergy clinical_status: type: string enum: - active - inactive - resolved default: active reactions: type: array maxItems: 20 items: $ref: '#/components/schemas/AllergyReaction' onset_date: type: string format: date note: type: string maxLength: 2000 client_reference: type: string maxLength: 200 origin_assistant_name: type: string maxLength: 200 Submission: type: object description: >- What the clinic's review queue holds for something this key sent: one outside record waiting for, or already past, a clinician's decision. required: - submission_id - patient_id - resource_type - action - review_status properties: submission_id: type: string format: uuid patient_id: type: string format: uuid resource_type: type: string enum: - condition - allergy - medication_statement - referral description: The kind of record. action: type: string enum: - create - update - retract target_id: type: - string - 'null' format: uuid description: The existing record an update or retract is about. review_status: type: string enum: - pending - confirmed - rejected - withdrawn accepted_automatically: type: boolean description: >- True when the clinic has chosen to accept this kind of item from this key or connection without review; the item is then already on the chart and `review_status` is `confirmed`. False for everything a clinician decides, and while it is pending. source: type: string enum: - api submitted_at: type: - string - 'null' format: date-time decided_at: type: - string - 'null' format: date-time decision_reason: type: - string - 'null' description: Present only when rejected. result_record_id: type: - string - 'null' format: uuid description: The record this became, once confirmed. client_reference: type: - string - 'null' origin_assistant_name: type: - string - 'null' payload: type: object description: What was submitted. AllergyCreateSubstance: type: object additionalProperties: false required: - text properties: text: type: string minLength: 1 maxLength: 200 code: type: object additionalProperties: false required: - system - code properties: system: type: string enum: - local - rxnorm - snomed-ct code: type: string minLength: 1 maxLength: 64 AllergyReaction: type: object additionalProperties: false description: >- One reaction. `manifestation` lists what happened, in the clinic's or sender's own words. required: - manifestation properties: manifestation: type: array minItems: 1 maxItems: 10 items: type: string maxLength: 100 severity: type: - string - 'null' enum: - mild - moderate - severe - null description: type: - string - 'null' maxLength: 500 Problem: type: object description: RFC 9457 application/problem+json. required: - type - title - status - code - request_id properties: type: type: string format: uri title: type: string status: type: integer detail: type: string code: type: string request_id: type: string errors: type: array items: type: object required: - pointer - message properties: pointer: type: string message: type: string responses: BadRequest: description: >- The request failed validation (unknown query parameter, limit out of range, malformed body). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Unauthorized: description: >- Missing, malformed, unknown, revoked or expired key, or the wrong secret. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Forbidden: description: >- The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' NotFound: description: The record is absent, or out of the key's scope — one message for both. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Conflict: description: >- The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' TooManyRequests: description: Rate limited. See the Retry-After header. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: ehr_live__ or ehr_test__ ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.