Quincy

Medicines

The Medicines endpoint allows you to search for medicines in the Quincy platform. This endpoint is crucial for healthcare providers to find and select the correct medications when creating prescriptions.

GET/v1/medicines

Search medicines

This endpoint allows you to search for medicines by name or PIP code. It returns a list of medicines matching the search criteria, including their pack sizes and other details.

Required attributes

  • Name
    query
    Type
    string
    Description

    The search query for medicine name or PIP code. Minimum 3 characters.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limit the number of results returned (default: 100, max: 100).

  • Name
    expand_packs
    Type
    boolean
    Description

    If set to 1, returns an expanded list where each entry represents a specific medicine and pack size combination (default: 0).

Request

GET
/v1/medicines
curl -G https://app.quincy.health/api/v1/medicines  \
  -H "Authorization: Bearer {token}" \
  -d query="naproxen" \
  -d limit=10

The medicine model

The medicine model contains information about each medicine, including its name, pack sizes, and other relevant details.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the medicine.

  • Name
    name
    Type
    string
    Description

    The name of the medicine.

  • Name
    is_fridge
    Type
    boolean
    Description

    Indicates whether the medicine requires refrigeration.

  • Name
    pack_sizes
    Type
    array
    Description

    An array of available pack sizes for the medicine.

  • Name
    pack_sizes_info
    Type
    string
    Description

    Information about the pack sizes for the medicine.

The pack size model

The pack size model represents the available quantities for a specific medicine and estimated line prices.

Properties

  • Name
    quantity
    Type
    integer
    Description

    The number of units in the pack.

  • Name
    estimated_line_price
    Type
    number
    Description

    The estimated price for this pack size if available.

The expanded medicine model

When the expand_packs=1 parameter is used, the API returns an expanded list. Each object in the array represents a single medicine paired with one of its available pack sizes.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the medicine. Note that this ID will be repeated for each pack size of the same medicine.

  • Name
    name
    Type
    string
    Description

    The name of the medicine.

  • Name
    is_fridge
    Type
    boolean
    Description

    Indicates whether the medicine requires refrigeration.

  • Name
    pack_size
    Type
    integer
    Description

    The number of units in this specific pack size.

  • Name
    estimated_line_price
    Type
    number
    Description

    The estimated price for this specific pack size, if available.