Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Path Parameters

prescription_id
string<uuid>
required

The prescription id.

Response

Success.

id
string<uuid>
required

The prescription id.

consultation_id
string<uuid> | null
required

The consultation this belongs to.

status
enum<string>
required

issued until the prescription is cancelled. It does not say whether the prescription can still be used: read active, and compare expires_at yourself.

Available options:
issued,
cancelled
active
boolean
required

false once the prescription is cancelled or no longer published to the patient, for example after a dispensing is recorded during a manual recovery. It does not check expiry: an expired prescription can stay active true, so compare expires_at yourself.

issued_at
string<date-time> | null
required

When the prescription was issued.

cancelled_at
string<date-time> | null
required

When the prescription was cancelled; null if it was not.

expires_at
string<date-time> | null
required

When the prescription expires, or null when not recorded. Always null in test mode.

dispensing_country
string | null
required

ISO 3166-1 alpha-2 country where the prescription is dispensed, or null when not recorded. Always null in test mode.

medication
object
required

The prescribed medication.

fulfilment
object
required

How the patient obtains the medication.

collected_at
string<date-time> | null
required

When the medication was collected, when known; otherwise null.

replaced_by
string<uuid> | null
required

The prescription that replaced this one.