Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional key that makes a retry safe. Generate one value per logical operation (8 to 128 ASCII letters, digits, underscores or hyphens) and resend the same value on every retry. A repeat of a completed request returns its original status with Idempotent-Replayed: true and a short body of state, resource_ids and response_hash; read the resources to recover their content. Reusing a key with a different request returns 422 idempotency_key_reuse; a request still running returns 409 idempotency_in_progress. Keys are kept for 30 days. See https://docs.hi-doctor.ai/api-reference/idempotency.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Body

application/json
category
string
required

Category for this early order request. Maximum 50 characters.

Maximum string length: 50
reason
string
default:""

Reason for this early order request. Maximum 500 characters.

Maximum string length: 500
treatment_id
string

Identifier of the related treatment. Maximum 255 characters.

Maximum string length: 255
dosage
string

Dosage for this early order request. Maximum 255 characters.

Maximum string length: 255
changed
boolean
default:false

Whether changed applies to this early order request.

answers
object[]

Answers for this early order request.

change_note
string
default:""

Change note for this early order request. Maximum 1000 characters.

Maximum string length: 1000

Response

Successful request an early subscription order.

consultation_id
string<uuid>
required

Identifier of the related consultation.

subscription
object
required

Subscription for this patient early order response.

patient_choice_status
string
required

Patient choice status for this patient early order response.

dose_change
object | null
required

Dose change for this patient early order response. May be null when unavailable.

treatment_change
object | null
required

Treatment change for this patient early order response. May be null when unavailable.