List the prescription book

Any signed in user. Returns prescriptions with prescriber, status, line count, newest first. from_date and to_date bound the created date, and the retention note names the keep period.

GET/api/v1/compliance/prescription-book

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

from_datestring

Only prescriptions created on or after this date. Empty applies no lower bound.

to_datestring

Only prescriptions created on or before this date. Empty applies no upper bound.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 50.

Responses

200

A page of the prescription book

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

rx_numberstringrequired

patient_namestringrequired

patient_id_numberstringrequired

prescriber_namestringrequired

prescriber_licensestringrequired

statusstringrequired

created_atstringrequired

created_by_namestring | nullrequired

line_countintegerrequired

min -9007199254740991 · max 9007199254740991

retention_notestringrequired

401

Not authenticated

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

from_datequeryOnly prescriptions created on or after this date. Empty applies no lower bound.to_datequeryOnly prescriptions created on or before this date. Empty applies no upper bound.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 50.

Request

curl -X GET 'http://localhost:8000/api/v1/compliance/prescription-book' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/compliance/prescription-book", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/compliance/prescription-book",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "rx_number": "string",
      "patient_name": "string",
      "patient_id_number": "string",
      "prescriber_name": "string",
      "prescriber_license": "string",
      "status": "string",
      "created_at": "string",
      "created_by_name": "string",
      "line_count": -9007199254740991
    }
  ],
  "retention_note": "string"
}

{
  "detail": "string"
}