> ## 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. # Get a consultation > A single consultation belonging to the authenticated patient. ### Access, effects and retries **Ownership:** Patient own consultation; foreign/missing returns 404. **Prerequisites:** Authentication and permission to access the consultation are required. **Effects:** Read only. **Retries:** Safe read. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/users/consultations/{id}/ 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/consultations/{id}/: get: tags: - Consultations summary: Get a consultation description: >- A single consultation belonging to the authenticated patient. ### Access, effects and retries **Ownership:** Patient own consultation; foreign/missing returns 404. **Prerequisites:** Authentication and permission to access the consultation are required. **Effects:** Read only. **Retries:** Safe read. operationId: users_consultations_retrieve parameters: - in: path name: id schema: type: string required: true description: >- Identifier returned by the corresponding authorized collection; use only a record visible to the signed-in patient. example: synthetic responses: '200': content: application/json: schema: $ref: '#/components/schemas/Consultation' examples: example-1: summary: Captured response example value: brand: slug: hi-doctor display_name: Synthetic display name primary_color: '#157a5c' id: b0e81246-c46e-5ac2-9675-06bf07784bf4 user: id: 9fb1a263-c71b-5fe9-b2e7-5a0eb099bad5 first_name: Synthetic first name last_name: Synthetic last name email: synthetic-patient@example.invalid locale: en date_of_birth: '1990-01-01' country_of_residence: ESP timezone: Europe/Madrid city: Synthetic city postal_code: '00000' address_line1: Synthetic address line1 issuing_state: ESP document_number: Synthetic document number document_type: ID_CARD consultation_count: 0 total_spent_cents: 0 total_refunded_cents: 0 net_spent_cents: 0 subscription_status: null doctor: id: 1d1b5b46-00a7-5c1d-92eb-38a387a8f14d first_name: Synthetic first name last_name: Synthetic last name email: synthetic-patient@example.invalid doctor_license_number: QA-E2E-0001 shopify_order_id: null status: approved origin: subscription_initial plan: subscription supply_days: 28 renewal_questionnaire_required: false renewal_changed: null patient_choice_status: '' patient_choice_requested_at: null patient_choice_confirmed_at: null decision_reason: Synthetic example treatment_id: mounjaro dosage: 2.5 mg form_snapshot: - value: ESP step_id: 1 question_key: weight_loss-01-country - value: male step_id: 2 question_key: weight_loss-02-gender - values: Height (cm): 175 Weight (kg): 95 step_id: 3 question_key: weight_loss-03-height_weight - value: - none step_id: 4 question_key: weight_loss-04-height_weight - value: - none step_id: 6 question_key: weight_loss-06-height_weight - value: - none step_id: 7 question_key: weight_loss-07-height_weight - value: never_used step_id: 8 question_key: weight_loss-08-height_weight - value: - none step_id: 15 question_key: weight_loss-currentmedications - value: - none step_id: 10 question_key: weight_loss-10-height_weight - value: - none step_id: 11 question_key: weight_loss-11-height_weight - value: - none step_id: 12 question_key: weight_loss-12-height_weight - value: - none step_id: 20 question_key: weight_loss-allergies - value: - none step_id: 13 question_key: weight_loss-13-height_weight - value: understood step_id: 14 question_key: weight_loss-14-height_weight questionnaire_submission: id: aeb22178-a00f-5f80-a17d-91dd3b19689b category: ec6c2abf-14af-5045-ada5-b3a931501751 category_slug: weight-loss category_label: categories.weightLoss.form.title version: cf1867b4-7048-593b-a0a3-cd1d0c0672e8 form_type: weight_loss answers: - value: ESP step_id: 1 question_key: weight_loss-01-country - value: male step_id: 2 question_key: weight_loss-02-gender - values: Height (cm): 175 Weight (kg): 95 step_id: 3 question_key: weight_loss-03-height_weight - value: - none step_id: 4 question_key: weight_loss-04-height_weight - value: - none step_id: 6 question_key: weight_loss-06-height_weight - value: - none step_id: 7 question_key: weight_loss-07-height_weight - value: never_used step_id: 8 question_key: weight_loss-08-height_weight - value: - none step_id: 15 question_key: weight_loss-currentmedications - value: - none step_id: 10 question_key: weight_loss-10-height_weight - value: - none step_id: 11 question_key: weight_loss-11-height_weight - value: - none step_id: 12 question_key: weight_loss-12-height_weight - value: - none step_id: 20 question_key: weight_loss-allergies - value: - none step_id: 13 question_key: weight_loss-13-height_weight - value: understood step_id: 14 question_key: weight_loss-14-height_weight schema_snapshot: id: weight-loss steps: - id: 1 key: weight_loss-01-country kind: single type: single-select order: 1 title: form.countrySelection.title fields: [] options: - image: '' label: translation_v2.form.countries.AUT value: AUT labelKey: translation_v2.form.countries.AUT requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.BEL value: BEL labelKey: translation_v2.form.countries.BEL requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.BGR value: BGR labelKey: translation_v2.form.countries.BGR requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.HRV value: HRV labelKey: translation_v2.form.countries.HRV requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.CYP value: CYP labelKey: translation_v2.form.countries.CYP requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.CZE value: CZE labelKey: translation_v2.form.countries.CZE requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.DNK value: DNK labelKey: translation_v2.form.countries.DNK requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.EST value: EST labelKey: translation_v2.form.countries.EST requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.FIN value: FIN labelKey: translation_v2.form.countries.FIN requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.FRA value: FRA labelKey: translation_v2.form.countries.FRA requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.DEU value: DEU labelKey: translation_v2.form.countries.DEU requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.GRC value: GRC labelKey: translation_v2.form.countries.GRC requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.HUN value: HUN labelKey: translation_v2.form.countries.HUN requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.IRL value: IRL labelKey: translation_v2.form.countries.IRL requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.ITA value: ITA labelKey: translation_v2.form.countries.ITA requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.LVA value: LVA labelKey: translation_v2.form.countries.LVA requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.LTU value: LTU labelKey: translation_v2.form.countries.LTU requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.LUX value: LUX labelKey: translation_v2.form.countries.LUX requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.MLT value: MLT labelKey: translation_v2.form.countries.MLT requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.NLD value: NLD labelKey: translation_v2.form.countries.NLD requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.POL value: POL labelKey: translation_v2.form.countries.POL requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.PRT value: PRT labelKey: translation_v2.form.countries.PRT requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.ROU value: ROU labelKey: translation_v2.form.countries.ROU requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.SVK value: SVK labelKey: translation_v2.form.countries.SVK requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.SVN value: SVN labelKey: translation_v2.form.countries.SVN requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.ESP value: ESP labelKey: translation_v2.form.countries.ESP requiresAdditionalInfo: false - image: '' label: translation_v2.form.countries.SWE value: SWE labelKey: translation_v2.form.countries.SWE requiresAdditionalInfo: false metadata: {} titleKey: form.countrySelection.title whyWeAsk: translation_v2.form.countrySelection.description helpLinks: [] optionKey: '' inputField: null placeholder: form.countrySelection.placeholder reusePolicy: reuse whyWeAskKey: translation_v2.form.countrySelection.description errorMessage: form.countrySelection.notSupported bmiValidation: null descriptionKey: '' legacy_step_id: 1 placeholderKey: form.countrySelection.placeholder errorMessageKey: form.countrySelection.notSupported helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: null - id: 2 key: weight_loss-02-gender kind: single type: single-select order: 2 title: categories.weightLoss.form.steps.gender.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.gender.options.male value: male labelKey: >- categories.weightLoss.form.steps.gender.options.male requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.gender.options.female value: female labelKey: >- categories.weightLoss.form.steps.gender.options.female requiresAdditionalInfo: false metadata: {} titleKey: categories.weightLoss.form.steps.gender.title whyWeAsk: '' helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: reuse whyWeAskKey: '' errorMessage: categories.weightLoss.form.steps.gender.error bmiValidation: null descriptionKey: '' legacy_step_id: 2 placeholderKey: '' errorMessageKey: categories.weightLoss.form.steps.gender.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: null - id: 3 key: weight_loss-03-height_weight kind: input type: input order: 3 title: >- categories.weightLoss.form.steps.heightWeight.title fields: - name: Synthetic name label: Height (cm) labelKey: Height (cm) validation: max: 220 min: 120 type: number required: true placeholder: '' placeholderKey: '' - name: Synthetic name label: Weight (kg) labelKey: Weight (kg) validation: max: 300 min: 40 type: number required: true placeholder: '' placeholderKey: '' options: [] metadata: {} titleKey: >- categories.weightLoss.form.steps.heightWeight.title whyWeAsk: >- categories.weightLoss.form.steps.heightWeight.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: never_reuse whyWeAskKey: >- categories.weightLoss.form.steps.heightWeight.whyWeAsk errorMessage: '' bmiValidation: minBMI: 27 errorMessage: >- categories.weightLoss.form.steps.heightWeight.bmiError descriptionKey: '' legacy_step_id: 3 placeholderKey: '' errorMessageKey: '' helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: null - id: 4 key: weight_loss-04-height_weight kind: multi type: multi-select order: 4 title: >- categories.weightLoss.form.steps.comorbidities.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.comorbidities.options.hypertension value: hypertension labelKey: >- categories.weightLoss.form.steps.comorbidities.options.hypertension requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.comorbidities.options.dyslipidemia value: dyslipidemia labelKey: >- categories.weightLoss.form.steps.comorbidities.options.dyslipidemia requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.comorbidities.options.type2_diabetes value: type2_diabetes labelKey: >- categories.weightLoss.form.steps.comorbidities.options.type2_diabetes requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.comorbidities.options.sleep_apnea value: sleep_apnea labelKey: >- categories.weightLoss.form.steps.comorbidities.options.sleep_apnea requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.comorbidities.options.other value: other labelKey: >- categories.weightLoss.form.steps.comorbidities.options.other requiresAdditionalInfo: true - image: '' label: >- categories.weightLoss.form.steps.comorbidities.options.none value: none labelKey: >- categories.weightLoss.form.steps.comorbidities.options.none requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.comorbidities.title whyWeAsk: >- categories.weightLoss.form.steps.comorbidities.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.comorbidities.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.comorbidities.error bmiValidation: null descriptionKey: '' legacy_step_id: 4 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.comorbidities.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: maxBMI: 30 minBMI: 27 stepId: 3 reuseExpiresAfterDays: 180 - id: 5 key: weight_loss-05-height_weight kind: single type: single-select order: 5 title: categories.weightLoss.form.steps.pregnancy.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.pregnancy.options.pregnant value: pregnant labelKey: >- categories.weightLoss.form.steps.pregnancy.options.pregnant requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.pregnancy.options.breastfeeding value: breastfeeding labelKey: >- categories.weightLoss.form.steps.pregnancy.options.breastfeeding requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.pregnancy.options.planning value: planning labelKey: >- categories.weightLoss.form.steps.pregnancy.options.planning requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.pregnancy.options.none value: none labelKey: >- categories.weightLoss.form.steps.pregnancy.options.none requiresAdditionalInfo: false metadata: {} titleKey: categories.weightLoss.form.steps.pregnancy.title whyWeAsk: >- categories.weightLoss.form.steps.pregnancy.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.pregnancy.whyWeAsk errorMessage: categories.weightLoss.form.steps.pregnancy.error bmiValidation: null descriptionKey: '' legacy_step_id: 5 placeholderKey: '' errorMessageKey: categories.weightLoss.form.steps.pregnancy.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: value: female stepId: 2 fieldName: selected helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 7 key: weight_loss-07-height_weight kind: multi type: multi-select order: 6 title: >- categories.weightLoss.form.steps.familyHistory.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.familyHistory.options.obesity value: obesity labelKey: >- categories.weightLoss.form.steps.familyHistory.options.obesity requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.familyHistory.options.diabetes value: diabetes labelKey: >- categories.weightLoss.form.steps.familyHistory.options.diabetes requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.familyHistory.options.cardiovascular value: cardiovascular labelKey: >- categories.weightLoss.form.steps.familyHistory.options.cardiovascular requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.familyHistory.options.other value: other labelKey: >- categories.weightLoss.form.steps.familyHistory.options.other requiresAdditionalInfo: true - image: '' label: >- categories.weightLoss.form.steps.familyHistory.options.none value: none labelKey: >- categories.weightLoss.form.steps.familyHistory.options.none requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.familyHistory.title whyWeAsk: '' helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: '' errorMessage: >- categories.weightLoss.form.steps.familyHistory.error bmiValidation: null descriptionKey: '' legacy_step_id: 7 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.familyHistory.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 8 key: weight_loss-08-height_weight kind: single type: single-select order: 7 title: >- categories.weightLoss.form.steps.previousMedications.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.previousMedications.options.never_used value: never_used labelKey: >- categories.weightLoss.form.steps.previousMedications.options.never_used requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedications.options.used_effective value: used_effective labelKey: >- categories.weightLoss.form.steps.previousMedications.options.used_effective requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedications.options.used_not_effective value: used_not_effective labelKey: >- categories.weightLoss.form.steps.previousMedications.options.used_not_effective requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedications.options.used_side_effects value: used_side_effects labelKey: >- categories.weightLoss.form.steps.previousMedications.options.used_side_effects requiresAdditionalInfo: true metadata: {} titleKey: >- categories.weightLoss.form.steps.previousMedications.title whyWeAsk: >- categories.weightLoss.form.steps.previousMedications.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.previousMedications.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.previousMedications.error bmiValidation: null descriptionKey: '' legacy_step_id: 8 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.previousMedications.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 16 key: weight_loss-previous-medication-which kind: single type: single-select order: 8 title: >- categories.weightLoss.form.steps.previousMedicationWhich.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.previousMedicationWhich.options.wegovy value: wegovy labelKey: >- categories.weightLoss.form.steps.previousMedicationWhich.options.wegovy requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationWhich.options.mounjaro value: mounjaro labelKey: >- categories.weightLoss.form.steps.previousMedicationWhich.options.mounjaro requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationWhich.options.saxenda value: saxenda labelKey: >- categories.weightLoss.form.steps.previousMedicationWhich.options.saxenda requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationWhich.options.other value: other labelKey: >- categories.weightLoss.form.steps.previousMedicationWhich.options.other requiresAdditionalInfo: true metadata: {} titleKey: >- categories.weightLoss.form.steps.previousMedicationWhich.title whyWeAsk: >- categories.weightLoss.form.steps.previousMedicationWhich.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.previousMedicationWhich.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.previousMedicationWhich.error bmiValidation: null descriptionKey: '' legacy_step_id: 16 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.previousMedicationWhich.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: value: never_used stepId: 8 operator: not_equals helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 17 key: weight_loss-previous-medication-dose-wegovy kind: single type: single-select order: 9 title: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose025 value: 0.25 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose025 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose05 value: 0.5 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose05 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose1 value: 1 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose1 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose17 value: 1.7 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose17 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose24 value: 2.4 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.dose24 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.notSure value: not_sure labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.options.notSure requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.title whyWeAsk: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.error bmiValidation: null descriptionKey: '' legacy_step_id: 17 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.previousMedicationDoseWegovy.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: value: wegovy stepId: 16 helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 18 key: weight_loss-previous-medication-dose-mounjaro kind: single type: single-select order: 10 title: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose25 value: 2.5 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose25 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose5 value: 5 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose5 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose75 value: 7.5 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose75 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose10 value: 10 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose10 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose125 value: 12.5 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose125 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose15 value: 15 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.dose15 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.notSure value: not_sure labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.options.notSure requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.title whyWeAsk: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.error bmiValidation: null descriptionKey: '' legacy_step_id: 18 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.previousMedicationDoseMounjaro.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: value: mounjaro stepId: 16 helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 19 key: weight_loss-previous-medication-dose-saxenda kind: single type: single-select order: 11 title: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose06 value: 0.6 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose06 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose12 value: 1.2 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose12 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose18 value: 1.8 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose18 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose24 value: 2.4 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose24 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose3 value: 3 mg labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.dose3 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.notSure value: not_sure labelKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.options.notSure requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.title whyWeAsk: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.error bmiValidation: null descriptionKey: '' legacy_step_id: 19 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.previousMedicationDoseSaxenda.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: value: saxenda stepId: 16 helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 9 key: weight_loss-09-height_weight kind: input type: input order: 12 title: >- categories.weightLoss.form.steps.previousMedicationDetails.title fields: - name: Synthetic name label: Duration (months) labelKey: >- categories.weightLoss.form.steps.previousMedicationDetails.fields.duration.label validation: type: text required: true placeholder: '' placeholderKey: '' - name: Synthetic name label: Treatment start date labelKey: >- categories.weightLoss.form.steps.previousMedicationDetails.fields.startDate.label validation: type: date maxDate: today required: true placeholder: '' placeholderKey: '' - name: Synthetic name label: Date of last dose labelKey: >- categories.weightLoss.form.steps.previousMedicationDetails.fields.lastDoseDate.label validation: type: date maxDate: today required: true placeholder: '' placeholderKey: '' - name: Synthetic name label: Side effects limiting daily life labelKey: >- categories.weightLoss.form.steps.previousMedicationDetails.fields.sideEffects.label validation: type: text required: true placeholder: '' placeholderKey: '' options: [] metadata: {} titleKey: >- categories.weightLoss.form.steps.previousMedicationDetails.title whyWeAsk: >- categories.weightLoss.form.steps.previousMedicationDetails.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.previousMedicationDetails.whyWeAsk errorMessage: '' bmiValidation: null descriptionKey: '' legacy_step_id: 9 placeholderKey: '' errorMessageKey: '' helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: value: never_used stepId: 8 operator: not_equals fieldName: selected helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 10 key: weight_loss-10-height_weight kind: multi type: multi-select order: 13 title: >- categories.weightLoss.form.steps.eatingDisorderHistory.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.active_disorder value: active_disorder labelKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.active_disorder requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.binge_eating value: binge_eating labelKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.binge_eating requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.restrictive value: restrictive labelKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.restrictive requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.anorexia_bulimia value: anorexia_bulimia labelKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.anorexia_bulimia requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.none value: none labelKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.options.none requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.title whyWeAsk: >- categories.weightLoss.form.steps.eatingDisorderHistory.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.eatingDisorderHistory.error bmiValidation: null descriptionKey: '' legacy_step_id: 10 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.eatingDisorderHistory.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 11 key: weight_loss-11-height_weight kind: multi type: multi-select order: 14 title: >- categories.weightLoss.form.steps.exclusionCriteria.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.mtc_men2 value: mtc_men2 labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.mtc_men2 requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.pancreatitis_history value: pancreatitis_history labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.pancreatitis_history requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.advanced_renal_insufficiency value: advanced_renal_insufficiency labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.advanced_renal_insufficiency requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.diabetic_retinopathy value: diabetic_retinopathy labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.diabetic_retinopathy requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.decompensated_heart_disease value: decompensated_heart_disease labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.decompensated_heart_disease requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.symptomatic_hypotension value: symptomatic_hypotension labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.symptomatic_hypotension requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.severe_systemic_disorders value: severe_systemic_disorders labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.severe_systemic_disorders requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.any_serious_illness value: any_serious_illness labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.any_serious_illness requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.exclusionCriteria.options.none value: none labelKey: >- categories.weightLoss.form.steps.exclusionCriteria.options.none requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.exclusionCriteria.title whyWeAsk: >- categories.weightLoss.form.steps.exclusionCriteria.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.exclusionCriteria.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.exclusionCriteria.error bmiValidation: null descriptionKey: '' legacy_step_id: 11 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.exclusionCriteria.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 180 - id: 12 key: weight_loss-12-height_weight kind: multi type: multi-select order: 15 title: categories.weightLoss.form.steps.lifestyle.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.lifestyle.options.sedentary value: sedentary labelKey: >- categories.weightLoss.form.steps.lifestyle.options.sedentary requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.lifestyle.options.emotional_eating value: emotional_eating labelKey: >- categories.weightLoss.form.steps.lifestyle.options.emotional_eating requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.lifestyle.options.smoking value: smoking labelKey: >- categories.weightLoss.form.steps.lifestyle.options.smoking requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.lifestyle.options.heavy_alcohol value: heavy_alcohol labelKey: >- categories.weightLoss.form.steps.lifestyle.options.heavy_alcohol requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.lifestyle.options.none value: none labelKey: >- categories.weightLoss.form.steps.lifestyle.options.none requiresAdditionalInfo: false metadata: {} titleKey: categories.weightLoss.form.steps.lifestyle.title whyWeAsk: >- categories.weightLoss.form.steps.lifestyle.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.lifestyle.whyWeAsk errorMessage: categories.weightLoss.form.steps.lifestyle.error bmiValidation: null descriptionKey: '' legacy_step_id: 12 placeholderKey: '' errorMessageKey: categories.weightLoss.form.steps.lifestyle.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 180 - id: 20 key: weight_loss-allergies kind: multi type: multi-select order: 16 title: categories.weightLoss.form.steps.allergies.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.allergies.options.glp1 value: glp1_allergy labelKey: >- categories.weightLoss.form.steps.allergies.options.glp1 requiresAdditionalInfo: false - flag: caution image: '' label: >- categories.weightLoss.form.steps.allergies.options.orlistat value: orlistat_allergy labelKey: >- categories.weightLoss.form.steps.allergies.options.orlistat clinicalFlag: exclude_orlistat requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.allergies.options.other value: other_allergy labelKey: >- categories.weightLoss.form.steps.allergies.options.other requiresAdditionalInfo: true - image: '' label: >- categories.weightLoss.form.steps.allergies.options.none value: none labelKey: >- categories.weightLoss.form.steps.allergies.options.none requiresAdditionalInfo: false metadata: {} titleKey: categories.weightLoss.form.steps.allergies.title whyWeAsk: '' helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: '' errorMessage: categories.weightLoss.form.steps.allergies.error bmiValidation: null descriptionKey: '' legacy_step_id: 20 placeholderKey: '' errorMessageKey: categories.weightLoss.form.steps.allergies.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 6 key: weight_loss-06-height_weight kind: multi type: multi-select order: 17 title: >- categories.weightLoss.form.steps.personalHistory.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.personalHistory.options.endocrine value: endocrine labelKey: >- categories.weightLoss.form.steps.personalHistory.options.endocrine requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.personalHistory.options.gastrointestinal value: gastrointestinal labelKey: >- categories.weightLoss.form.steps.personalHistory.options.gastrointestinal requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.personalHistory.options.psychiatric value: psychiatric labelKey: >- categories.weightLoss.form.steps.personalHistory.options.psychiatric requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.personalHistory.options.other value: other labelKey: >- categories.weightLoss.form.steps.personalHistory.options.other requiresAdditionalInfo: true - image: '' label: >- categories.weightLoss.form.steps.personalHistory.options.none value: none labelKey: >- categories.weightLoss.form.steps.personalHistory.options.none requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.personalHistory.title whyWeAsk: '' helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: '' errorMessage: >- categories.weightLoss.form.steps.personalHistory.error bmiValidation: null descriptionKey: '' legacy_step_id: 6 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.personalHistory.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 15 key: weight_loss-currentmedications kind: multi type: multi-select order: 18 title: >- categories.weightLoss.form.steps.currentMedications.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.currentMedications.options.insulin value: insulin labelKey: >- categories.weightLoss.form.steps.currentMedications.options.insulin requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.currentMedications.options.sulfonylureas value: sulfonylureas labelKey: >- categories.weightLoss.form.steps.currentMedications.options.sulfonylureas requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.currentMedications.options.blood_pressure value: blood_pressure labelKey: >- categories.weightLoss.form.steps.currentMedications.options.blood_pressure requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.currentMedications.options.thyroid_meds value: thyroid_meds labelKey: >- categories.weightLoss.form.steps.currentMedications.options.thyroid_meds requiresAdditionalInfo: false - image: '' label: >- categories.weightLoss.form.steps.currentMedications.options.other value: other labelKey: >- categories.weightLoss.form.steps.currentMedications.options.other requiresAdditionalInfo: true - image: '' label: >- categories.weightLoss.form.steps.currentMedications.options.none value: none labelKey: >- categories.weightLoss.form.steps.currentMedications.options.none requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.currentMedications.title whyWeAsk: >- categories.weightLoss.form.steps.currentMedications.whyWeAsk helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: >- categories.weightLoss.form.steps.currentMedications.whyWeAsk errorMessage: >- categories.weightLoss.form.steps.currentMedications.error bmiValidation: null descriptionKey: '' legacy_step_id: 15 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.currentMedications.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 90 - id: 13 key: weight_loss-13-height_weight kind: multi type: multi-select order: 19 title: >- categories.weightLoss.form.steps.additionalInfo.title fields: [] options: - image: '' label: >- categories.weightLoss.form.steps.additionalInfo.options.yes value: 'yes' labelKey: >- categories.weightLoss.form.steps.additionalInfo.options.yes requiresAdditionalInfo: true - image: '' label: >- categories.weightLoss.form.steps.additionalInfo.options.none value: none labelKey: >- categories.weightLoss.form.steps.additionalInfo.options.none requiresAdditionalInfo: false metadata: {} titleKey: >- categories.weightLoss.form.steps.additionalInfo.title whyWeAsk: '' helpLinks: [] optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: '' errorMessage: >- categories.weightLoss.form.steps.additionalInfo.error bmiValidation: null descriptionKey: '' legacy_step_id: 13 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.additionalInfo.error helpDescription: '' cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 180 - id: 14 key: weight_loss-14-height_weight kind: confirm type: checkbox-confirmation order: 20 title: >- categories.weightLoss.form.steps.sideEffectsInfo.title fields: [] options: [] metadata: {} titleKey: >- categories.weightLoss.form.steps.sideEffectsInfo.title whyWeAsk: '' helpLinks: - url: /medications/safety/semaglutide label: >- categories.weightLoss.form.steps.sideEffectsInfo.links.wegovy - url: /medications/safety/tirzepatide label: >- categories.weightLoss.form.steps.sideEffectsInfo.links.mounjaro optionKey: '' inputField: null placeholder: '' reusePolicy: confirm whyWeAskKey: '' errorMessage: >- categories.weightLoss.form.steps.sideEffectsInfo.error bmiValidation: null descriptionKey: '' legacy_step_id: 14 placeholderKey: '' errorMessageKey: >- categories.weightLoss.form.steps.sideEffectsInfo.error helpDescription: >- categories.weightLoss.form.steps.sideEffectsInfo.description cautionMessageKey: '' compoundExclusions: [] conditionalDisplay: null helpDescriptionKey: '' bmiConditionalDisplay: null reuseExpiresAfterDays: 180 title: categories.weightLoss.form.title status: published renewal: origin: null changed: null is_glp1: false treatment_id: null version: 5 titleKey: categories.weightLoss.form.title form_type: weight_loss version_id: cf1867b4-7048-593b-a0a3-cd1d0c0672e8 schema_hash: category_slug: weight-loss answer_status_snapshot: weight_loss-02-gender: answered_current_form weight_loss-allergies: answered_current_form weight_loss-01-country: answered_current_form weight_loss-03-height_weight: answered_current_form weight_loss-04-height_weight: answered_current_form weight_loss-05-height_weight: missing weight_loss-06-height_weight: answered_current_form weight_loss-07-height_weight: answered_current_form weight_loss-08-height_weight: answered_current_form weight_loss-09-height_weight: missing weight_loss-10-height_weight: answered_current_form weight_loss-11-height_weight: answered_current_form weight_loss-12-height_weight: answered_current_form weight_loss-13-height_weight: answered_current_form weight_loss-14-height_weight: answered_current_form weight_loss-currentmedications: answered_current_form weight_loss-previous-medication-which: missing weight_loss-previous-medication-dose-wegovy: missing weight_loss-previous-medication-dose-saxenda: missing weight_loss-previous-medication-dose-mounjaro: missing is_completed: true created_at: '2026-10-05T18:21:11.888598Z' prescriptions: - brand: slug: hi-doctor display_name: Synthetic display name primary_color: '#157a5c' id: 8d3560b9-357b-50fe-b1b0-7bef4ffa703b consultation_id: b0e81246-c46e-5ac2-9675-06bf07784bf4 adhoc_session_id: null patient_id: 9fb1a263-c71b-5fe9-b2e7-5a0eb099bad5 doctor_id: 1d1b5b46-00a7-5c1d-92eb-38a387a8f14d provider: english treatment_id: mounjaro dosage: 2.5 mg prescribed_label: >- Tirzepatide (Mounjaro KwikPen) solution for injection ยท 2.5 mg consultation_treatment_label: Mounjaro rempe_treatment_id: null pdf_file: null english_pdf_file: >- https://api.hi-doctor.ai/v1/users/prescriptions/8d3560b9-357b-50fe-b1b0-7bef4ffa703b/pdf/english/ status: active medication_name: Tirzepatide (Mounjaro KwikPen) solution for injection medication_strength: 2.5 mg medication_form: Pre-filled pen dosage_instructions: 'Synthetic example: 2.5 mg once weekly' duration_text: 4 weeks dispensing_notes: '' additional_notes: Synthetic example rx_language: es dispensing_country: ESP expires_at: '2026-10-15T18:33:16.401440Z' collected_at: null is_expired: false days_to_collect: 10 created_at: '2026-10-05T18:33:16.402018Z' updated_at: '2026-10-05T18:33:20.457634Z' payments: - brand: slug: hi-doctor display_name: Synthetic display name primary_color: '#157a5c' id: cebab43a-1ea6-5784-9726-a8b2b5464dcc consultation_id: b0e81246-c46e-5ac2-9675-06bf07784bf4 patient_email: synthetic-patient@example.invalid patient_id: 9fb1a263-c71b-5fe9-b2e7-5a0eb099bad5 provider: stripe provider_payment_id: provider_checkout_id: null provider_order_id: null provider_order_name: null subscription_id: 778e8448-583f-5228-9015-1f578f92f1de is_recurring: true billing_reason: subscription_create amount_cents: 2500 refunded_amount_cents: 0 net_amount_cents: 2500 currency: EUR status: succeeded failure_code: '' failed_at: null description: '' payment_method_type: '' payment_method_brand: '' payment_method_last4: '' captured_at: '2026-10-05T18:25:10Z' invoice_url: >- https://api.hi-doctor.ai/v1/users/payments/cebab43a-1ea6-5784-9726-a8b2b5464dcc/invoice/ invoice_number: HD-20261005-EA0057AA credit_notes: [] refund: null created_at: '2026-10-05T18:25:13.666323Z' updated_at: '2026-10-05T18:25:14.894272Z' images: - id: edd88e14-d21c-5c30-91ef-ed80e255aea1 url: >- https://api.hi-doctor.ai/v1/questionnaire/consultations/b0e81246-c46e-5ac2-9675-06bf07784bf4/images/edd88e14-d21c-5c30-91ef-ed80e255aea1/content/ filename: synthetic-test.png uploaded_at: '2026-10-05T18:25:24.513093Z' consultation_id: b0e81246-c46e-5ac2-9675-06bf07784bf4 available: true created_at: '2026-10-05T18:25:13.767058Z' updated_at: '2026-10-05T18:25:25.459941Z' decided_at: '2026-10-05T18:25:25.251894Z' description: Successful get a consultation. '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: The account lacks permission for this operation. 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: You do not have permission to perform this action. '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: examples: example-1: summary: Illustrative response example value: detail: No Consultation matches the given query. 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: {} '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/consultations/${HD_PATH_ID:?Set the path fixture}/${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" curl --silent --show-error --max-time 30 --request GET \ --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' \ "$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/consultations/{id}/' url = url.replace('{id}', quote(os.environ['HD_PATH_ID'], safe="")) 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 = {} response = requests.request('GET', 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/consultations/{id}/"; url = url.replace("{id}", encodeURIComponent(env.HD_PATH_ID)); 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: "GET", headers, redirect: "manual", signal: AbortSignal.timeout(30000) }; 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: Consultation: type: object properties: id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. user: allOf: - $ref: '#/components/schemas/PatientConsultationParticipant' readOnly: true description: User for this consultation. Returned by the server; not writable. doctor: anyOf: - allOf: - $ref: '#/components/schemas/Doctor' readOnly: true description: >- Doctor for this consultation. Returned by the server; not writable. - enum: - null type: string nullable: true description: Assigned doctor, or null before assignment. shopify_order_id: type: integer nullable: true description: Identifier of the related order. May be null when unavailable. status: allOf: - $ref: '#/components/schemas/ConsultationStatusEnum' description: Status for this consultation. origin: allOf: - $ref: '#/components/schemas/OriginEnum' description: Origin for this consultation. plan: allOf: - $ref: '#/components/schemas/PlanBb6Enum' readOnly: true description: Plan for this consultation. Returned by the server; not writable. supply_days: type: integer nullable: true readOnly: true description: >- Supply days for this consultation. Returned by the server; not writable. May be null when unavailable. patient_choice_status: oneOf: - $ref: '#/components/schemas/PatientChoiceStatusEnum' - $ref: '#/components/schemas/BlankEnum' description: Patient choice status for this consultation. patient_choice_requested_at: type: string format: date-time nullable: true description: >- Patient choice requested at timestamp in ISO 8601 format. May be null when unavailable. patient_choice_confirmed_at: type: string format: date-time nullable: true description: >- Patient choice confirmed at timestamp in ISO 8601 format. May be null when unavailable. decision_reason: type: string nullable: true description: Decision reason for this consultation. May be null when unavailable. treatment_id: type: string nullable: true maxLength: 255 description: >- Identifier of the related treatment. May be null when unavailable. Maximum 255 characters. dosage: type: string nullable: true maxLength: 255 description: >- Dosage for this consultation. May be null when unavailable. Maximum 255 characters. form_snapshot: type: array items: type: object additionalProperties: {} nullable: true description: Form snapshot for this consultation. May be null when unavailable. questionnaire_submission: readOnly: true anyOf: - $ref: '#/components/schemas/QuestionnaireSubmission' - enum: - null type: string nullable: true description: >- Questionnaire submission for this consultation. Returned by the server; not writable. prescriptions: type: array items: $ref: '#/components/schemas/Prescription' readOnly: true description: >- Prescriptions for this consultation. Returned by the server; not writable. payments: type: array items: $ref: '#/components/schemas/Payment' readOnly: true description: >- Payments for this consultation. Returned by the server; not writable. images: type: array items: $ref: '#/components/schemas/ConsultationImage' readOnly: true description: Images for this consultation. 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. updated_at: type: string format: date-time readOnly: true description: >- Updated at timestamp in ISO 8601 format. Returned by the server; not writable. decided_at: type: string format: date-time nullable: true description: >- Decided at timestamp in ISO 8601 format. May be null when unavailable. brand: allOf: - $ref: '#/components/schemas/BrandSummary' readOnly: true description: Clinical brand associated with the patient. renewal_changed: type: boolean nullable: true readOnly: true description: >- Whether the patient reported changed renewal answers; null before a choice. renewal_questionnaire_required: type: boolean readOnly: true description: Whether this pending renewal needs a patient questionnaire. required: - created_at - doctor - id - images - payments - plan - prescriptions - questionnaire_submission - supply_days - updated_at - user PatientConsultationParticipant: type: object properties: id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. first_name: type: string maxLength: 150 description: >- First name for this patient consultation participant. Maximum 150 characters. last_name: type: string maxLength: 150 description: >- Last name for this patient consultation participant. Maximum 150 characters. email: type: string format: email maxLength: 254 description: Account email address. Maximum 254 characters. locale: allOf: - $ref: '#/components/schemas/LocaleEnum' description: Preferred email locale. date_of_birth: type: string format: date nullable: true description: >- Date of birth as an ISO 8601 calendar date. May be null when unavailable. 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 address_line1: type: string nullable: true description: >- Street address (line 1) used for pharmacy delivery. Required for Ireland patients. maxLength: 200 issuing_state: type: string nullable: true description: ISO 3166-1 alpha-3 country code maxLength: 3 document_number: type: string nullable: true maxLength: 50 description: >- Document number for this patient consultation participant. May be null when unavailable. Maximum 50 characters. document_type: oneOf: - $ref: '#/components/schemas/DocumentTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' description: Document type for this patient consultation participant. consultation_count: type: integer readOnly: true default: 0 description: >- Consultation count for this patient consultation participant. Returned by the server; not writable. total_spent_cents: type: integer readOnly: true default: 0 description: >- Total spent cents for this patient consultation participant. Returned by the server; not writable. total_refunded_cents: type: integer readOnly: true default: 0 description: >- Total refunded cents for this patient consultation participant. Returned by the server; not writable. net_spent_cents: type: integer readOnly: true description: >- Net spent cents for this patient consultation participant. Returned by the server; not writable. subscription_status: type: string readOnly: true nullable: true description: >- Subscription status for this patient consultation participant. Returned by the server; not writable. May be null when unavailable. required: - consultation_count - email - id - net_spent_cents - subscription_status - total_refunded_cents - total_spent_cents Doctor: type: object properties: id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. first_name: type: string maxLength: 150 description: First name for this doctor. Maximum 150 characters. last_name: type: string maxLength: 150 description: Last name for this doctor. Maximum 150 characters. email: type: string format: email maxLength: 254 description: Account email address. Maximum 254 characters. 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: - legacy_docalo - checkout - subscription_initial - subscription_included - subscription_renewal type: string PlanBb6Enum: enum: - one_off - subscription type: string PatientChoiceStatusEnum: enum: - awaiting - confirmed - waived type: string BlankEnum: enum: - '' QuestionnaireSubmission: type: object properties: id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. category: type: string format: uuid readOnly: true description: >- Category for this questionnaire submission. Returned by the server; not writable. category_slug: type: string readOnly: true description: >- Category slug for this questionnaire submission. Returned by the server; not writable. category_label: type: string readOnly: true description: >- Category label for this questionnaire submission. Returned by the server; not writable. version: type: string format: uuid readOnly: true description: >- Version for this questionnaire submission. Returned by the server; not writable. form_type: readOnly: true oneOf: - $ref: '#/components/schemas/FormTypeEnum' - $ref: '#/components/schemas/NullEnum' description: >- Form type for this questionnaire submission. Returned by the server; not writable. answers: type: array items: {} readOnly: true description: >- Submitted answer records in questionnaire order. The backend stores JSON; this is not a client authorization or eligibility instruction. schema_snapshot: type: object additionalProperties: {} readOnly: true description: >- Questionnaire definition saved with the submission. Returned by the server; not writable. answer_status_snapshot: type: object additionalProperties: {} readOnly: true description: >- Answer status snapshot for this questionnaire submission. Returned by the server; not writable. is_completed: type: boolean readOnly: true description: >- Whether required questionnaire fields have been completed. 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. required: - answer_status_snapshot - answers - category - category_label - category_slug - created_at - form_type - id - is_completed - schema_snapshot - version Prescription: type: object description: >- Serializer for prescriptions - includes treatment_id and dosage from consultation. properties: brand: readOnly: true description: >- Brand for this prescription. Returned by the server; not writable. May be null when unavailable. anyOf: - $ref: '#/components/schemas/BrandSummary' - enum: - null type: string nullable: true id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. consultation_id: type: string format: uuid readOnly: true nullable: true description: >- Identifier of the related consultation. Returned by the server; not writable. May be null when unavailable. adhoc_session_id: type: string format: uuid nullable: true readOnly: true description: >- Identifier of the related adhoc session. Returned by the server; not writable. May be null when unavailable. patient_id: type: string format: uuid readOnly: true nullable: true description: >- Identifier of the related patient. Returned by the server; not writable. May be null when unavailable. doctor_id: type: string format: uuid readOnly: true nullable: true description: >- Identifier of the related doctor. Returned by the server; not writable. May be null when unavailable. provider: allOf: - $ref: '#/components/schemas/Provider0ceEnum' description: >- Which prescription pipeline produced this row: `rempe` (national e-prescription) or `english` (English PDF). 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 nullable: true readOnly: true description: >- Dosage for this prescription. Returned by the server; not writable. May be null when unavailable. prescribed_label: type: string readOnly: true description: >- Prescribed label for this prescription. Returned by the server; not writable. consultation_treatment_label: type: string nullable: true readOnly: true description: >- Consultation treatment label for this prescription. Returned by the server; not writable. May be null when unavailable. rempe_treatment_id: type: string nullable: true maxLength: 255 description: >- Identifier of the related national e-prescription treatment. May be null when unavailable. Maximum 255 characters. pdf_file: type: string format: uri nullable: true readOnly: true description: >- Pdf file for this prescription. Returned by the server; not writable. May be null when unavailable. english_pdf_file: type: string format: uri nullable: true readOnly: true description: >- English pdf file for this prescription. Returned by the server; not writable. May be null when unavailable. status: allOf: - $ref: '#/components/schemas/StatusEbdEnum' description: Status for this prescription. medication_name: type: string maxLength: 255 description: Medication name for this prescription. Maximum 255 characters. medication_strength: type: string maxLength: 255 description: Medication strength for this prescription. Maximum 255 characters. medication_form: type: string maxLength: 255 description: Medication form for this prescription. Maximum 255 characters. dosage_instructions: type: string description: Dosage instructions for this prescription. duration_text: type: string maxLength: 255 description: Duration text for this prescription. Maximum 255 characters. dispensing_notes: type: string description: Dispensing notes for this prescription. additional_notes: type: string description: Additional notes for this prescription. rx_language: type: string maxLength: 8 description: Rx language for this prescription. Maximum 8 characters. dispensing_country: type: string nullable: true maxLength: 3 description: >- Dispensing country for this prescription. May be null when unavailable. Maximum 3 characters. expires_at: type: string format: date-time nullable: true description: >- Expires at timestamp in ISO 8601 format. May be null when unavailable. collected_at: type: string format: date-time nullable: true description: >- Collected at timestamp in ISO 8601 format. May be null when unavailable. is_expired: type: boolean readOnly: true description: >- Whether expired applies to this prescription. Returned by the server; not writable. days_to_collect: type: integer nullable: true readOnly: true description: >- Days to collect for this prescription. Returned by the server; not writable. May be null when unavailable. created_at: type: string format: date-time readOnly: true description: >- Created at timestamp in ISO 8601 format. Returned by the server; not writable. updated_at: type: string format: date-time readOnly: true description: >- Updated at timestamp in ISO 8601 format. Returned by the server; not writable. required: - adhoc_session_id - brand - consultation_id - consultation_treatment_label - created_at - days_to_collect - doctor_id - dosage - english_pdf_file - id - is_expired - patient_id - pdf_file - prescribed_label - treatment_id - updated_at Payment: type: object properties: brand: allOf: - $ref: '#/components/schemas/BrandSummary' readOnly: true description: Brand for this payment. Returned by the server; not writable. id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. consultation_id: type: string format: uuid readOnly: true description: >- Identifier of the related consultation. Returned by the server; not writable. patient_email: type: string format: email readOnly: true description: >- Patient email for this payment. Returned by the server; not writable. patient_id: type: string format: uuid readOnly: true description: >- Identifier of the related patient. Returned by the server; not writable. provider: allOf: - $ref: '#/components/schemas/Provider906Enum' description: Provider for this payment. provider_payment_id: type: string nullable: true maxLength: 255 description: >- Identifier of the related provider payment. May be null when unavailable. Maximum 255 characters. provider_checkout_id: type: string nullable: true maxLength: 255 description: >- Identifier of the related provider checkout. May be null when unavailable. Maximum 255 characters. provider_order_id: type: string nullable: true maxLength: 255 description: >- Identifier of the related provider order. May be null when unavailable. Maximum 255 characters. provider_order_name: type: string nullable: true maxLength: 100 description: >- Provider order name for this payment. May be null when unavailable. Maximum 100 characters. subscription_id: type: string format: uuid nullable: true readOnly: true description: >- Identifier of the related subscription. Returned by the server; not writable. May be null when unavailable. is_recurring: type: boolean description: Whether recurring applies to this payment. billing_reason: type: string maxLength: 50 description: Billing reason for this payment. Maximum 50 characters. amount_cents: type: integer description: Amount cents for this payment. refunded_amount_cents: type: integer description: Refunded amount cents for this payment. net_amount_cents: type: integer readOnly: true description: >- Net amount cents for this payment. Returned by the server; not writable. currency: type: string maxLength: 3 description: Currency for this payment. Maximum 3 characters. status: allOf: - $ref: '#/components/schemas/PaymentStatusEnum' description: Status for this payment. failure_code: type: string maxLength: 100 description: Failure code for this payment. Maximum 100 characters. failed_at: type: string format: date-time nullable: true description: >- Failed at timestamp in ISO 8601 format. May be null when unavailable. description: type: string maxLength: 255 description: Description for this payment. Maximum 255 characters. payment_method_type: type: string maxLength: 50 description: Payment method type for this payment. Maximum 50 characters. payment_method_brand: type: string maxLength: 50 description: Payment method brand for this payment. Maximum 50 characters. payment_method_last4: type: string maxLength: 4 description: Payment method last4 for this payment. Maximum 4 characters. captured_at: type: string format: date-time nullable: true description: >- Captured at timestamp in ISO 8601 format. May be null when unavailable. invoice_url: type: string format: uri readOnly: true description: Invoice url for this payment. Returned by the server; not writable. invoice_number: type: string readOnly: true description: >- Invoice number for this payment. Returned by the server; not writable. credit_notes: type: array items: $ref: '#/components/schemas/PaymentCreditNote' readOnly: true description: Credit notes for this payment. Returned by the server; not writable. refund: readOnly: true description: >- Refund for this payment. Returned by the server; not writable. May be null when unavailable. anyOf: - $ref: '#/components/schemas/PaymentRefund' - enum: - null type: string nullable: true created_at: type: string format: date-time readOnly: true description: >- Created at timestamp in ISO 8601 format. Returned by the server; not writable. updated_at: type: string format: date-time readOnly: true description: >- Updated at timestamp in ISO 8601 format. Returned by the server; not writable. required: - brand - consultation_id - created_at - credit_notes - id - invoice_number - invoice_url - net_amount_cents - patient_email - patient_id - provider - refund - subscription_id - updated_at ConsultationImage: 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 maxLength: 255 description: Filename for this consultation image. Maximum 255 characters. uploaded_at: type: string format: date-time readOnly: true description: >- Uploaded at timestamp in ISO 8601 format. Returned by the server; not writable. consultation_id: type: string format: uuid readOnly: true description: >- Identifier of the related consultation. Returned by the server; not writable. available: type: boolean readOnly: true description: >- Whether available applies to this consultation image. Returned by the server; not writable. required: - available - consultation_id - filename - id - uploaded_at - url BrandSummary: type: object properties: slug: type: string description: Slug for this brand summary. display_name: type: string description: Display name for this brand summary. primary_color: type: string description: Primary color for this brand summary. required: - display_name - primary_color - slug LocaleEnum: enum: - de - en - es - fr - it - nl - pt type: string DocumentTypeEnum: enum: - PASSPORT - ID_CARD type: string NullEnum: enum: - null type: string nullable: true FormTypeEnum: enum: - hair_growth - weight_loss - sexual_health - premature_ejaculation - chlamydia - urinary_tract_infection - emergency_contraception - hiv_prep - dermatology_acne - dermatology_rosacea - dermatology_melasma - dermatology_antiaging 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 PaymentCreditNote: type: object properties: id: type: string format: uuid description: Unique identifier of this resource. number: type: string description: Number for this payment credit note. amount_cents: type: integer description: Amount cents for this payment credit note. currency: type: string description: Currency for this payment credit note. issued_at: type: string format: date-time description: Issued at timestamp in ISO 8601 format. url: type: string format: uri description: URL returned for this resource; provider links may expire. required: - amount_cents - currency - id - issued_at - number - url PaymentRefund: type: object properties: id: type: string format: uuid readOnly: true description: >- Unique identifier of this resource. Returned by the server; not writable. provider: allOf: - $ref: '#/components/schemas/Provider906Enum' description: Provider for this payment refund. provider_refund_id: type: string nullable: true maxLength: 255 description: >- Identifier of the related provider refund. May be null when unavailable. Maximum 255 characters. amount_cents: type: integer description: Amount cents for this payment refund. currency: type: string maxLength: 3 description: Currency for this payment refund. Maximum 3 characters. status: allOf: - $ref: '#/components/schemas/PaymentRefundStatusEnum' description: Status for this payment refund. reason: type: string description: Reason for this payment refund. requested_by_email: type: string format: email readOnly: true nullable: true description: >- Requested by email for this payment refund. Returned by the server; not writable. May be null when unavailable. requested_at: type: string format: date-time description: Requested at timestamp in ISO 8601 format. completed_at: type: string format: date-time nullable: true description: >- Completed at timestamp in ISO 8601 format. May be null when unavailable. destination_reference: type: string nullable: true readOnly: true description: >- Destination reference for this payment refund. Returned by the server; not writable. May be null when unavailable. destination_reference_status: type: string nullable: true readOnly: true description: >- Destination reference status for this payment refund. Returned by the server; not writable. May be null when unavailable. destination_reference_type: type: string nullable: true readOnly: true description: >- Destination reference type for this payment refund. Returned by the server; not writable. May be null when unavailable. created_at: type: string format: date-time readOnly: true description: >- Created at timestamp in ISO 8601 format. Returned by the server; not writable. updated_at: type: string format: date-time readOnly: true description: >- Updated at timestamp in ISO 8601 format. Returned by the server; not writable. required: - created_at - destination_reference - destination_reference_status - destination_reference_type - id - provider - requested_by_email - updated_at PaymentRefundStatusEnum: enum: - pending - processing - succeeded - failed - canceled type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.