Sign in

v1

latestOpenAPI 3.0.02026-07-23237.5 KB

Search dispensers by opening hours & location

Searches for a suitable dispenser based on patient location and opening hours, ensuring that opening times fall within the timeframe required. Returns a maximum of five matching dispensers.

get/epsdispenser/byLocationAndTime

Query parameters

postcodestring required

Postcode of patient location.

distancenumber

The maximum distance from postcode to search, in km. Defaults to 36.

timeframenumber required

The number of hours from the current time within which the service must be open. Takes account of bank holidays, specified dates and timezone offsets.

availability_startstring

Timestamp from which to start timeframe calculation. Defaults to now(). Should not be used in production - this is primarily to support testing.

service_type'eps_pharmacy'

The service type to include in results. The current release only supports EPS-enabled community pharmacy:

  • eps_pharmacy - An EPS R2 enabled community pharmacy

Response

Up to five dispensers matching the search cirteria, ordered by distance.

odsstring required

ODS code of the dispenser

namestring required

Name of the dispenser

service_type'eps_pharmacy' required

The service type to include in results. The current release only supports EPS-enabled community pharmacy:

  • eps_pharmacy - An EPS R2 enabled community pharmacy
distancenumber

Distance from patient location in km, where this has been provided in a search.

Example response

[
  {
    "ods": "FLM42",
    "name": "Vantage Pharmacy",
    "service_type": "eps_pharmacy",
    "address": {
      "line": [
        "123 Brown Street",
        null,
        "York",
        "North Yorkshire"
      ],
      "postcode": "YO1 3EH"
    },
    "patient_contact": {
      "tel": "01952784465",
      "web_address": "http://www.vantage-pharmacy.co.uk"
    },
    "prescriber_contact": {
      "tel": "01952784470",
      "fax": "01952784460"
    },
    "location": {
      "northing": 55.45673,
      "easting": 1.45678
    },
    "opening": {
      "open_247": false,
      "sun": null,
      "mon": [
        {
          "open": "08:00",
          "close": "18:00"
        }
      ],
      "tue": [
        {
          "open": "08:00",
          "close": "18:00"
        }
      ],
      "wed": [
        {
          "open": "08:00",
          "close": "12:00"
        }
      ],
      "thu": [
        {
          "open": "08:00",
          "close": "18:00"
        }
      ],
      "fri": [
        {
          "open": "08:00",
          "close": "18:00"
        }
      ],
      "sat": [
        {
          "open": "09:00",
          "close": "12:00"
        }
      ],
      "bank_holiday": [
        {
          "open": "08:00",
          "close": "10:00"
        },
        {
          "open": "14:00",
          "close": "16:00"
        }
      ],
      "specified_date": {
        "2018-01-10": [
          {
            "open": "09:00",
            "close": "12:00"
          }
        ]
      }
    }
  }
]
All 2 operations