Create Prescription Request

Overview

This endpoint allows a PFS Consumer app to create a prescription request on behalf of the patient.

This endpoint is used to request one or many prescriptions or prescription issues. Endpoint requires the Consumer app to provide a list of Prescription IDs or Prescription Issue IDs.

If the response is successful, a HTTP 200 response is returned.

Note: The endpoint supports a mixture of Prescription IDs and Prescription Issue IDs so that the patient can request their next issue of Drug A and a new prescription for Drug B that they were previously prescribed, in the same transaction.

Making a Request

HTTP method: POST

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

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

Body Parameters

Parameter	Description	Validation Rules
`requestItems`	Prescription Request Items (as array, defied by the `type` property)	An array that accommodates either a new Prescription Issue, or a Prescription Reorder (see below)

Request Items: Prescription Issue

Parameter	Type	Description
`type`	enum	Value: `prescription-issue`
`prescriptionIssueId`	uuid	The uuid of the prescription issue being requested

Request Items: Prescription Reorder

Parameter	Type	Description
`type`	enum	Value: `prescription-reorder`
`basedOnPrescriptionId`	uuid	The uuid of the original prescription
`messageFromPatient`	string	A message supplied by the patient for the clinician

Example Request

JSON

POST /pfs-api/v1/patient/dda43bf3-063b-48f6-9960-b9d00021fc34/cancel-prescription-request
Authorization: Bearer [token]
Idempotency-Key: 169b27b7-23dd-4f03-97c5-ad215058c0c0

{
    "requestItems": [
        {
            "type": "prescription-reorder",
            "basedOnPrescriptionId": "08ebbbea-9c45-435e-9242-697ec2139891",
            "messageFromPatient": "A new prescription"
        },
        {
            "type": "prescription-issue",
            "prescriptionIssueId": "270b4c9f-847c-4a5e-a31f-63a5261aaadc"
        }
    ]
}

Response Details

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		The cancellation request was successful
`400`	`UNKNOWN_PRESCRIPTION_TYPE`	The prescription type is not recognised.
`404`	`PRESCRIPTION_NOT_FOUND`	A Prescription with that ID doesn’t exist for this patient.
`404`	`PRESCRIPTION_NOT_FOUND`	A Prescription with that ID was not found.
`404`	`PRESCRIPTION_REQUEST_NOT_FOUND`	A Prescription Request with that ID was not found.
`404`	`PRESCRIPTION_ISSUE_NOT_FOUND`	A Prescription Issue with that ID doesn’t exist for this patient.
`422`	`REQUEST_NOT_CANCELLABLE`	The cancel prescription request has already been processed. This is likely because: a prescription request with this ID has already been fulfilled a prescription request with this ID has already been cancelled.

Example Response (Prescription Not Found)

JSON

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "errors": [
    {
      "code": "PRESCRIPTION_NOT_FOUND"
      "title": "Prescription Not Found",
      "detail": "A prescription request with the ID c6dd3106-56ed-444a-9af6-031cdefd040b doesn’t exist for this patient.",
    }
  ]
}

Example Response (Successful Cancellation)

JSON

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