Skip to main content
GET
cURL

Description

Retrieves a single prescription by its SCID (Script ID) for a specific patient.

Path Parameters

  • organization_id (required, string): The unique identifier of the organization.
  • user_id (required, string): The unique identifier of the user making the request.
  • patient_id (required, string): The unique identifier of the patient.
  • scid (required, string): The unique Script ID of the prescription.

Response

Returns the prescription details along with patient and prescriber information:

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:
When there is no error, the error field is omitted from the prescription.

Error Responses

404 Not Found

Returned when the prescription with the specified SCID does not exist for the patient:

401 Unauthorized

Returned when authentication fails or the token is invalid.

400 Bad Request

Returned when required parameters are missing or invalid.

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

scid
string
required

Script ID (SCID) of the prescription

Response

Successfully retrieved prescription

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

Single 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"

code
string

Machine-readable operation code

Example:

"SUCCESS"

pagination
object

Pagination information for list operations