Patients API

Delete a patient

Delete a patient from the current workspace.

DELETE/v1/patients/{patientId}

capability patients.delete · v1health dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

patientIdstring<uuid>required
path

Response

Successful responses use Dawn's data envelope.

dataPatientrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- firstNamestringrequired
  min length 1max length 80
- lastNamestringrequired
  min length 1max length 80
- emailstring<email> | nullrequired
- phonestring | nullrequired
  min length 5max length 40
- dateOfBirthstring<date> | nullrequired
- status"active" | "inactive" | "archived"required
- notesstring | nullrequired
  max length 50000
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

404The patient could not be found.
409The patient has appointments and must be archived instead.
422The patient ID is invalid.
503The patient could not be deleted.

Request

import { createDawnClient } from "@dawn/api";
import { patientIdSchema } from "@dawn/domain";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["patients.delete"]({
  "patientId": patientIdSchema.parse("33333333-3333-4333-8333-333333333333"),
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "workspaceId": "22222222-2222-4222-8222-222222222222",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "email": null,
    "phone": null,
    "dateOfBirth": null,
    "status": "active",
    "notes": null,
    "createdAt": "2026-08-01T09:00:00.000Z",
    "updatedAt": "2026-08-01T09:00:00.000Z"
  },
  "meta": {}
}