Skip to content

Prescriptions

The Prescriptions resource represents prescription orders. Prescriptions are read-only.

Endpoints

Method Path Description
GET /Prescriptions List prescriptions
GET /Prescriptions({id}) Get a single prescription

List Prescriptions

GET /Prescriptions

Supports: $filter, $select, $orderby, $top, $skip, $count, $expand

Example

curl -X GET "https://api.nymblqa.com/Prescriptions?\$filter=active eq true&\$orderby=prescription_date desc" \
  -H "Authorization: Bearer eyJraWQiOiJ..." \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "@odata.context": "https://api.nymblqa.com/$metadata#Prescriptions",
  "@odata.count": 320,
  "value": [
    {
      "id": 500,
      "patient_id": 12345,
      "active": true,
      "prescription_date": "2024-03-01",
      "category": "Orthotics",
      "branch_id": 1
    }
  ]
}

Get a Single Prescription

GET /Prescriptions({id})

Example

curl -X GET "https://api.nymblqa.com/Prescriptions(500)" \
  -H "Authorization: Bearer eyJraWQiOiJ..." \
  -H "x-api-key: YOUR_API_KEY"
Property Type Description
Patient Patient The patient this prescription belongs to
ReferringPhysician Physician The referring physician
PrimaryCarePhysician Physician The primary care physician
Branch Branch The branch handling this prescription
Appointments Appointment collection Appointments for this prescription
Claims Claim collection Billing claims for this prescription
InsuranceVerifications InsuranceVerification collection Insurance verifications for this prescription

Properties

Property Type Description
id number Unique prescription identifier (required)
patient_id number Patient ID (required)
active boolean Whether the prescription is active
archived boolean Whether the prescription is archived
branch_id number Branch ID
prescription_date date Date of prescription
category string Prescription category
sub_category string Prescription subcategory
referring_physician_id number Referring physician ID
primary_care_physician_id number Primary care physician ID
face_to_face_exam_date date Date of face-to-face exam
surgery_date date Surgery date
k_level string K-level classification
fabrication_due_date date Fabrication due date
fabrication_start_date date Fabrication start date
fabrication_completed boolean Whether fabrication is complete
fabrication_completed_date date Fabrication completion date
projected_delivery_date date Projected delivery date
delivered_on string Actual delivery date/time
delivery_location string Delivery location description
signed_date date Date prescription was signed
note string General note
comments string Additional comments
source_id number Source system record ID
source_name string Source system name
created_at string Date/time created

Common Query Examples

Active prescriptions for a patient: 

GET /Prescriptions?$filter=patient_id eq 12345 and active eq true

Prescriptions with appointments and claims: 

GET /Prescriptions(500)?$expand=Appointments,Claims

Undelivered prescriptions past due: 

GET /Prescriptions?$filter=active eq true and projected_delivery_date lt 2024-04-01 and delivered_on eq null

Prescriptions by category: 

GET /Prescriptions?$filter=category eq 'Orthotics'&$orderby=prescription_date desc