Prescriptions
The Prescriptions API allows you to manage patient medication prescriptions in Jump EHR. Track medications, dosages, and prescription status.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /prescriptions | List all prescriptions |
GET | /prescriptions/{id} | Retrieve a prescription |
POST | /prescriptions | Create a prescription |
PATCH | /prescriptions/{id} | Update a prescription |
Required scopes: read_prescriptions for GET requests, write_prescriptions for POST/PATCH requests.
The Prescription Object
{
"id": "rx_123e4567-e89b-12d3-a456-426614174000",
"patient_id": "pat_456e7890-e89b-12d3-a456-426614174111",
"prescriber_id": "cli_789a0123-e89b-12d3-a456-426614174222",
"display_name": "Metformin 500mg",
"medication_name": "Metformin Hydrochloride",
"dosage": "500",
"dosage_unit": "mg",
"frequency": "twice daily",
"route": "oral",
"quantity": 60,
"refills": 3,
"start_date": "2025-01-15",
"end_date": null,
"status": "active",
"instructions": "Take with meals",
"notes": "For diabetes management",
"created_at": "2025-01-15T10:00:00Z",
"updated_at": "2025-01-15T10:00:00Z"
}Attributes
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier (UUID) |
patient_id | string | Associated patient ID |
prescriber_id | string | Prescribing clinician ID |
display_name | string | Short display name |
medication_name | string | Full medication name |
dosage | string | Dosage amount |
dosage_unit | string | Unit (mg, ml, etc.) |
frequency | string | How often to take |
route | string | Route of administration |
quantity | integer | Amount prescribed |
refills | integer | Number of refills |
start_date | string | Start date (YYYY-MM-DD) |
end_date | string | End date (YYYY-MM-DD) |
status | string | active, stopped, or completed |
instructions | string | Patient instructions |
notes | string | Additional notes |
created_at | string | ISO 8601 creation timestamp |
updated_at | string | ISO 8601 last update timestamp |
List Prescriptions
GET /prescriptionsQuery Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 100 | Number of records (max 100) |
offset | integer | 0 | Pagination offset |
patient_id | string | - | Filter by patient |
status | string | - | Filter by status |
active | boolean | - | Filter active only |
Request
curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/prescriptions?patient_id=pat_456e7890&active=true" \
-H "Authorization: Bearer pk_live_your_api_key"Response
{
"data": [
{
"id": "rx_123e4567-e89b-12d3-a456-426614174000",
"patient_id": "pat_456e7890-e89b-12d3-a456-426614174111",
"display_name": "Metformin 500mg",
"frequency": "twice daily",
"status": "active",
"start_date": "2025-01-15"
}
],
"pagination": {
"total": 1,
"limit": 100,
"offset": 0,
"has_more": false
}
}Retrieve a Prescription
GET /prescriptions/{id}Request
curl -X GET "https://app.usejump.co.uk/functions/v1/api-v1/prescriptions/rx_123e4567" \
-H "Authorization: Bearer pk_live_your_api_key"Create a Prescription
POST /prescriptionsRequest Body
| Field | Type | Required | Description |
|---|---|---|---|
patient_id | string | Yes | Patient ID |
display_name | string | Yes | Short display name |
medication_name | string | No | Full medication name |
dosage | string | No | Dosage amount |
dosage_unit | string | No | Unit (mg, ml) |
frequency | string | No | How often to take |
route | string | No | Route of administration |
quantity | integer | No | Amount prescribed |
refills | integer | No | Number of refills |
start_date | string | No | Start date |
end_date | string | No | End date |
instructions | string | No | Patient instructions |
notes | string | No | Additional notes |
Request
curl -X POST "https://app.usejump.co.uk/functions/v1/api-v1/prescriptions" \
-H "Authorization: Bearer pk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"patient_id": "pat_456e7890-e89b-12d3-a456-426614174111",
"display_name": "Lisinopril 10mg",
"medication_name": "Lisinopril",
"dosage": "10",
"dosage_unit": "mg",
"frequency": "once daily",
"route": "oral",
"quantity": 30,
"refills": 5,
"start_date": "2025-01-20",
"instructions": "Take in the morning"
}'Update a Prescription
PATCH /prescriptions/{id}Request Body
| Field | Type | Description |
|---|---|---|
status | string | active, stopped, or completed |
end_date | string | End date (YYYY-MM-DD) |
notes | string | Additional notes |
Request
curl -X PATCH "https://app.usejump.co.uk/functions/v1/api-v1/prescriptions/rx_123e4567" \
-H "Authorization: Bearer pk_live_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"status": "stopped",
"end_date": "2025-01-20",
"notes": "Discontinued due to side effects"
}'Related Resources
- Patients - Patient records
- Problems - Patient diagnoses
- Consultations - Clinical consultations