V3 API Delete Appointment

Delete Appointment

DELETE v3/admin/appointments/{appointmentId:guid}

DELETE v3/patients/appointments/{appointmentId:guid}

Cancels existing appointment.

vs/admin/... and vs/patients/... URLs are equivalent, except former are intended for use by hospital staff, while latter are for patients.

Permissions

Hospital staff should have one of the following role functions:

• Manage_Staff_Appointments
• Manage_Own_Appointments
• Patient_Proxy

Manage_Own_Appointments allows to cance only appolntments where clinician is a participant.

Patients are allowed to cancel only their own appointments and appopintments of their authorized dependents.

### Result

Result is HTTP status code 200 when appointment was cancelled successfully or HTTP code 400 with detailed message in the body in case of error.

Other HTTP codes are possible.

Sample request

POST /api/v3/patients/appointments/eb4c16e2-f499-4b6d-8868-d3912da23fad

Sample response (success)

Status: 200 OK

Sample response (not found)

Status: 400 Sp Error 1000404 ExError 0

{
    "responseCode": 1000404,
    "message": "Appointment does not exist",
    "spCallResult": {
        "DbName": "ConnectedCareTest",
        "Result": "[]",
        "Duration": 35.54,
        "ErrorCode": 1000404,
        "Error": "Appointment does not exist",
        "ExErrorCode": 0,
        "ExError": ""
    }
}

Sample response (not authorized)

Status: 401 Only patients are authorized to use this API