Who does what in a partner consultation?
What are the seven steps?
- List your products for a country with
GET /v1/partner/products/. - Fetch the questionnaire schema for the product with
GET /v1/partner/questionnaires/{slug}/. - Upload photos and documents with
POST /v1/partner/files/. Each returns anupload_id. - Submit the consultation with
POST /v1/partner/consultations/: patient, consent, plan, dosage and every answer in one request. - Follow the consultation through webhook events, or read it with
GET /v1/partner/consultations/{id}/. - If the doctor needs more information, answer the information request with structured answers and files.
- When the doctor decides, the consultation becomes
approvedorrejected. Any prescription appears as structured data inprescriptions[].
Which statuses can a consultation have?
There is no
completed status. The clinical outcome lives in decision, each prescription has its own status, and billing state lives in billing. See Consultation lifecycle.
How do test and live mode differ?
Test keys create synthetic consultations that never reach a doctor. You move them through the lifecycle yourself with an explicit test endpoint. See Test mode. Live mode is enabled for each partner by Hi Doctor once the go-live checklist is complete.Frequently asked questions
Who makes the clinical decision in a partner consultation?
The reviewing doctor. Every consultation is reviewed in full by an EU-licensed doctor, who decides on medical grounds only, and the partner never makes or changes that decision.Can a consultation be cancelled?
Yes, while no doctor has opened it. Once a doctor opens the consultation it moves to in_review and can no longer be cancelled.Is there a completed status?
No. The clinical outcome lives in decision, each prescription has its own status, and billing state lives in billing.What happens when the doctor needs more information?
The consultation moves to info_requested and carries an open information request. Your platform answers it with structured answers and files, and the consultation returns to in_review.Does the partner see why a doctor declined?
The partner receives a fixed category in decision.reason_category. The doctor’s own note is never shared.Do test consultations reach a doctor?
No. Test consultations are synthetic, never reach a doctor and only move when you advance them with the test endpoint.Next steps
Quickstart
Run your first test consultation, from key check to a signed webhook.
Consultation lifecycle
The consultation resource, statuses and cancel rule.
Webhooks
Signed events, retries and the ordering rule.