Skip to main content

Patient Management

The Patient Management domain is where all the information about the patient itself is maintained, this does not include entities related to clinical records such as weight.

Patient in Merlin?

Patient or Animal is referred to as a Patient in the Merlin system and these records are found after search for a Client.

Entities within Patient Management​

  1. Patient
  2. Insurance Companies
  3. Species
  4. Breeds
  5. Genders
  6. Categories
  7. Colours

Relationships​

The clinical domain will reference other domains, such as Contact for Practitioners, Patients, Formulary, Inventory for batch records, and Billing for references to submit billable records.

The patient domain will be referenced to by many other domains most commonly with the patient-uuid, such as Clinical, Calendar, Communications and Reminders.

  1. Patients are always associated with a single account.
  2. Patients can only have one breed associated, the primary breed should be set with the bool status-crossbreed in the case of a cross of multiple breeds if the cross breed has not been added to the breed API by the practice.
  3. The primary colour or nearest colour from the practice library must be selected, only one colour option is can be associated.

Patient Schema​

Please take note of the following points for this schema:

  1. Microchip Numbers Microchip numbers are not stored as unique in the database, an animal may have a duplicate entry.
  2. Herds Herd Reference and Herd Size fields are only used when the Patient Category is "Farm Animal".
  3. Deleting a Patient A patient will only be soft deleted and can later be Activated again if required.
  4. Location A patients saved location is not currently available via the API pending a review of Merlin functionality.
  5. Date of Birth This date is recorded as midnight for the logged location. With UK BST the API may return the day prior at 23:00. Ensure you compensate for UTC in the returned payload. Note: This may change in a future release to a date field only.

Cross Domain UUID References​

ReferenceDomainResourceNote
discount-category-uuidBilling/discount-categoriesUsed to calculate discounts during invoicing.

Security Scopes​

The following authorisation scopes are required to access different resources within this domain:

  • patient:read
  • patient:create
  • patient:update
  • patient:remove
  • patient:meta:read