ezyVet API
Search K

Appearance

Standard of Care ​

What is an SOC? ​

A SOC is a list of treatments and vaccinations that a pet should be receiving on a regular basis in order to maintain it’s baseline health.

Where is the SOC information for an animal in the UI? ​

The list of required treatments and vaccinations included in an animal’s SOC can be found by navigating to the Animals (purple) tab, selecting the desired animal record then navigating to the S.O.C tab.

In the image below, the S.O.C tab text is red. This indicates that there is an overdue treatment.

soc-example1

The same data can be found by navigating to the Clinical (green) tab, selecting the desired animal’s clinical record then navigating to the S.O.C tab.

soc-example2

Once you’ve navigated to the S.O.C tab, you’ll see the Standard Of Care table. Again, those events where the text is red are overdue.

soc-example3

Where are SOC events configured? ​

Navigate to the Admin (red) tab and, using the drop down menu on the left, select Event Groups

soc-example4

Here you can view and edit Event Groups (vaccines or treatments). You can select which species the SOC is for, configure exclusions and which products will satisfy the requirement.

soc-example5

What impacts an SOC event? ​

  • Prescribing a medication that satisfies an event group.

  • Administering a vaccination that satisfies an event group.

  • Performing a treatment or procedure that satisfies an event group.

How often is the data updated in the API? ​

Data is updated near-real-time so polling of the endpoint can be actioned periodically.

Where is the SOC information for an animal in the API? ​

SOC information is available by making a GET request to the v2/standardofcare endpoint. The below is an example of the response.

JSON
"standardofcare": {
"id": 4,
"uid": "standardOfCare_jt3AXwOC6fa6QcwxAw3pE",
"deleted_at": null,
"due_at": 1740616500,
"last_fulfilled_at": 1736987700,
"animal_id": 3,
"animal_uid": "animal_lv5NQKC9g1PUCej0EKE53",
"soc_group_id": 16,
"soc_group_uid": "socGroup_k1ifocFYjwkkYUfk812E9",
"soc_group_name": "Flea and Tick",
"soc_group_type": "Treatment",
"ownership_id": 4,
"ownership_uid": "ownershipSeparation_cAl0DAnmH0C1EqVw0souz",
"calculated_at": 1736987733,
"created_at": 1731055229,
"modified_at": 1736987733
}

Can I get a list of event groups via the API? ​

Yes, you can make a GET request to the v2/eventgroup endpoint to retrieve a list of event group objects. The below is an example of the response.

JSON
"eventgroup": {
"id": 1,
"uid": "socGroup_yR3VokRf1OvtHWoqTrpCp",
"created_at": 1434853886,
"modified_at": 1571345031,
"active": false,
"name": "Equine Herpes Virus",
"type": "Vaccine",
"importance": "Core"
}

How often should I poll the above endpoints? ​

Due to ezyVet’s API rate limits, it’s encouraged to poll the v2/standardofcare endpoint no more than once per minute. When doing so, in order to maximize performance of the ezyVet API and the clinic’s UI, the query should include the modified_at query parameter where the value would be the epoch time of the last time the endpoint was queried. This will ensure that the returned results are only those that have changed since the last poll.