List Bookable Services

Overview

This endpoint allows Patient Facing Services Consumer applications to list all the Appointment Services available to a patient.

Making a Request

GET https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{patientId}/list-bookable-services

Request Headers

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

Request Parameters

URL Parameters

Parameter

Description

Validation Rules

patientId

Patient ID

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

Mandatory

UUID

Example Request

CODE

POST /pfs-api/v1/patient/dda43bf3-063b-48f6-9960-b9d00021fc34/list-bookable-services
Authorization: Bearer [token]

Response Details

Properties

Field

Type

Description

id

uuid

The Appointment Service identifier

name

string

If a ‘Patient facing name’ is defined for the Appointment Service, then that name will be returned.

If no ‘Patient facing name’ is set, then the Appointment Service ‘name’ will be returned.

Example Response

JSON

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

{
    "bookableServices": [
        {
            "id": "85d2afce-28d9-11eb-adc1-cbf027ea5864",
            "name": "Counselling & Mental Health Service"
        },
        {
            "id": "324b5437-ef40-43f1-9ecc-26a76c1938d0",
            "name": "GP Surgery"
        }
    ]    
}