Prescription
A prescription is an instruction by a provider that authorizes a patient to be provided a prescription.
The prescription model
Properties
- Name
id
- Type
- string
- Description
Unique identifier for the prescription.
- Name
object
- Type
- string
- Description
Always 'prescription'.
- Name
patient
- Type
- string
- Description
Patient this prescription is for.
- Name
name
- Type
- string
- Description
Name of the prescription.
- Name
dosage
- Type
- string
- Description
Dosage of the prescription.
- Name
sig
- Type
- string
- Description
Instructions on how to take the prescription.
- Name
quantity
- Type
- number
- Description
Quantity of prescription.
- Name
unit
- Type
- string
- Description
Unit of prescription.
- Name
days_supply
- Type
- number
- Description
Days supply of prescription.
- Name
refills
- Type
- number
- Description
Number of refills for prescription.
- Name
created_by
- Type
- string
- Description
Creator of the prescription.
- Name
created_at
- Type
- number
- Description
Timestamp (in Unix epoch time in milliseconds) of when the prescription was created.
- Name
last_updated_at
- Type
- number
- Description
Timestamp (in Unix epoch time in milliseconds) of when the prescription was last updated.
Response
{
"id": "med_2UxtAULYUrX7GVsTKePy",
"object": "prescription",
"patient": "user_Z1zXZKvqrpwxbznuW6lJ",
"name": "VIIBRYD (Oral Pill)",
"dosage": "10 mg",
"sig": "Take 1 tablet by mouth daily",
"quantity": 30,
"unit": "tablet",
"days_supply": 30,
"refills": 0,
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
}
GET/v1/prescriptions/:id
Retrieve a prescription
Retrieves the specified prescription.
Response
{
"id": "med_2UxtAULYUrX7GVsTKePy",
"object": "prescription",
"patient": "user_Z1zXZKvqrpwxbznuW6lJ",
"name": "VIIBRYD (Oral Pill)",
"dosage": "10 mg",
"sig": "Take 1 tablet by mouth daily",
"quantity": 30,
"unit": "tablet",
"days_supply": 30,
"refills": 0,
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
}
GET/v1/prescriptions
List all prescriptions
Returns a list of all prescriptions.
Response
{
"object": "list",
"data": [
{
"id": "med_2UxtAULYUrX7GVsTKePy",
"object": "prescription",
"patient": "user_Z1zXZKvqrpwxbznuW6lJ",
"name": "VIIBRYD (Oral Pill)",
"dosage": "10 mg",
"sig": "Take 1 tablet by mouth daily",
"quantity": 30,
"unit": "tablet",
"days_supply": 30,
"refills": 0,
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
},
]
}