Retrieve the Patient's Nominated EPS Dispensers

Overview

This endpoint allows a PFS Consumer app to retrieve the patient’s nominated EPS dispensers.

Making a Request

HTTP method: GET

Endpoint URL: [https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/nominated-eps-dispensers

If the response is successful, all of the assigned EPS dispensers for the patient are returned.

Request Headers

Header	Value	Description
`Authorization`	`Bearer [token]`	The JWT token provided by the Consumer

URL Parameters

Parameter

Description

Validation Rules

patientId

Patient ID

e.g. e9af860e-cf8e-4272-b81a-a95cc8a531f7

Mandatory

UUID

Example Request

CODE

GET /pfs-api/v1/patient/e9af860e-cf8e-4272-b81a-a95cc8a531f7/nominated-eps-dispensers
Authorization: Bearer [token]

Response Details

EPS Dispensers

Field	Type	Description	Medicus PharmacyType
`p1`	Dispensing Organisation object	Details of the P1 dispensing site preference (e.g. Community Pharmacy)	`NOMINATED_PHARMACY`
`p2`	Dispensing Organisation object	Details of the P2 dispensing site preference (Appliance Contractor)	`MEDICAL_APPLIANCE_PROVIDER`
`p3`	Dispensing Organisation object	Details of the P3 dispensing site preference (Dispensing Doctor)	`DISPENSING_DOCTOR`

EPS Dispensers: Dispensing Organisation

Field

Type

Description

odsCode

string

The dispensing organisation’s NHS ODS code

name

string

The name of the dispensing organisation

address

Address

An object containing the address of the dispensing organisation

Example output:

CODE

{
    "line1": "5",
    "line2": "Cherry Tree Road",
    "line3": "Murrayfield",
    "locality": "Lincoln",
    "administrativeArea": "Lincolshire",
    "postalCode": "DN21 5AF",
    "country": "United Kingdom"
}

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Request successful

Example Response

JSON

HTTP/1.1 200 OK
Content-Type: application/json

{
    "p1": {
        "odsCode": "FN1631",
        "name": "The Bridge Pharmacy",
        "address": {
            "line1": "27A",
            "line2": "Greenhill Parade",
            "line3": "",
            "locality": "New Barnet",
            "administrativeArea": "Hertfortshire",
            "postalCode": "EN5 1EU",
            "country": "United Kingdom"
        }
    },
    "p2": {
        "odsCode": "DC2345",
        "name": "Ainsworth Medical Supplies",
        "address": {
            "line1": "5",
            "line2": "Cherry Tree Road",
            "line3": "Murrayfield",
            "locality": "Lincoln",
            "administrativeArea": "Lincolshire",
            "postalCode": "DN21 5AF",
            "country": "United Kingdom"
        }
    },
    "p3": {
        "odsCode": "DD00021",
        "name": "Jenny Mitchell Community Clinic",
        "address": {
            "line1": "10",
            "line2": "Long Lane",
            "line3": "Southowram",
            "locality": "Halifax",
            "administrativeArea": "West Yorkshire",
            "postalCode": "HX3 9QW",
            "country": "United Kingdom"
        }
    }
}