Prescriptions

Retrieve prescription information including doctor data and status, and see how many of your prescriptions are in each status.

Get Prescription Details

GET /v1/management/prescriptions/{prescription_uid}

string

required

The prescription UID

Required permission: prescription:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/prescriptions/px-abc123" \
  -H "X-API-Key: your-api-key-here"

Response

{
  "uid": "px-abc123",
  "status": "signed",
  "doctor": {
    "uid": "doc-456",
    "display_name": "Dr. Schmidt"
  },
  "rendered": true,
  "lines": [
    {
      "uid": "pi-789",
      "order_item_uid": "oi-321",
      "sku_uid": "sku-654",
      "amount": 1,
      "pzn": "12345678",
      "display_name": "Example Cream 50 g",
      "prescription_name": "Example Cream 50 g",
      "product_name": "Example Cream",
      "dosage": "0.1 %",
      "pcs": "1",
      "unit": "g",
      "standard_selling_unit": 50.0,
      "total_paid_amount": 2500,
      "anamnesis_uid": "an-111",
      "note": null,
      "categories": []
    }
  ]
}

Response Fields

Field	Type	Description
`uid`	string	Unique identifier for the prescription
`status`	string	Current prescription status (e.g. `signed`, `waiting for doctor`)
`doctor`	object	The prescribing doctor
`doctor.uid`	string	Doctor UID
`doctor.display_name`	string	Doctor display name
`rendered`	boolean	`true` when a rendered PDF is available for the prescription, `false` otherwise
`lines`	array	The prescribed items, one entry per item
`lines[].uid`	string	Prescription item UID
`lines[].order_item_uid`	string	UID of the order item this line prescribes
`lines[].sku_uid`	string	SKU UID
`lines[].amount`	integer	Prescribed quantity: the doctor’s quantity when one was set, otherwise the ordered quantity
`lines[].pzn`	string \| null	Pharmazentralnummer: the doctor’s PZN when one was set, otherwise the SKU’s
`lines[].display_name`	string \| null	Medication name: the doctor’s medication text when one was set, otherwise the SKU’s display name
`lines[].prescription_name`	string \| null	Name on the prescription: the doctor’s medication text when one was set, otherwise the SKU’s prescription name
`lines[].product_name`	string \| null	Product name
`lines[].dosage`	string \| null	Dosage of the SKU
`lines[].pcs`	string \| null	Pieces per package of the SKU
`lines[].unit`	string \| null	Unit of the SKU
`lines[].standard_selling_unit`	number \| null	Standard selling unit of the SKU
`lines[].total_paid_amount`	integer \| null	Amount paid for the order item, in cents (gross)
`lines[].anamnesis_uid`	string \| null	Anamnesis linked to the order item, `null` when the item has none. Only prescriptions whose lines all have `null` here can be externally signed
`lines[].note`	object \| null	Notes attached to the item during review, as key-value pairs — for example the doctor’s comment keyed by the Unix timestamp it was written at, or `{"hold": "<reason>"}` for a prescription that was put on hold. `null` when there are none
`lines[].categories`	array	Categories of the product
`lines[].categories[].uid`	string	Category UID
`lines[].categories[].name`	string	Category name
`lines[].categories[].type`	string	Category type
`lines[].categories[].priority`	integer	Priority of the category for the product

Error Responses

Status Code	Description
`403`	Missing `prescription:read` permission
`404`	Prescription not found or belongs to another organisation

Get Prescription Statistics

GET /v1/management/prescriptions/statistics

Required permission: prescription:read Returns how many of your organisation’s prescriptions are currently in each status — for example how many are still waiting for a doctor, how many were approved or declined, and how many are signed. Every prescription that belongs to one of your orders is counted once, with its current status. These are the same prescriptions you can retrieve with GET /v1/management/prescriptions/{prescription_uid}. Deleted prescriptions are not counted. The counts reflect the moment of the request; there is no date filter.

Example Request

curl -X GET "https://api.rxscale.com/v1/management/prescriptions/statistics" \
  -H "X-API-Key: your-api-key-here"

Response

{
  "statuses": {
    "waiting for doctor": 12,
    "approved": 3,
    "signed": 140,
    "declined": 9,
    "cancelled": 4,
    "ON_HOLD": 2,
    "NON_QES_SIGNED": 0,
    "EXTERNALLY_SIGNED": 5
  },
  "total": 175
}

Response Fields

Field	Type	Description
`statuses`	object	Number of prescriptions per status. The keys are the values of the `status` field that `GET /v1/management/prescriptions/{prescription_uid}` returns. Every status is always included, with `0` when no prescription has it.
`statuses["waiting for doctor"]`	integer	Waiting for a doctor to review the prescription
`statuses.approved`	integer	Approved by the doctor and not yet signed
`statuses.signed`	integer	Signed with a qualified electronic signature (QES)
`statuses.declined`	integer	Declined by the doctor
`statuses.cancelled`	integer	Cancelled
`statuses.ON_HOLD`	integer	On hold for further review by the support team
`statuses.NON_QES_SIGNED`	integer	Signed without a qualified electronic signature
`statuses.EXTERNALLY_SIGNED`	integer	Signed outside RxScale and registered via external-sign
`total`	integer	Sum of all status counts

Prescriptions that still need a doctor’s decision are counted under waiting for doctor and ON_HOLD. approved prescriptions have a decision but are not signed yet. Signed prescriptions are split across signed, NON_QES_SIGNED, and EXTERNALLY_SIGNED. See Prescription Statuses for what each status means.

Error Responses

Status Code	Description
`401`	Missing or invalid API key
`403`	Missing `prescription:read` permission

Externally Signed Prescriptions

Prescriptions whose items were created with _skip_validation (or _rxscale_skip_validation) on the Shopify line item, on that item’s line item group (for bundles), or in the order-level additional details — i.e. items without an attached anamnesis — can be signed outside the rxscale platform and then registered for fulfilment via the Management API. When more than one level is present, RxScale resolves the setting with a three-level fallback: the line item’s own value wins first, then the value on its line item group, then the order-level value. The flow consists of two API calls:

POST /v1/management/prescriptions/{prescription_uid}/render – asks rxscale to render the unsigned prescription PDF. The endpoint returns immediately; the PDF is produced asynchronously, and rendered becomes true in the prescription details once it is available.
POST /v1/management/prescriptions/{prescription_uid}/external-sign – once the PDF is available, mark the prescription as EXTERNALLY_SIGNED and send it to the pharmacy.

Both endpoints require the prescription:external_sign permission.

Only prescriptions where every item lacks an anamnesis_uid can be externally signed. Mixed prescriptions are rejected with 409 Conflict. You can check this beforehand with lines[].anamnesis_uid in the prescription details.

Render Prescription PDF

POST /v1/management/prescriptions/{prescription_uid}/render

string

required

The prescription UID

Required permission: prescription:external_sign Requests rendering of the unsigned prescription PDF and returns 202 Accepted right away; the PDF is produced asynchronously. Poll GET /v1/management/prescriptions/{prescription_uid} until rendered is true before calling external-sign. Prescriptions that are already signed cannot be rendered again.

Example Request

curl -X POST "https://api.rxscale.com/v1/management/prescriptions/px-abc123/render" \
  -H "X-API-Key: your-api-key-here"

Response (202 Accepted)

{
  "status": "accepted",
  "prescription_uid": "px-abc123"
}

Response Fields

Field	Type	Description
`status`	string	Always `accepted`
`prescription_uid`	string	The prescription UID

Error Responses

Status Code	Description
`403`	Missing `prescription:external_sign` permission
`404`	Prescription not found or belongs to another organisation
`409`	Prescription is already signed (`signed`, `NON_QES_SIGNED` or `EXTERNALLY_SIGNED`) and cannot be rendered again

External-Sign Prescription

POST /v1/management/prescriptions/{prescription_uid}/external-sign

string

required

The prescription UID

Required permission: prescription:external_sign Marks an already-rendered prescription as EXTERNALLY_SIGNED. The endpoint:

Verifies the prescription is in waiting for doctor status, all items lack an anamnesis (lines[].anamnesis_uid is null), and a rendered PDF is available (rendered is true).
Stores the rendered PDF as the signed prescription.
Sets the prescription status to EXTERNALLY_SIGNED and records the change in the prescription’s history, attributed to your API key.
Sends the prescription to the pharmacy.

Example Request

curl -X POST "https://api.rxscale.com/v1/management/prescriptions/px-abc123/external-sign" \
  -H "X-API-Key: your-api-key-here"

Response (200 OK)

{
  "uid": "px-abc123",
  "status": "EXTERNALLY_SIGNED",
  "doctor": null,
  "lines": [
    {
      "uid": "pi-789",
      "order_item_uid": "oi-321",
      "sku_uid": "sku-654",
      "amount": 1,
      "pzn": "12345678",
      "display_name": "Example Cream 50 g",
      "prescription_name": "Example Cream 50 g",
      "product_name": "Example Cream",
      "dosage": "0.1 %",
      "pcs": "1",
      "unit": "g",
      "standard_selling_unit": 50.0,
      "total_paid_amount": 2500,
      "anamnesis_uid": null,
      "note": null,
      "categories": []
    }
  ]
}

Response Fields

Field	Type	Description
`uid`	string	Unique identifier for the prescription
`status`	string	`EXTERNALLY_SIGNED`
`doctor`	object \| null	The doctor assigned to the prescription (`uid`, `display_name`), `null` when no doctor is assigned
`lines`	array	The prescribed items, with the same fields as `lines` in Get Prescription Details

Error Responses

Status Code	Description
`403`	Missing `prescription:external_sign` permission
`404`	Prescription not found or belongs to another organisation
`409`	Prescription is not in `waiting for doctor` status, has at least one item with an anamnesis, or has no rendered PDF yet

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Prescriptions

Prescriptions

Get Prescription Details

Example Request

Response

Response Fields

Error Responses

Get Prescription Statistics

Example Request

Response

Response Fields

Error Responses

Externally Signed Prescriptions

Render Prescription PDF

Example Request

Response (202 Accepted)

Response Fields

Error Responses

External-Sign Prescription

Example Request

Response (200 OK)

Response Fields

Error Responses

​Prescriptions

​Get Prescription Details

​Example Request

​Response

​Response Fields

​Error Responses

​Get Prescription Statistics

​Example Request

​Response

​Response Fields

​Error Responses

​Externally Signed Prescriptions

​Render Prescription PDF

​Example Request

​Response (202 Accepted)

​Response Fields

​Error Responses

​External-Sign Prescription

​Example Request

​Response (200 OK)

​Response Fields

​Error Responses

Prescriptions

Get Prescription Details

Example Request

Response

Response Fields

Error Responses

Get Prescription Statistics

Example Request

Response

Response Fields

Error Responses

Externally Signed Prescriptions

Render Prescription PDF

Example Request

Response (202 Accepted)

Response Fields

Error Responses

External-Sign Prescription

Example Request

Response (200 OK)

Response Fields

Error Responses