Patients API

Create a patient

Create a patient in the current workspace.

POST/v1/patients

capability patients.create · v1health dataserver-scoped workspace

Request

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

firstNamestringrequired
bodymin length 1max length 80
lastNamestringrequired
bodymin length 1max length 80
emailstring | null
bodydefault null
phonestring | null
bodydefault nullmin length 5max length 40
dateOfBirthstring<date> | null
bodydefault null
notesstring | null
bodydefault nullmax length 50000

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.

409The email address is already used by another patient.
422The patient details are invalid.
503The patient could not be saved.

Request

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

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

const result = await dawn.capabilities["patients.create"]({
  "firstName": "Ada",
  "lastName": "Lovelace",
  "email": null,
  "phone": null,
  "dateOfBirth": null,
  "notes": null,
});

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

Response

Created.

{
  "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": {}
}