Cancel Appointment

Overview

This endpoint allows a Patient Facing Consumer App to cancel an appointment on behalf of a patient.

Making a Request

HTTP method: POST

URL: https://{{medicusTenant}}.{{medicusBaseURL}}/pfs-api/v1/patient/{{patientId}}/cancel-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	Description	Validation Rules
`appointmentId`	UUID	See List Appointments UUID for details
`cancellationReason`	string	The patient specified cancellation reason

Example Request

CODE

POST /pfs-api/v1/patient/dda43bf3-063b-48f6-9960-b9d00021fc34/cancel-appointment
Authorization: Bearer [token]
Idempotency-Key: 14bc8012-3da1-403c-9258-a6c9f5f30bf8

{
    "appointmentId": "e9af860e-cf8e-4272-b81a-a95cc8a531f7",
    "cancellationReason": "Appointment not required"   
}

Response Details

Specific Response Codes

HTTP Code	Error Code	Scenario
`200`		Cancellation successful
`403`	`APPOINTMENT_IN_THE_PAST`	The appointment is in the past and cannot be cancelled
`403`	`APPOINTMENT_ALREADY_CANCELLED`	The appointment could not be cancelled because the appointment has already been cancelled
`403`	`APPOINTMENT_RESCHEDULED`	The appointment could not be cancelled because the appointment has been rescheduled
`403`	`APPOINTMENT_ALREADY_STARTED`	The appointment could not be cancelled because the appointment has already started
`403`	`APPOINTMENT_MARKED_AS_SEEN`	The appointment could not be cancelled because the appointment is marked as “seen”
`404`	`APPOINTMENT_NOT_FOUND`	An appointment with that ID could not be found for this patient

Example Response (Appointment Not Found)

JSON

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

{
  "errors": [
    {
      "code": "APPOINTMENT_NOT_FOUND"
      "title": "Appointment not found",
      "detail": "An appointment with that ID could not be found."
    }
  ]
}

Example Response (Appointment Successfully Cancelled)

JSON

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

{
    "success": true
}