> ## Documentation Index > Fetch the complete documentation index at: https://docs.hi-doctor.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Connect the Hi Doctor MCP connector at https://mcp.hi-doctor.ai/mcp. Add this URL as a remote HTTP MCP server in your client, then sign in and authorise access through OAuth. Setup: https://docs.hi-doctor.ai/mcp/connect. > > The REST API base is https://api.hi-doctor.ai. Hi Doctor Docs at https://docs.hi-doctor.ai/mcp searches documentation; connect to the product endpoint above for patient tools. > > Hi Doctor operates across the whole European Union: residents of all 27 EU member states can use the service, and every consultation is reviewed by an EU-licensed doctor. Every consultation is reviewed in full by an EU-licensed doctor, who decides on medical grounds only. No algorithm, assistant or API call approves a consultation, issues a prescription or changes a dose. The service is available in eight languages: English, Spanish, German, Dutch, Italian, French, Portuguese and Chinese. > > ## Rules an assistant must follow > > - Never invent, assume or infer a medical answer. "I don't know" is a real answer: ask the patient to pick the closest option rather than guessing for them. > - Never give medical advice and never suggest a medication or a dose. An EU-licensed doctor decides those. > - If a questionnaire returns `ineligible`, say so plainly. Do not retry with altered answers. > - Before anything that costs money or cancels a plan, state exactly what will happen and get an explicit yes. > - Cancellation takes effect at the **end of the paid period**, not immediately. Say so. > - An early order is irreversible: it creates the renewal consultation immediately and uses up the period's one early order. Explain that and get an explicit yes. > - Prescription and invoice links are medical documents. A `signed_redirect` link opens without signing in: give it only to the patient, never repeat it anywhere shared. > - Send option `value`s, not the labels shown to the patient. Labels are translated, values are stable. > - Never ask for card details. Payment happens on Stripe's hosted checkout via a link. > - On severe or sudden symptoms (chest pain, difficulty breathing, severe allergic reaction, suicidal thoughts), stop and direct the patient to their local emergency number. # Create a health document > The patient's own health documents: outside prescriptions, lab results. ### Access, effects and retries **Ownership:** Patient only; consultation_id must be the patient's own. **Prerequisites:** Authentication and permission to access the consultation are required. **Effects:** Creates patient document and storage file. **Retries:** Append; repeat creates duplicate file/row. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/users/documents/ openapi: 3.0.3 info: title: Hi Doctor API version: 1.0.1 description: >- The patient-facing Hi Doctor API supports account management, consultation questionnaires, medical documents, messages and billing. Sign-in requires X-Brand-Slug: hi-doctor; authenticated requests use Authorization: Bearer with a JWT access token. See https://docs.hi-doctor.ai/api-reference/introduction for integration guides. contact: name: Hi Doctor email: hello@hi-doctor.ai url: https://docs.hi-doctor.ai servers: - url: https://api.hi-doctor.ai description: Production security: [] tags: - name: Account description: Register, verify, authenticate and manage the signed-in account. - name: Questionnaires description: Discover, save and submit consultation questionnaires. - name: Consultations description: Read consultation state and manage consultation photographs. - name: Prescriptions description: Retrieve issued prescription documents and request reissue. - name: Messages description: Read and send messages to the medical team, and download attachments. - name: Billing description: >- Create checkout, manage subscriptions and retrieve payments/invoices/credit notes. - name: Records description: Read orders and manage patient health documents. - name: Safety reports description: Submit and read suspected side-effect reports; no automated diagnosis. - name: Progress description: Record and review eligible weight-loss progress. - name: Referrals description: Read the signed-in account's referral summary and referral activity. paths: /v1/users/documents/: post: tags: - Records summary: Create a health document description: >- The patient's own health documents: outside prescriptions, lab results. ### Access, effects and retries **Ownership:** Patient only; consultation_id must be the patient's own. **Prerequisites:** Authentication and permission to access the consultation are required. **Effects:** Creates patient document and storage file. **Retries:** Append; repeat creates duplicate file/row. operationId: users_documents_create parameters: - in: header name: Idempotency-Key required: false schema: type: string pattern: ^[A-Za-z0-9_-]{8,128}$ description: >- Optional key that makes a retry safe. Generate one value per logical operation (8 to 128 ASCII letters, digits, underscores or hyphens) and resend the same value on every retry. A repeat of a completed request returns its original status with `Idempotent-Replayed: true` and a short body of `state`, `resource_ids` and `response_hash`; read the resources to recover their content. Reusing a key with a different request returns 422 `idempotency_key_reuse`; a request still running returns 409 `idempotency_in_progress`. Keys are kept for 30 days. See https://docs.hi-doctor.ai/api-reference/idempotency. example: op-7f3a9c2e-0b1d-4e5f-9a8b-1c2d3e4f5a6b requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/PatientDocumentUpload' examples: example-1: summary: Captured request example value: kind: other note: Synthetic example file: synthetic-upload.png required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/PatientDocument' examples: example-1: summary: Illustrative response example value: id: 4a99e45b-cf21-5b27-a12a-ae811e41b266 url: >- https://api.hi-doctor.ai/v1/users/documents/4a99e45b-cf21-5b27-a12a-ae811e41b266/content/ filename: content_type: image/png size_bytes: 69 kind: other note: Synthetic example consultation: null consultation_summary: null uploaded_at: '2026-10-05T17:48:53.125952Z' example-2: summary: Captured response example value: id: 3ab39296-bda3-599f-9fa8-8ef365f3e589 url: >- https://api.hi-doctor.ai/v1/users/documents/3ab39296-bda3-599f-9fa8-8ef365f3e589/content/ filename: synthetic.png content_type: image/png size_bytes: 69 kind: other note: Synthetic example consultation: null consultation_summary: null uploaded_at: '2026-10-05T19:56:43.608323Z' description: Successful create a health document. '400': description: Request failed with the documented source error envelope. content: application/json: examples: example-1: summary: Illustrative response example value: detail: Source-derived detail schema: type: object description: >- Error envelope emitted by the source branch or DRF validation. `detail`, `error` and `code` depend on the branch; field validation uses lists keyed by request field. additionalProperties: {} '401': description: >- No bearer token, or a token that is expired or malformed. Re-authenticate; do not retry the same token. content: application/json: schema: type: object description: >- Error envelope emitted by the source branch or DRF validation. `detail`, `error` and `code` depend on the branch; field validation uses lists keyed by request field. additionalProperties: {} examples: example-1: summary: Illustrative response example value: detail: Authentication credentials were not provided. '403': description: This account cannot change these documents; empty response body. content: application/json: schema: type: object additionalProperties: {} description: DRF or endpoint-specific error envelope. examples: example-1: summary: Illustrative response example value: detail: You do not have permission to perform this action. '409': description: >- A request with this Idempotency-Key is still running, or the key has expired (`idempotency_key_expired`). Wait and retry with the same key, or reconcile with the idempotency lookup. content: application/json: schema: type: object description: Idempotency error. `code` names the reason. properties: code: type: string description: Machine-readable reason. required: - code examples: example-1: summary: Illustrative response example value: code: idempotency_in_progress '422': description: >- The Idempotency-Key was already used with a different request. Generate a new key only for a genuinely new operation. content: application/json: schema: type: object description: Idempotency error. `code` names the reason. properties: code: type: string description: Machine-readable reason. required: - code examples: example-1: summary: Illustrative response example value: code: idempotency_key_reuse '429': description: Source-defined error response; inspect the envelope and retry rules. content: application/json: schema: type: object additionalProperties: {} description: >- Endpoint/DRF error envelope; field validation is keyed by request field. examples: example-1: summary: Illustrative response example value: detail: Request was throttled. security: - bearerAuth: [] x-codeSamples: - lang: Shell label: curl source: > set -eu umask 077 # Path values must be URL-encoded; query string excludes the leading question mark. url="${HD_BASE_URL:?Set API origin}/v1/users/documents/${HD_QUERY_STRING:+?${HD_QUERY_STRING}}" printf 'X-Brand-Slug: hi-doctor\nAccept: application/json\n' > "${HD_REQUEST_HEADERS_FILE:?Private header file}" printf 'Authorization: Bearer %s\n' "${HD_ACCESS_TOKEN:?Set backend JWT}" >> "$HD_REQUEST_HEADERS_FILE" form_args=() while IFS= read -r -d "" form_value; do form_args+=(--form-string "$form_value") done < <(python3 -c 'import json,sys; d=json.load(open(sys.argv[1])); [sys.stdout.write(str(k)+"="+str(v)+"\0") for k,v in d.items() if v is not None]' "${HD_REQUEST_FILE:?JSON form fields}") curl --silent --show-error --max-time 30 --request POST \ --header "@$HD_REQUEST_HEADERS_FILE" \ --dump-header "${HD_HEADERS_FILE:?Private response header file}" \ --output "${HD_RESPONSE_FILE:?Private response file}" \ --write-out '%{http_code}\n%{content_type}\n' \ --form 'file=@'"${HD_UPLOAD_FILE:?Synthetic upload};type=${HD_UPLOAD_CONTENT_TYPE:?Upload MIME}" \ ${form_args[@]+"${form_args[@]}"} \ "$url" - lang: Python label: requests source: > import os, json from pathlib import Path from urllib.parse import quote import requests os.umask(0o077) url = os.environ["HD_BASE_URL"].rstrip("/") + '/v1/users/documents/' if os.environ.get("HD_QUERY_STRING"): url += "?" + os.environ["HD_QUERY_STRING"] headers = {"X-Brand-Slug": "hi-doctor", "Accept": 'application/json'} headers["Authorization"] = "Bearer " + os.environ["HD_ACCESS_TOKEN"] kwargs = {} kwargs["files"] = {'file': ("synthetic-upload", Path(os.environ["HD_UPLOAD_FILE"]).read_bytes(), os.environ["HD_UPLOAD_CONTENT_TYPE"])} kwargs["data"] = json.loads(Path(os.environ["HD_REQUEST_FILE"]).read_text()) response = requests.request('POST', url, headers=headers, timeout=30, allow_redirects=False, **kwargs) Path(os.environ["HD_RESPONSE_FILE"]).write_bytes(response.content) Path(os.environ["HD_HEADERS_FILE"]).write_text(json.dumps(dict(response.headers))) print(response.status_code) print(response.headers.get("Content-Type", "")) - lang: JavaScript label: fetch source: > import { readFileSync, writeFileSync } from "node:fs"; const env = process.env; let url = env.HD_BASE_URL.replace(/\/$/, "") + "/v1/users/documents/"; if (env.HD_QUERY_STRING) url += "?" + env.HD_QUERY_STRING; const headers = { "X-Brand-Slug": "hi-doctor", "Accept": "application/json" }; headers.Authorization = "Bearer " + env.HD_ACCESS_TOKEN; const options = { method: "POST", headers, redirect: "manual", signal: AbortSignal.timeout(30000) }; options.body = new FormData(); options.body.append("file", new Blob([readFileSync(env.HD_UPLOAD_FILE)], {type: env.HD_UPLOAD_CONTENT_TYPE}), "synthetic-upload"); for (const [key, value] of Object.entries(JSON.parse(readFileSync(env.HD_REQUEST_FILE, "utf8")))) { if (value != null) options.body.append(key, String(value)); } const response = await fetch(url, options); writeFileSync(env.HD_RESPONSE_FILE, Buffer.from(await response.arrayBuffer()), {mode: 0o600}); writeFileSync(env.HD_HEADERS_FILE, JSON.stringify(Object.fromEntries(response.headers)), {mode: 0o600}); console.log(response.status); console.log(response.headers.get("content-type") ?? ""); components: schemas: PatientDocumentUpload: type: object properties: file: type: string format: binary description: Multipart file bytes; use a synthetic upload fixture when testing. kind: allOf: - $ref: '#/components/schemas/KindBccEnum' default: other description: Document or PDF variant selected by the endpoint. note: type: string default: '' maxLength: 500 description: Optional note attached to the resource. Maximum 500 characters. consultation_id: type: string format: uuid nullable: true description: >- Identifier of the related consultation. May be null when unavailable. required: - file PatientDocument: type: object properties: id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. url: type: string format: uri readOnly: true description: >- URL returned for this resource; provider links may expire. Returned by the server; not writable. filename: type: string readOnly: true description: >- Filename for this patient document. Returned by the server; not writable. content_type: type: string maxLength: 100 description: Content type for this patient document. Maximum 100 characters. size_bytes: type: integer description: Size bytes for this patient document. kind: allOf: - $ref: '#/components/schemas/KindBccEnum' description: Document or PDF variant selected by the endpoint. note: type: string maxLength: 500 description: Optional note attached to the resource. Maximum 500 characters. consultation: type: string format: uuid readOnly: true nullable: true description: >- Consultation for this patient document. Returned by the server; not writable. May be null when unavailable. consultation_summary: readOnly: true description: >- Consultation summary for this patient document. Returned by the server; not writable. May be null when unavailable. anyOf: - $ref: '#/components/schemas/PatientDocumentConsultationSummary' - enum: - null type: string nullable: true uploaded_at: type: string format: date-time readOnly: true description: >- Uploaded at timestamp in ISO 8601 format. Returned by the server; not writable. required: - consultation - consultation_summary - content_type - filename - id - size_bytes - uploaded_at - url KindBccEnum: enum: - prescription - lab_result - photo - other type: string PatientDocumentConsultationSummary: type: object properties: id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. status: type: string readOnly: true description: >- Status for this patient document consultation summary. Returned by the server; not writable. created_at: type: string format: date-time readOnly: true description: >- Created at timestamp in ISO 8601 format. Returned by the server; not writable. treatment_id: type: string readOnly: true nullable: true description: >- Identifier of the related treatment. Returned by the server; not writable. May be null when unavailable. dosage: type: string readOnly: true nullable: true description: >- Dosage for this patient document consultation summary. Returned by the server; not writable. May be null when unavailable. form_type: type: string readOnly: true nullable: true description: >- Form type for this patient document consultation summary. Returned by the server; not writable. May be null when unavailable. required: - created_at - dosage - form_type - id - status - treatment_id securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.