allergiesstring required
The allergies of the clinic patient.
auto_rabies_tagstring nullable required
The last automatically recorded rabies tag (driven by treatments).
birth_dayinteger nullable required
The birth day of the clinic patient.
birth_monthinteger nullable required
The birth month of the clinic patient.
birth_yearinteger nullable required
The birth year of the clinic patient.
clinic_idinteger nullable required
The ID of the clinic to which this clinic patient belongs.
createdstring date-time required
The datetime this object was created.
custom_breedstring nullable required
A custom breed declared for this patient. Useful for breeds which are not yet in our official listing of breeds.
custom_speciesstring nullable required
Custom species declared for this patient if species is set to Other.
date_of_birthstring date nullable required
The date of birth of the clinic patient in ISO format (YYYY-MM-DD). Derived from birth_year, birth_month, and birth_day.
deactivated_atstring date-time nullable required
The timestamp when the clinic patient became inactive (deceased, surrendered, or deleted).
deceased_datestring date nullable required
The date when the clinic patient passed away, if applicable. Format: YYYY-MM-DD.
deletedstring date-time nullable required
The datetime this record was soft deleted.
external_idstring nullable required
The ID from a clinic's legacy PIMS system, if the data was imported from there.
first_visit_datestring date nullable required
The date of the clinic patient's first visit. Format: YYYY-MM-DD.
idinteger required
The ID of the clinic patient.
image_urlstring nullable required
A pre-signed S3 URL good for 24 hours after request to the patient's profile picture, if any.
is_activeboolean required
Whether the clinic patient is currently active (not deceased, surrendered, or deactivated).
is_aliveboolean required
Whether this patient is alive.
is_alteredboolean nullable required
Whether this patient is altered (spayed or neutered, as appropriate). Can be null if we do not know whether the patient is altered.
is_deactivatedboolean required
Whether this patient has been marked as deactivated.
is_deletedboolean required
Whether this record is soft deleted or not.
is_legacy_deactivatedboolean required
Whether this patient was marked as deactivated in the clinic's legacy PIMS.
is_surrenderedboolean required
Whether this patient has been surrendered by all related clients.
last_visit_datestring date nullable required
The date of the clinic patient's last visit. Format: YYYY-MM-DD.
metadataobject required
User-set metadata related to this patient.
microchip_numberstring nullable required
The microchip number of the clinic patient.
microchip_number_updated_atstring date-time nullable required
The timestamp when the patient's microchip number was last set or changed. This is a last-updated timestamp, not a strict assignment date, and there is no removed-date concept — the microchip number is overwritten with the latest value.
modifiedstring date-time required
The datetime this object was last modified; changes to related entities will not update this field.
namestring required
The name of the clinic patient.
organization_patient_idinteger nullable required
The organization patient ID corresponding to this clinic patient
patient_notesstring required
Notes set on the clinic patient via the PIMS calendar.
pim_idstring nullable required
The ID of the clinic patient in the clinic's PIMS.
primary_clinic_client_idinteger required
The ID of the primary clinic client associated with this clinic patient.
reissued_rabies_tagstring nullable required
The manually updated rabies tag, which overrides the automatically set one.
sex'MALE' | 'FEMALE' | 'UNKNOWN' required
surrendered_datestring date nullable required
The date when the patient was surrendered, if applicable.
weightnumber nullable required
The weight of the clinic patient, in pounds (legacy field).
weight_in_unitsnumber nullable required
The weight of the clinic patient in the unit specified by weight_unit.