List Prescriptions

Overview

This endpoint allows a PFS Consumer app to list all of the patient’s prescriptions.

The endpoint has the secondary function of making a PFS app aware of existing prescription IDs and prescriptionIssueIds, which can be used to make requests for new prescriptions and prescription issues on behalf of the patient.

Elements Marked as “Hidden From Patient Services”

Any Prescription that is marked as being 'Hidden from patient-facing services' in the Medicus staff app will not be returned by the endpoint.

Making a Request

HTTP method: GET

Endpoint URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/prescriptions

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/prescriptions
Authorization: Bearer [token]

Response Details

Prescription

Field	Description	Example
`id`	UUID	The unique prescription identifier
`type`	enum	The type of prescription Possible values: `"acute", "repeat", "repeat-dispensing", "instalment"`
`status`	enum	Possible values: `"authorised", "discontinued"`
`product`	Product (see 'Product’ below)	The prescription’s pharmaceutical product
`dosageInstructions`	string	Dosage instructions, including any additional instructions.
`reviewDate`	date	Prescription review dates
`startDate`	date	The date reflecting the prescription’s start date
`endDate`	date	The date reflecting the prescription’s end date
`authorisedStartDate`	date	The prescription’s authorised date
`authorisedByOrganisation`	Organisation (see below)	The Organisation that issued the prescription See Organisation schema below
`authorisedByPractitioner`	Practioner (see Below)	The Practitioner that authorised the prescription See Practioner schema below
`discontinuedDate`	date	The date the prescription was discontinued
`prescriptionIssues`	Prescription Issues as array (see Prescription Issue below)	An array detailing the prescription issues for this prescription

Prescription Issue

Field	Description	Example
`id`	UUID	The unique prescription issue identifier
`status`	enum	The prescription issue status Possible values: `"not-issued", "issued", "cancelled"`
`dueDate`	date	The date that the prescription issue was intended to be issued on Note: if an `issueDate` is set, then it will supersede `dueDate`. In this case `dueDate` will not be output
`issueDate`	date	The date of the prescription issue
`quantityRequired`	See Prescription Issue :Quantity (Below)	The quantity of medication required to fulfil the dosage instructions
`expectedDaysSupply`	int	The number of days the quantity of medication is expected to last
`epsOrderId`	EPS order ID (long form)	Only applicable if the issue method is “EPS”

Prescription Issue: Quantity

Parameter Name	Type	Description
`value`	decimal
`unit`	SNOMED CT Code

Practitioner

Parameter Name	Type	Description
`id`	UUID	Unique Medicus user identifier
`name`	string	The name of the practitioner

Organisation

Parameter Name	Type	Description
name	string	The organisation's name
odsCode	string	The ODS code associated with the location/organisation

Product

Parameter Name	Type	Description
dmdCode	string	Dictionary of medicines and devices code
name	string	Product name
description	string	A description of the product
manufacturerName	string	The name of the product’s manufacturer

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Request successful

Example Response

JSON

{
    "prescriptionRequests": [
        {
            "id": "36566f98-abe4-11ed-bbd7-0a58a9feac02",
            "status": "pending",
            "requestedItems": [
                {
                    "id": "365b89f6-abe4-11ed-9c76-0a58a9feac02",
                    "type": "prescription-reorder",
                    "status": "pending",
                    "messageFromPatient": "A new prescription",
                    "basedOnPrescription": {
                        "id": "875a4edf-28d9-11eb-adc1-38af0d724b91",
                        "type": "repeat",
                        "product": {
                            "dmdCode": "52911000001107",
                            "name": "Prednisolone 1mg tablets",
                            "manufacturerName": "Alliance Healthcare (Distribution) Ltd",
                            "description": "Prednisolone 1mg tablets (Alliance Healthcare (Distribution) Ltd)"
                        },
                        "dosageInstructions": "1 tablet - every MORNING",
                        "expectedDaysSupply": 28,
                        "authorisedIssues": 6,
                        "authorisedStartDate": "2022-09-16",
                        "startDate": "2022-09-30",
                        "endDate": "2023-03-16",
                        "authorisedByOrganisation": {
                            "name": "Riley House GP Practice",
                            "odsCode": "F85003"
                        },
                        "authorisedByPractitioner": {
                            "name": "Caitlin Davies",
                            "id": "1339aa9b-28d6-11eb-adc1-0242ac120002"
                        }
                    }
                }
            ]
        }
    ]
}

Example Empty Response (The Patient Has No Prescriptions)

JSON

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

[]