v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Packaged Medication (Beta)

List Packaged Medications

Requests to this endpoint must specify at least one query parameter.

get/api/2.0/packaged_medications/

Query parameters

is_activeboolean
is_deletedboolean

If true, return only soft-deleted packaged medications. If false, exclude soft-deleted packaged medications. If omitted, both are returned.

limitinteger

Number of results to return per page.

namestring[]

The name of the packaged medication.

ndcstring[]

The National Drug Code associated with the packaged medication.

offsetinteger

The initial index from which to return the results.

order_bystring

Which field to use when ordering the results.

reference_medication_idinteger[]

The id of the reference medication associated with the packaged medication.

Response

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}