> ## 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.

# Get one consultation

> A single consultation belonging to the authenticated patient.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/users/consultations/{id}/
openapi: 3.0.3
info:
  title: Hi-Doctor API
  version: 1.0.0
  description: >-
    Patient-facing REST API for Hi-Doctor.


    Authenticate with email and password to receive a JWT pair, then send the
    access token as `Authorization: Bearer <token>` on every subsequent request.


    Only patient-accessible endpoints are documented here. Clinician and
    back-office endpoints are intentionally omitted.
  contact:
    name: Hi-Doctor
    email: hello@hi-doctor.ai
    url: https://hi-doctor.ai
servers:
  - url: https://api.hi-doctor.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Registration, email verification, sign-in and profile.
  - name: Questionnaires
    description: Complete a consultation questionnaire and submit it for medical review.
  - name: Consultations
    description: Consultations a doctor has reviewed or is reviewing.
  - name: Prescriptions
    description: Prescriptions and reissue requests.
  - name: Billing
    description: Checkout, subscription management and the Stripe billing portal.
  - name: Records
    description: Orders, invoices and side-effect reports.
  - name: Messages
    description: The patient's private thread with their medical team.
  - name: Progress
    description: Weight, injection and note tracking. Requires an active treatment plan.
  - name: Referrals
    description: Referral summary and transactions.
paths:
  /v1/users/consultations/{id}/:
    get:
      tags:
        - Consultations
      summary: Get one consultation
      description: A single consultation belonging to the authenticated patient.
      operationId: users_consultations_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Consultation'
              example:
                id: 0a1b2c3d-4e5f-4a6b-8c9d-000000000002
                user:
                  id: 0a1b2c3d-4e5f-4a6b-8c9d-000000000001
                  first_name: Alex
                  last_name: Moreno
                  email: patient@example.com
                  locale: en
                  date_of_birth: '1985-04-12'
                  country_of_residence: ESP
                  timezone: Europe/Madrid
                  city: null
                  postal_code: null
                  issuing_state: ESP
                  document_number: X0000000X
                  document_type: ID_CARD
                  consultation_count: 2
                  total_spent_cents: 5000
                  total_refunded_cents: 0
                  net_spent_cents: 5000
                  subscription_status: active
                doctor:
                  id: 0a1b2c3d-4e5f-4a6b-8c9d-00000000000d
                  first_name: Reviewing
                  last_name: Doctor
                  email: doctor@example.com
                  doctor_license_number: '000000000'
                shopify_order_id: null
                status: approved
                origin: checkout
                decision_reason: Meets the criteria. Starting on a low dose.
                treatment_id: wegovy
                dosage: 0.5 mg
                form_snapshot:
                  - step_id: 1
                    question_key: weight_loss-01-country
                    value: ESP
                questionnaire_submission: null
                prescriptions: []
                payments: []
                created_at: '2026-07-24T08:46:49.817627Z'
                updated_at: '2026-07-27T09:12:01.004311Z'
                decided_at: '2026-07-27T09:12:01.004311Z'
          description: ''
        '401':
          description: >-
            No bearer token, or a token that is expired or malformed.
            Re-authenticate; do not retry the same token.
          content:
            application/json:
              example:
                detail: Given token not valid for any token type
                code: token_not_valid
                messages:
                  - token_class: AccessToken
                    token_type: access
                    message: Token is invalid
        '404':
          description: >-
            No such record, **or it belongs to another account**. Every endpoint
            is self-scoped, so a record you cannot see is indistinguishable from
            one that does not exist. Do not retry with a different id.
          content:
            application/json:
              example:
                detail: No Consultation matches the given query.
      security:
        - jwtAuth: []
components:
  schemas:
    Consultation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        user:
          allOf:
            - $ref: '#/components/schemas/Patient'
          readOnly: true
        doctor:
          allOf:
            - $ref: '#/components/schemas/Doctor'
          readOnly: true
        shopify_order_id:
          type: integer
          maximum: 9223372036854776000
          minimum: -9223372036854776000
          format: int64
          nullable: true
        status:
          $ref: '#/components/schemas/ConsultationStatusEnum'
        origin:
          $ref: '#/components/schemas/OriginEnum'
        decision_reason:
          type: string
          nullable: true
        treatment_id:
          type: string
          nullable: true
          maxLength: 255
        dosage:
          type: string
          nullable: true
          maxLength: 255
        form_snapshot:
          type: object
          additionalProperties: {}
          nullable: true
        questionnaire_submission:
          allOf:
            - $ref: '#/components/schemas/QuestionnaireSubmission'
          readOnly: true
        prescriptions:
          type: array
          items:
            $ref: '#/components/schemas/Prescription'
          readOnly: true
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        decided_at:
          type: string
          format: date-time
          nullable: true
      required:
        - created_at
        - doctor
        - id
        - payments
        - prescriptions
        - questionnaire_submission
        - updated_at
        - user
    Patient:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          maxLength: 254
        locale:
          allOf:
            - $ref: '#/components/schemas/LocaleEnum'
          description: Preferred email locale.
        date_of_birth:
          type: string
          format: date
          nullable: true
        country_of_residence:
          type: string
          nullable: true
          description: >-
            ISO 3166-1 alpha-3 country code where the patient currently lives.
            Used for EU cross-border prescription dispensing guidance.
          maxLength: 3
        timezone:
          type: string
          description: Patient's IANA timezone name. Blank means unknown.
          maxLength: 64
        city:
          type: string
          nullable: true
          description: Patient city used to recommend nearby pharmacies.
          maxLength: 120
        postal_code:
          type: string
          nullable: true
          description: Patient postal code used to recommend nearby pharmacies.
          maxLength: 20
        issuing_state:
          type: string
          nullable: true
          description: ISO 3166-1 alpha-3 country code
          maxLength: 3
        document_number:
          type: string
          nullable: true
          maxLength: 50
        document_type:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/DocumentTypeEnum'
            - $ref: '#/components/schemas/BlankEnum'
            - $ref: '#/components/schemas/NullEnum'
        consultation_count:
          type: integer
          readOnly: true
          default: 0
        total_spent_cents:
          type: integer
          readOnly: true
          default: 0
        total_refunded_cents:
          type: integer
          readOnly: true
          default: 0
        net_spent_cents:
          type: string
          readOnly: true
        subscription_status:
          type: string
          readOnly: true
          nullable: true
        last_subscription_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        last_prescription_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
      required:
        - consultation_count
        - email
        - id
        - last_prescription_at
        - last_subscription_at
        - net_spent_cents
        - subscription_status
        - total_refunded_cents
        - total_spent_cents
    Doctor:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          maxLength: 254
        doctor_license_number:
          type: string
          nullable: true
          description: Medical license/collegiate number
          maxLength: 100
      required:
        - email
        - id
    ConsultationStatusEnum:
      enum:
        - pending
        - approved
        - rejected
      type: string
    OriginEnum:
      enum:
        - checkout
        - subscription_initial
        - subscription_included
        - subscription_renewal
      type: string
    QuestionnaireSubmission:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        category:
          type: string
          format: uuid
          readOnly: true
        category_slug:
          type: string
          readOnly: true
        category_label:
          type: string
          readOnly: true
        version:
          type: string
          format: uuid
          readOnly: true
        form_type:
          readOnly: true
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/FormTypeEnum'
            - $ref: '#/components/schemas/NullEnum'
        answers:
          type: object
          additionalProperties: {}
          readOnly: true
        schema_snapshot:
          type: object
          additionalProperties: {}
          readOnly: true
        answer_status_snapshot:
          type: object
          additionalProperties: {}
          readOnly: true
        is_completed:
          type: boolean
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - answer_status_snapshot
        - answers
        - category
        - category_label
        - category_slug
        - created_at
        - form_type
        - id
        - is_completed
        - schema_snapshot
        - version
    Prescription:
      type: object
      description: >-
        A prescription, including the treatment and dosage from its
        consultation.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        consultation_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        patient_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        doctor_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        provider:
          allOf:
            - $ref: '#/components/schemas/Provider0ceEnum'
          description: >-
            Which prescription pipeline produced this row — REMPe (Spain e-Rx)
            or English PDF.
        treatment_id:
          type: string
          readOnly: true
          nullable: true
        dosage:
          type: string
          readOnly: true
          nullable: true
        rempe_treatment_id:
          type: string
          nullable: true
          maxLength: 255
        pdf_file:
          type: string
          format: uri
          nullable: true
        english_pdf_file:
          type: string
          format: uri
          nullable: true
        status:
          $ref: '#/components/schemas/StatusEbdEnum'
        medication_name:
          type: string
          maxLength: 255
        medication_strength:
          type: string
          maxLength: 255
        medication_form:
          type: string
          maxLength: 255
        dosage_instructions:
          type: string
        duration_text:
          type: string
          maxLength: 255
        dispensing_notes:
          type: string
        additional_notes:
          type: string
        expires_at:
          type: string
          format: date-time
          nullable: true
        collected_at:
          type: string
          format: date-time
          nullable: true
        is_expired:
          type: boolean
          readOnly: true
        days_to_collect:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - consultation_id
        - created_at
        - days_to_collect
        - doctor_id
        - dosage
        - id
        - is_expired
        - patient_id
        - treatment_id
        - updated_at
    Payment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        consultation_id:
          type: string
          format: uuid
          readOnly: true
        patient_email:
          type: string
          format: email
          readOnly: true
        patient_id:
          type: string
          format: uuid
          readOnly: true
        provider:
          $ref: '#/components/schemas/Provider906Enum'
        provider_payment_id:
          type: string
          nullable: true
          maxLength: 255
        provider_checkout_id:
          type: string
          nullable: true
          maxLength: 255
        provider_order_id:
          type: string
          nullable: true
          maxLength: 255
        provider_order_name:
          type: string
          nullable: true
          maxLength: 100
        subscription_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        is_recurring:
          type: boolean
        billing_reason:
          type: string
          maxLength: 50
        amount_cents:
          type: integer
          maximum: 2147483647
          minimum: 0
        refunded_amount_cents:
          type: integer
          maximum: 2147483647
          minimum: 0
        net_amount_cents:
          type: integer
          readOnly: true
        currency:
          type: string
          maxLength: 3
        status:
          $ref: '#/components/schemas/PaymentStatusEnum'
        failure_code:
          type: string
          maxLength: 100
        failed_at:
          type: string
          format: date-time
          nullable: true
        description:
          type: string
          maxLength: 255
        captured_at:
          type: string
          format: date-time
          nullable: true
        invoice_url:
          type: string
          readOnly: true
        refund:
          allOf:
            - $ref: '#/components/schemas/PaymentRefund'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - consultation_id
        - created_at
        - id
        - invoice_url
        - net_amount_cents
        - patient_email
        - patient_id
        - provider
        - refund
        - subscription_id
        - updated_at
    LocaleEnum:
      enum:
        - de
        - en
        - es
        - fr
        - it
        - nl
        - pt
      type: string
    DocumentTypeEnum:
      enum:
        - PASSPORT
        - ID_CARD
      type: string
    BlankEnum:
      enum:
        - ''
    NullEnum:
      enum:
        - null
    FormTypeEnum:
      enum:
        - hair_growth
        - weight_loss
        - sexual_health
        - premature_ejaculation
        - chlamydia
        - urinary_tract_infection
        - emergency_contraception
        - hiv_prep
      type: string
    Provider0ceEnum:
      enum:
        - rempe
        - english
      type: string
    StatusEbdEnum:
      enum:
        - active
        - canceled
      type: string
    Provider906Enum:
      enum:
        - shopify
        - stripe
      type: string
    PaymentStatusEnum:
      enum:
        - pending
        - succeeded
        - failed
        - partially_refunded
        - refunded
        - disputed
      type: string
    PaymentRefund:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        provider:
          $ref: '#/components/schemas/Provider906Enum'
        provider_refund_id:
          type: string
          nullable: true
          maxLength: 255
        amount_cents:
          type: integer
          maximum: 2147483647
          minimum: 0
        currency:
          type: string
          maxLength: 3
        status:
          $ref: '#/components/schemas/PaymentRefundStatusEnum'
        reason:
          type: string
        requested_by_email:
          type: string
          format: email
          readOnly: true
          nullable: true
        requested_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - created_at
        - id
        - provider
        - requested_by_email
        - updated_at
    PaymentRefundStatusEnum:
      enum:
        - pending
        - processing
        - succeeded
        - failed
        - canceled
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token from POST /v1/users/token/
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````