This entity represents all Patients configured for the practice.
Note that patient attributes, species, breed, color, and gender are fields that are configurable by users and differ per PIMS and practice. We recommend using the description field as some PIMS do not use display-friendly codes.
Code and Description may be identical depending on presence in the source system.
The attached contains the required format for the Patient.CSV file with a sample record.
The Type defines how the sample file handles the CSV data type to produce the double quote delimiters for each field. Make sure to change the custom field format if any if the fields noted as “integer” contain alphanumeric data.
Fields:
Field Name | Type | Required | Description |
ClientAccountId | “string” | Y | client unique identifier |
AccountId | “string” | Y | patient unique identifier |
FileNumber | “integer” |
| User friendly PIMS ID |
Name | “string” |
| patient name |
SpeciesCode | “string” |
| Species.SpeciesCode |
Species | “string” |
| Species.Species |
BreedCode | “string” |
| Breed.BreedCode |
Breed | “string” |
| Breed.Breed |
ColorCode | “string” |
| Color.ColorCode |
Color | “string” |
| Color.Color |
GenderVal | “string” |
| PMS gender code |
Weight | “decimal” |
| current patient weight |
WeightUnitVal | “string” |
| unit of measurement for patient weight (e.g. lb, oz, kg) |
DOB | “date” |
| patient date of birth |
DOD | “date” |
| patient date of death |
RabiesTagNum | “string” |
| Rabies tag number |
RabiesTagGivenDate | “date” |
| date vaccine was administered |
Microchip | “integer” |
| Value of microchip identifier |
Allergy | “string” |
| Allergy description |
Alert | “string” |
| Alert pop-up |
Markings | “string” |
| Markings description |
Tatoo | “string” |
| Tattoo description |
Comments | “string” |
| Comments |
flgInactive | “Bool” |
| true = Patient is inactive. |
flgDeceased | “date” |
| true = Patient is deceased |
ReferringDoctorAccountID | “string” |
| Referring doctor AccounID |
ReferringHospitalAccountID | “string” |
| Referring practice AccounID |
RegistrationNum | “string” |
| Srevice/National registration number |
Branch | “integer” | Y* | SiteID |
*Branch is required for multi-site data sets.