VEvetnio
patients

Update a patient

Updates the fields present in the body and leaves omitted fields unchanged. Fields cannot be set to null; send an empty string to blank a text field (not dateOfBirth, where an empty or invalid value fails with 500). The owner cannot be changed here. Repeating the same request leaves the same data, but updatedAt is refreshed on every call. Returns 404 when the patient does not exist in the workspace. Patients synced from a practice-management system can be overwritten by the next sync.

patch/workspaces/{workspaceId}/patients/{patientId}

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/patients/{patientId}
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the workspace (clinic) that owns the patients and clients. The caller must be a member of it; patients and clients are shared by all members of the workspace.

Example:furunculotic-loud-chihuahua
patientIdstring required

Patient id (UUID) in this workspace. Unknown ids and ids from other workspaces return 404.

Example:f2a3b4c5-d6e7-4890-fabc-012345678901

Request body

namestring

New value for the name. The animal's name. Free text; Vetnio does not enforce uniqueness.

speciesstring

New value for the species. Species, free text. The Vetnio web app stores the English species name, followed by - <breed> when a breed is chosen (for example Dog or Dog - Labrador Retriever); patients synced from a practice-management system may use that system's values.

breedstring

New value for the breed. Breed, free text.

dateOfBirthstring

New date of birth. Date of birth as an ISO-8601 calendar date (YYYY-MM-DD). Stored as a date, so other formats are rejected by the database.

genderstring

New value for sex and neuter status. Sex and neuter status, free text. The Vetnio web app uses Male, Female, Male Neutered and Female Neutered; use the same values so the patient list's gender filter and the UI stay consistent.

weightstring

New weight. Body weight as free text including the unit, as the web app writes it (for example 24.5 kg). Not parsed or converted.

identifierstring

New identifier. The animal's identifier, typically a microchip (transponder) number, but it can be a tattoo, registration number or practice-management-system id. Free text, not unique; matched by the patient list search.

insurancestring

New insurance company. Name of the animal's insurance company, free text.

Example request

{
  "name": "Bella",
  "species": "Dog - Labrador Retriever",
  "breed": "Labrador Retriever",
  "dateOfBirth": "2018-04-12",
  "gender": "Female Neutered",
  "weight": "25.0 kg",
  "identifier": "752098100012345",
  "insurance": "Agria"
}

Response

Confirmation that the patient was updated.

successboolean required

Always true; failures are returned as errors.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.