Book Appointment

Overview

This endpoint allows Patient Facing Consumer Apps to book an appointment on behalf of a patient.

Making a Request

HTTP method: POST

URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/book-appointment

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	Type	Description
`availableAppointmentId`	string	The appointment slot ID as specified in the ind Available Appointments for a Given Service endpoint
`patientSuppliedInformationForClinician`	string (nullable)	The patient supplied reason for the appointment

Example Request

JSON

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

{
    "availableAppointmentId": "timed-521d0978-28d9-11eb-adc1-10f5389ebc27-20221122002000-20221122003000",
    "patientSuppliedInformationForClinician": "My throat hurts"
}

Response Details

Specific Response Codes

HTTP Code	Error Code	Detail
`200`		Appointment booked
`404`	`APPOINTMENT_NOT_FOUND`	An appointment matching the `appointmentId` could not be found
`409`	`APPOINTMENT_ALREADY_BOOKED`	An appointment with that ID has already been booked

Properties

Field

Type

Description

appointmentId

UUID

The UUID of the booked appointment

A booked appointmentId is returned as confirmation of the appointment booking

Example Response (Successful Retrieval)

JSON

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

{
    "appointmentId": "b9eee80a-cd42-4196-9a6a-fc8bac7ccd4c"
}