List Current and Recent Medications (Transactional)

Overview

The intended use for this endpoint is to list all medications relevant for prescribing decision support. If you intend to integrate for another use case please contact Medicus Health for agreement.

The payload returns the following data sets for the patient:

Acute Prescriptions
Repeat Prescriptions
Medications Prescribed Elsewhere
Over The Counter Medications

Making a Request

Method: GET

URL: https://{{medicusTenant}}.{{medicusBaseURL}}/transactional-api/v1/patient/{{patientId}}/list-current-and-recent-medication

Example of a fully formed URL: GET https://a10001.api.demo.medicus.health/transactional-api/v1/patient/eb8d8f70-360c-11ed-a5b3-060b232f1aa2/list-current-and-recent-medication

Request Headers

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

URL Parameters

Parameter

Description

Validation Rules

patientId

The Medicus Patient ID

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

Mandatory

UUID

Example Request

CODE

GET /transactional-api/v1/patient/eb8d8f70-360c-11ed-a5b3-060b232f1aa2/list-current-and-recent-medication
Authorization: Bearer [token]

Response Details

Payload

Prescriptions (Acute Prescriptions & Repeat Prescriptions)

Property	Type	Description
`id`	UUID	The unique prescription identifier
`type`	enum	The type of prescription Possible values: [`"repeat", "repeat-dispensing”`]
`product`	Product	The prescription’s pharmaceutical product
`dosageInstructions`	string	The dosage instructions for the prescription
`quantityRequiredPerIssue`	Quantity	The prescription’s quantity Payload details: `value` (decimal) `unit` (SNOMED-CT code) Example: CODE `"quantityRequiredPerIssue ": { "value": 20, "unit": { "conceptId": "428673006", "description": "Tablet - unit of product usage (qualifier value)" } },`
`expectedDaysSupplyPerIssue`	integer	The number of days the quantity of medication is expected to last
`authorisedIssues`	integer	The number of authorised issues
`reviewDate`	date (ISO 8601 format)	Prescription review date
`startDate`	date	The date reflecting the prescription’s start date
`endDate`	date	The date reflecting the prescription’s end date
`authorisedDate`	date (ISO 8601 format)	The date that the prescription was authorised
`authorisedByOrganisation`	Organisation	The authorising organisation Payload details: name (string) identifier (string) identifierType (enum) values: `medicus-staff-id` `third-party-practitioner-id` Example: CODE `{ "identifierType": "third-party-practitioner-id", "identifier": "AC12345", "name": "Dr Joel Ward" }`
`authorisedByPractitioner`	Practitioner	The authorising practitioner Payload details: name (string) identifier (string) identifierType (enum) values: `nhs-england-ods-code` `medicus-tenant-id` Example: CODE `{ "identifierType": "nhs-england-ods-code", "identifier": "F85003", "name": "Riley House GP Practice" }`
`status`	enum	Possible values: `authorised` `discontinued`
`discontinuedDate`	date (ISO 8601 format)	The date of discontinuation
`discontinuedReason`	enum	Possible values: `change-of-dosage` `clinical-contra-indication` `other-clinical-reason` `patient-death` `patient-deducted` `patients-request` `pharmacists-request` `prescribing-error` `prescription-not-collected` `product-no-longer-available` `product-no-longer-effective`
`rescriptionIssues`	Prescription Issues as array	An array detailing the prescription issues for this prescription

Prescription Issues

This is the schema for the child prescriptionIssues object.

Field	Description	Example
`id`	uuid	The unique prescription issue identifier
`status`	enum	The prescription issue status Possible values: `not-issued` `issued` `cancelled`
`intendedIssueDate`	date	The date that the prescription issue was intended to be issued on Note: if an `issueDate` is set, then it will supersede `intendedIssueDate`. In this case `intendedIssueDate` 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”

Medication Statements (Medication Prescribed Elsewhere & Over the Counter Medication)

Property	Type	Description
`id`	UUID	The unique Medication Identifier
`status`	enum	Possible values: `["active", "ended"]`
`product`	Product	Product details Payload details: `dmdCode` - the product's dm+d code `name` - the product’s name Example payload JSON `{ "dmdCode": "322502004", "name": "Codeine 15mg tablets" }`
`prescriptionType`	enum	Possible values: `["acute", "repeat"]`
`dosageInstructions`	string	The medication’s dosage instructions
`additionalInformation`	string	Additional information
`prescribedByOrganisation`	Organisation	The prescribing organisation Payload details: name (string) identifier (string) identifierType (enum) values: `medicus-staff-id` `third-party-practitioner-id` Example: CODE `{ "identifierType": "third-party-practitioner-id", "identifier": "AC12345", "name": "Dr Joel Ward" }`
`prescribedByPractitioner`	Practitioner	The prescribing practitioner Payload details: name (string) identifier (string) identifierType (enum) values: `nhs-england-ods-code` `medicus-tenant-id` Example: CODE `{ "identifierType": "nhs-england-ods-code", "identifier": "F85003", "name": "Riley House GP Practice" }`
`startDate`	date (ISO 8601 format)	The medication’s start date
`endDate`	date (ISO 8601 format)	The medication’s end date
`reasonEnded`	string	The reason ended
`endDate`	date	The end date
`recordedByPractitioner`	Practitioner	name (string) identifier (string) identifierType (enum) values: `medicus-staff-id` `third-party-practitioner-id` Example: CODE `{ "identifierType": "third-party-practitioner-id", "identifier": "AC12345", "name": "Dr Joel Ward" }`
`recordedByOrganisation`	Organisation	name (string) identifier (string) identifierType (enum) values: `nhs-england-ods-code` `medicus-tenant-id` Example: CODE `{ "identifierType": "nhs-england-ods-code", "identifier": "F85003", "name": "Riley House GP Practice" }`
`recordedDate`	date	The date that the prescription was recorded.

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Request
`404`	`PATIENT_NOT_FOUND`	No patient record exists with the specified Patient ID.

Example Response (Successful Retrieval)

JSON

{
    "acutePrescriptions": [
        {
            "id": "c206aa92-6fc3-11ed-b11e-0afd1ae64c88",
            "product": {
                "dmdCode": "331742001",
                "name": "Hydrocortisone acetate 1% / Fusidic acid 2% cream"
            },
            "dosageInstructions": "1 application - TWICE a DAY - topical",
            "quantityRequiredPerIssue": {
                "value": 30,
                "unit": {
                    "conceptId": "258682000",
                    "description": "gram"
                }
            },
            "authorisedIssues": 1,
            "authorisedDate": "2022-11-29",
            "authorisedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "authorisedByPractitioner": {
                "name": "Mohammed Lee",
                "identifier": "aebc00c2-28df-11eb-adc1-0242ac120002",
                "identifierType": "medicus-staff-id"
            },
            "status": "authorised",
            "prescriptionIssues": [
                {
                    "id": "c207a762-6fc3-11ed-ba88-0afd1ae64c88",
                    "status": "issued",
                    "issueDate": "2022-11-29",
                    "quantityRequired": {
                        "value": 30,
                        "unit": {
                            "conceptId": "258682000",
                            "description": "gram"
                        }
                    }
                }
            ]
        },
        {
            "id": "35e60a06-6f2f-11ed-8782-0a5a396e3cd4",
            "product": {
                "dmdCode": "322502004",
                "name": "Codeine 15mg tablets"
            },
            "dosageInstructions": "When required",
            "quantityRequiredPerIssue": {
                "value": 100,
                "unit": {
                    "conceptId": "428673006",
                    "description": "tablet"
                }
            },
            "authorisedIssues": 1,
            "authorisedDate": "2022-11-28",
            "authorisedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "authorisedByPractitioner": {
                "name": "Mohammed Lee",
                "identifier": "aebc00c2-28df-11eb-adc1-0242ac120002",
                "identifierType": "medicus-staff-id"
            },
            "status": "authorised",
            "prescriptionIssues": [
                {
                    "id": "35e71090-6f2f-11ed-b21c-0a5a396e3cd4",
                    "status": "issued",
                    "issueDate": "2022-11-28",
                    "quantityRequired": {
                        "value": 100,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    }
                }
            ]
        },
        {
            "id": "e0012e76-6f34-11ed-b731-067b4562cb68",
            "product": {
                "dmdCode": "322256005",
                "name": "Paracetamol 120mg suppositories"
            },
            "dosageInstructions": "15 to 20mg/kg - every 4 to 6 hours - rectal - Maximum dose 75mg/kg DAILY",
            "quantityRequiredPerIssue": {
                "value": 10,
                "unit": {
                    "conceptId": "430293001",
                    "description": "suppository"
                }
            },
            "authorisedIssues": 1,
            "authorisedDate": "2022-11-28",
            "authorisedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "authorisedByPractitioner": {
                "name": "Mohammed Lee",
                "identifier": "aebc00c2-28df-11eb-adc1-0242ac120002",
                "identifierType": "medicus-staff-id"
            },
            "status": "authorised",
            "prescriptionIssues": [
                {
                    "id": "e00174a8-6f34-11ed-96cf-067b4562cb68",
                    "status": "issued",
                    "issueDate": "2022-11-28",
                    "quantityRequired": {
                        "value": 10,
                        "unit": {
                            "conceptId": "430293001",
                            "description": "suppository"
                        }
                    }
                }
            ]
        },
        {
            "id": "5b67fe7a-6f38-11ed-97a2-0a5a396e3cd4",
            "product": {
                "dmdCode": "20344911000001107",
                "name": "Cetirizine 10mg capsules"
            },
            "dosageInstructions": "One a day",
            "quantityRequiredPerIssue": {
                "value": 100,
                "unit": {
                    "conceptId": "428641000",
                    "description": "capsule"
                }
            },
            "authorisedIssues": 1,
            "authorisedDate": "2022-11-28",
            "authorisedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "authorisedByPractitioner": {
                "name": "Mohammed Lee",
                "identifier": "aebc00c2-28df-11eb-adc1-0242ac120002",
                "identifierType": "medicus-staff-id"
            },
            "status": "authorised",
            "prescriptionIssues": [
                {
                    "id": "5b68c062-6f38-11ed-875f-0a5a396e3cd4",
                    "status": "issued",
                    "issueDate": "2022-11-28",
                    "quantityRequired": {
                        "value": 100,
                        "unit": {
                            "conceptId": "428641000",
                            "description": "capsule"
                        }
                    }
                }
            ]
        }
    ],
    "repeatPrescriptions": [
        {
            "id": "c3ff4938-6f34-11ed-bb0f-067b4562cb68",
            "type": "repeat-dispensing",
            "product": {
                "dmdCode": "320822001",
                "name": "Loratadine 10mg tablets"
            },
            "dosageInstructions": "One a day",
            "quantityRequiredPerIssue": {
                "value": 60,
                "unit": {
                    "conceptId": "428673006",
                    "description": "tablet"
                }
            },
            "expectedDaysSupplyPerIssue": 30,
            "authorisedIssues": 1,
            "authorisedDate": "2022-11-28",
            "authorisedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "authorisedByPractitioner": {
                "name": "Mohammed Lee",
                "identifier": "aebc00c2-28df-11eb-adc1-0242ac120002",
                "identifierType": "medicus-staff-id"
            },
            "status": "authorised",
            "endDate": "2022-12-27",
            "prescriptionIssues": [
                {
                    "id": "c3ffa5a4-6f34-11ed-9cd0-067b4562cb68",
                    "status": "issued",
                    "issueDate": "2022-11-28",
                    "quantityRequired": {
                        "value": 60,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    },
                    "expectedDaysSupply": 30
                }
            ]
        },
        {
            "id": "d2fac53e-28d9-11eb-adc1-f165d48bce32",
            "type": "repeat",
            "product": {
                "dmdCode": "52911000001107",
                "name": "Prednisolone 1mg tablets",
                "description": "Prednisolone 1mg tablets (Alliance Healthcare (Distribution) Ltd)",
                "manufacturerName": "Alliance Healthcare (Distribution) Ltd",
                "manufacturerCode": "2089901000001107"
            },
            "dosageInstructions": "1 tablet - every MORNING",
            "quantityRequiredPerIssue": {
                "value": 1,
                "unit": {
                    "conceptId": "428673006",
                    "description": "tablet"
                }
            },
            "expectedDaysSupplyPerIssue": 28,
            "authorisedIssues": 6,
            "authorisedDate": "2022-09-16",
            "authorisedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "authorisedByPractitioner": {
                "name": "Caitlin Davies",
                "identifier": "1339aa9b-28d6-11eb-adc1-0242ac120002",
                "identifierType": "medicus-staff-id"
            },
            "status": "authorised",
            "endDate": "2023-03-13",
            "prescriptionIssues": [
                {
                    "id": "6b25d9e4-28d9-11eb-adc1-9e612d35fb84",
                    "status": "not-issued",
                    "intendedIssueDate": "2022-11-22",
                    "quantityRequired": {
                        "value": 1,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    },
                    "expectedDaysSupply": 28
                },
                {
                    "id": "f2805be1-28d9-11eb-adc1-f2ba0918d53e",
                    "status": "not-issued",
                    "intendedIssueDate": "2023-01-17",
                    "quantityRequired": {
                        "value": 1,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    },
                    "expectedDaysSupply": 28
                },
                {
                    "id": "f7b340ea-28d9-11eb-adc1-3641a8f27d5b",
                    "status": "not-issued",
                    "intendedIssueDate": "2023-02-14",
                    "quantityRequired": {
                        "value": 1,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    },
                    "expectedDaysSupply": 28
                },
                {
                    "id": "50172ced-28d9-11eb-adc1-aebd207c348f",
                    "status": "issued",
                    "issueDate": "2022-09-27",
                    "quantityRequired": {
                        "value": 1,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    },
                    "expectedDaysSupply": 28
                },
                {
                    "id": "a17562b0-28d9-11eb-adc1-46a30cfb958d",
                    "status": "issued",
                    "issueDate": "2022-10-25",
                    "quantityRequired": {
                        "value": 1,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    },
                    "expectedDaysSupply": 28
                },
                {
                    "id": "5e840321-28d9-11eb-adc1-a42cdf305e71",
                    "status": "issued",
                    "issueDate": "2022-12-20",
                    "quantityRequired": {
                        "value": 1,
                        "unit": {
                            "conceptId": "428673006",
                            "description": "tablet"
                        }
                    },
                    "expectedDaysSupply": 28
                }
            ]
        }
    ],
    "medicationsPrescribedElsewhere": [
        {
            "id": "df369a42-7170-11ed-aacf-0a58a9feac02",
            "status": "active",
            "product": {
                "name": "Pseudoephedrine",
                "description": "Pseudoephedrine",
                "code": "91435002"
            },
            "prescriptionType": "acute",
            "dosageInstructions": "One per day",
            "prescribedByOrganisation": {
                "name": "118 Pharmacy Limited",
                "identifier": "FWP52",
                "identifierType": "nhs-england-ods-code"
            },
            "prescribedByPractitioner": {
                "name": "Stephen Higgins"
            },
            "recordedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "recordedByPractitioner": {
                "name": "Stephen Higgins",
                "identifier": "67c4e0c8-5c61-11ed-b334-0a58a9feac02",
                "identifierType": "medicus-staff-id"
            }
        }
    ],
    "overTheCounterMedications": [
        {
            "id": "e6b0badc-7170-11ed-95c7-0a9baafe5d36",
            "status": "active",
            "product": {
                "name": "Paracetamol + Caffeine",
                "description": "Paracetamol + Caffeine",
                "code": "350309002"
            },
            "recordedByOrganisation": {
                "name": "Riley House GP Practice",
                "identifier": "F85003",
                "identifierType": "nhs-england-ods-code"
            },
            "recordedByPractitioner": {
                "name": "Stephen Higgins",
                "identifier": "67c4e0c8-5c61-11ed-b334-0a58a9feac02",
                "identifierType": "medicus-staff-id"
            }
        }
    ]
}

Example Response (No Records)

JSON

{
    "acutePrescriptions": [],
    "repeatPrescriptions": [],
    "medicationsPrescribedElsewhere": [],
    "overTheCounterMedications": []
}