Skip to Content
ReferenceAPIPatientsUpdate a patient

Patients API

Update a patient

Update a patient in the current workspace.

PATCH/v1/patients/{patientId}
capability patients.update · v1health dataserver-scoped workspace

Request

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

  • patientIdstring<uuid>required
    path
  • firstNamestring
    bodymin length 1max length 80
  • lastNamestring
    bodymin length 1max length 80
  • emailstring | null
    body
  • phonestring | null
    bodymin length 5max length 40
  • dateOfBirthstring<date> | null
    body
  • status"active" | "inactive" | "archived"
    body
  • notesstring | null
    bodymax 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.

  • 404The patient could not be found.
  • 409The email address is already used by another patient.
  • 422The patient ID or patient details are invalid.
  • 503The patient could not be saved.
Last updated on