Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
users
/
{user_id}
/
patients
/
{patient_id}
/
prescriptions
cURL
curl --request GET \
  --url https://api.sandbox.parchmenthealth.io/external/v1/organizations/{organization_id}/users/{user_id}/patients/{patient_id}/prescriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'x-organization-secret: <x-organization-secret>'
{
  "success": true,
  "statusCode": 200,
  "message": "Patient prescriptions retrieved successfully",
  "data": {
    "patient": {
      "given_name": "John",
      "family_name": "Smith",
      "date_of_birth": "1990-01-15T00:00:00.000Z",
      "sex": "M",
      "patient_id": "1234567890",
      "partner_patient_id": "PARTNER#12345"
    },
    "prescriber": {
      "given_name": "Dr. Emily",
      "family_name": "Johnson",
      "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae"
    },
    "prescriptions": [
      {
        "prescription_type": "ELECTRONIC",
        "url": "https://egw-etp-int-qrcode-web-au-se.azurewebsites.net/scripts/2F3WFX8J4WQH8T72X9",
        "scid": "2F3WFX8J4WQH8T72X9",
        "status": "Active",
        "created_date": "2025-06-30T00:11:22",
        "item_name": "Sildenafil 100 mg tablet, 4",
        "quantity": "4",
        "number_of_repeats_authorised": "0",
        "repeat_intervals": "0",
        "pbs_code": "",
        "item_strength": "",
        "item_form": "",
        "route_administration": "Oral",
        "pbsdva_authority_number": "0",
        "phone_approval_authority_number": "",
        "schedule_number": "S4",
        "private_prescription": true,
        "emergency_supply": false,
        "brand_substitution_not_allowed": false,
        "reason_for_prescribing": "",
        "patient_instructions": "xcxc",
        "doctor_notes": "",
        "pharmacy_name": "",
        "regulation_24": false,
        "controlled_substance_reference": "",
        "unusual_dose_flag": false,
        "unusual_qty_flag": false,
        "my_sl_consent": true,
        "send_to_pharmacy": "",
        "unlisted_item_repat_authority": false,
        "prescriber_script_number": "19192",
        "custom_drug_details": {
          "custom_product_id": "1234567890"
        },
        "prescriber": {
          "title": "Dr",
          "given_name": "Emily",
          "family_name": "Johnson",
          "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae"
        }
      },
      {
        "prescription_type": "ELECTRONIC",
        "url": "https://egw-etp-int-qrcode-web-au-se.azurewebsites.net/scripts/2F3WFX8B8K66686MVA",
        "scid": "2F3WFX8B8K66686MVA",
        "status": "Ceased",
        "created_date": "2025-04-17T05:09:02",
        "item_name": "Oxycodone hydrochloride 20 mg capsule, 20",
        "quantity": "500",
        "number_of_repeats_authorised": "0",
        "repeat_intervals": "0",
        "pbs_code": "8502L",
        "item_strength": "",
        "item_form": "",
        "route_administration": "Oral",
        "pbsdva_authority_number": "10074227",
        "phone_approval_authority_number": "1234567",
        "schedule_number": "S8",
        "private_prescription": false,
        "emergency_supply": false,
        "brand_substitution_not_allowed": false,
        "reason_for_prescribing": "",
        "patient_instructions": "1x am pm",
        "doctor_notes": "",
        "pharmacy_name": "",
        "regulation_24": false,
        "controlled_substance_reference": "",
        "unusual_dose_flag": false,
        "unusual_qty_flag": false,
        "my_sl_consent": true,
        "send_to_pharmacy": "",
        "unlisted_item_repat_authority": false,
        "prescriber_script_number": "18631",
        "custom_drug_details": {},
        "prescriber": {
          "title": "Dr",
          "given_name": "Emily",
          "family_name": "Johnson",
          "user_id": "8e1c9bab-6614-4723-8981-87c8fa026dae"
        }
      }
    ]
  },
  "timestamp": "2024-01-15T10:30:00.000Z",
  "requestId": "req_1705312200000_yza567",
  "pagination": {
    "count": 1,
    "hasNext": false,
    "limit": 50,
    "offset": 0,
    "lastKey": null
  }
}

​
Pagination

​
Query Parameters

  • limit (optional, integer): Maximum number of prescriptions to return per page (default: 20, max: 50).
  • lastKey (optional, string): Opaque cursor for fetching the next page. Use the pagination.lastKey value from the previous response.

​
Error Status

When a prescription has encountered an error during processing, the status field will be "Error" and an error object will be included with a description: 
{
  "status": "Error",
  "error": {
    "description": "Description of the error that occurred"
  }
}
When there is no error, the error field will be null.

​
Response

If pagination is used, the response will include a pagination object: 
{
  "prescriptions": [ ... ],
  "patient": { ... },
  "prescriber": { ... },
  "pagination": {
    "count": 20,
    "hasNext": true,
    "limit": 20,
    "offset": 0,
    "lastKey": "eyJwayI6ICJQQVRJRU5UIzIwYjA0OTM0LTJjZTUtNDYyOC1iYzZlLWVhMWNkM2I3MjllMyIsICJzayI6ICIyMDI1LTA1LTAyVDA1OjU5OjI3LjM0NFo..."
  }
}
The top-level prescriber field is deprecated. Use prescriptions[].prescriber instead — each prescription carries its own prescriber, including the Parchment user_id. The top-level field is kept for backwards compatibility and will be removed in a future release.
  • count: Number of prescriptions returned in this page.
  • hasNext: Whether more prescriptions are available on subsequent pages.
  • limit: Maximum number of prescriptions per page (as requested).
  • offset: Starting position of the current page (zero-based).
  • lastKey: The string to use as the lastKey query parameter for the next request. If null, there are no more results.

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-organization-secret
string
required

Organization secret for authentication - provided by Parchment

Path Parameters

​
organization_id
string<uuid>
required

Organization ID

​
user_id
string<uuid>
required

User ID

​
patient_id
string<uuid>
required

Patient ID

Query Parameters

​
limit
integer

Number of prescriptions to return

​
lastKey
string

Last key to return

Response

Successfully retrieved prescriptions

​
success
boolean
required

Indicates if the request was successful

Example:

true

​
statusCode
integer
required

HTTP status code

Example:

200

​
message
string
required

Human-readable success message

Example:

"Prescriptions retrieved successfully"

​
data
object
required

Patient prescription data

​
timestamp
string<date-time>
required

ISO 8601 timestamp of the response

Example:

"2024-01-15T10:30:00.000Z"

​
requestId
string
required

Unique identifier for request tracing

Example:

"req_1705312200000_abc123"

​
pagination
object

Pagination information for list operations