Quantities and Package Sizes
The difference between quantities and package sizes when using the Honeybee Health Partners API
There are some subleties when using the Create New Order API that are important to keep in mind, especially when it comes to placing an order with a specific quantity or package size.
Simply put, the quantity of an item is how many separate packed items are desired, whereas the package size is how many units exist within an individual packed item.
For example, when ordering Vitamin D tablets, one may desire a single bottle of twenty (20) tablets. This would be represented as a quantity of one (1), and a package size of twenty (20).
If a second bottle of is desired, the quantity would be two (2).
Please note that when requesting to fill a prescription, there is a maximum number of dispensable medication denoted by the written quantity and number of refills on a prescription. Generally, the written quantity multiplied by the number of refills is the maximum allowable dispensable medication (regulations may exist for certain states or medications that change these guidelines). It may be desired that orders are placed for a single prescription that are more or less than the written quantity on the prescription, and thus can be split accordingly when using the Create New Order API.
An example request body where half of a prescription of 90 tablets with 1 refill may look like the following:
{
"shipping": {
"method_id": 1,
},
"patient": {
"patient_id": "abc123",
"patient_safety": {
"medications": [],
"health_conditions": [],
"allergies": []
}
},
"items": [
{
"prescription_id": 123456,
"package_size": 45
}
]
}
This is a commonly used request payload that does not include:
- Patient information other than the patient ID
- A shipping address
In this scenario, an order will be created for the patient associated with the patient ID sent in RX_RECEIVED webhook event. We will use the shipping address provided on the prescription.