Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

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

Headers

X-Brand-Slug
string

Brand for this request; use hi-doctor for these examples.

Path Parameters

token
string
required

Opaque verification token from the prescription QR URL; keep private.

Maximum string length: 64

Response

Successful response.

status
enum<string>

Prescription state from the issued record, including canceled.

Available options:
active,
expired,
canceled
issued_at
string<date> | null

Prescription issue date, formatted as YYYY-MM-DD.

expires_at
string<date> | null

Prescription expiry date, formatted as YYYY-MM-DD.

issuer
string

Brand name shown on the issued prescription.

prescriber
object

Public prescriber identity associated with the issued prescription.

patient
object

Masked patient identity for checking the prescription.

medication
object

Medication details from the issued prescription snapshot.