Change Patient's Nominated EPS Dispenser

Overview

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

Making a Request

HTTP method: POST

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
`Idempotency-Key`	uuid	The unique idempotency key

URL Parameters

Parameter

Description

Validation Rules

patientId

Patient ID

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

Mandatory

UUID

Request Body

Parameter

Type

Description

type

enum

The nominated dispensing site preference code.

Values:

P1
P2

odsCode

string (must be a valid ODS Code)

The ODS code of the dispensing site.

The string must be a valid ODS code.

Example Request

Change a P1 Nomination

JSON

POST /pfs-api/v1/patient/1222aa9c-28d6-11eb-adc1-0242ac120002/nominated-eps-dispensers
Authorization: Bearer [token]
Idempotency-Key: 81ec98f4-7f63-41b5-88e7-b30f9277c3f8

{
    "type": "P1",
    "odsCode": "G83631"
}

Change a P2 Nomination

JSON

POST /pfs-api/v1/patient/1222aa9c-28d6-11eb-adc1-0242ac120002/nominated-eps-dispensers
Authorization: Bearer [token]
Idempotency-Key: 81ec98f4-7f63-41b5-88e7-b30f9277c3f8

{
    "type": "P2",
    "odsCode": "G83631"
}

Response Details

If successful, the response will return details of the Nominated EPS Dispensers according to the supplied ODS codes.

EPS Dispensers

Field	Type	Description
`p1`	Dispensing Organisation object	Details of the P1 dispensing site preference (e.g. Community Pharmacy)
`p2`	Dispensing Organisation object	Details of the P2 dispensing site preference (Appliance Contractor)

EPS Dispenser Properties

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
`422`	`INVALID_ODS_CODE`	An invalid ODS code was provided to the Spine Directory Service API

Example Response

JSON

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

{
    "p1": {
        "odsCode": "G83631",
        "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"
        }
    }
}