API Documentation is in beta. Report issues to developers@jump.health
API Reference
Prescriptions

Prescriptions

The Prescriptions API allows you to manage patient medication prescriptions in Jump EHR. Track medications, dosages, and prescription status.

Endpoints

MethodEndpointDescription
GET/prescriptionsList all prescriptions
GET/prescriptions/{id}Retrieve a prescription
POST/prescriptionsCreate 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

FieldTypeDescription
idstringUnique identifier (UUID)
patient_idstringAssociated patient ID
prescriber_idstringPrescribing clinician ID
display_namestringShort display name
medication_namestringFull medication name
dosagestringDosage amount
dosage_unitstringUnit (mg, ml, etc.)
frequencystringHow often to take
routestringRoute of administration
quantityintegerAmount prescribed
refillsintegerNumber of refills
start_datestringStart date (YYYY-MM-DD)
end_datestringEnd date (YYYY-MM-DD)
statusstringactive, stopped, or completed
instructionsstringPatient instructions
notesstringAdditional notes
created_atstringISO 8601 creation timestamp
updated_atstringISO 8601 last update timestamp

List Prescriptions

GET /prescriptions

Query Parameters

ParameterTypeDefaultDescription
limitinteger100Number of records (max 100)
offsetinteger0Pagination offset
patient_idstring-Filter by patient
statusstring-Filter by status
activeboolean-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 /prescriptions

Request Body

FieldTypeRequiredDescription
patient_idstringYesPatient ID
display_namestringYesShort display name
medication_namestringNoFull medication name
dosagestringNoDosage amount
dosage_unitstringNoUnit (mg, ml)
frequencystringNoHow often to take
routestringNoRoute of administration
quantityintegerNoAmount prescribed
refillsintegerNoNumber of refills
start_datestringNoStart date
end_datestringNoEnd date
instructionsstringNoPatient instructions
notesstringNoAdditional 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

FieldTypeDescription
statusstringactive, stopped, or completed
end_datestringEnd date (YYYY-MM-DD)
notesstringAdditional 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