Quick Links

Integration Solution Example

Webhooks

REST API

Data Available Through the REST API

Usage Example

Example Source Code

Custom Integrations

Introduction

Provet Cloud veterinary practice management system can be integrated with third-party applications using tools called REST API and webhooks. This article describes the usage of these integration methodologies.

Webhooks are available in Provet Cloud to send notifications to 3rd party systems about additions or changes in the data inside Provet Cloud. The webhooks don't transfer the actual changed data, but instead, they transfer the information about what has changed by simply notifying the 3rd party system about the change. The actual data can then be fetched by the 3rd party system by utilising the REST API of Provet Cloud.

REST API is a communication method to access, edit or add to the data residing in Provet Cloud programmatically by any 3rd party application. Provet Cloud's REST API offers most of the key Provet Cloud data to be read or manipulated by other systems.

The combination of Provet Cloud webhooks & REST API creates unique possibilities for building integrated solutions. Any vendor of other systems familiar with these technologies can easily integrate with the data residing in the Provet Cloud veterinary practice management system by utilising these technologies.

Nordhealth offers consultancy to assist with the usage of the REST API & webhooks. We can also build customised adaptors to process or format the data to more traditional transfer formats such as XML, ASCII, or CSV files.

NOTE: See more from our developer site.

Integration Solution Example

Case: If a 3rd party system (e.g. a financial system) would like to have immediate information about a newly created consultation in the Provet Cloud, this could be archived by combining the webhooks & REST API in the following way by utilising the consultation webhook.

1. A consultation is created in Provet Cloud.
2. Provet Cloud sends a consultation HTTP hook notification to the URL defined in the settings.
   • Webhook: Consultation create/update
   • Parameter: consultation_id=123 (consultation with ID 123 has been created)
3. Third party system receives the hook and knows that consultation with ID 123 has been created in the Provet Cloud.
4. Third party system requests the consultation with ID 123 data by using the REST API call.
5. Provet Cloud returns the data for the consultation with ID 123 in the JSON format.
6. Third party system receives the data of the consultation and processes it in the desired way (and creates further REST API calls, if necessary).

Webhooks

Webhooks are configured and enabled in Settings > General > Integrations > Webhooks.

• Webhooks are HTTP POST requests to the URL defined in the settings for each webhook
• The POST request has data identifying what type of data was updated, and the ID of the object
• Example: “consultation_id=123”
• Webhooks expect to receive an HTTP 200 response on the successful process
• If the response is other than HTTP 200, the notification delivery will be retried
• On the settings page, you can also see an up-to-date list of triggered webhooks and their delivery status. A log is available for the review
• Webhooks can be set to be department-specific, in which case they only trigger when items on a certain department are updated, or can be set to be organization-wide, in which case they always trigger.
• Leaving the department field empty will make the webhook work across the entire organization.
• Certain actions where departments cannot be inferred, such as updating clients and patients through the REST API, do not trigger department-specific webhooks.
• Multiple webhooks can be set for the same trigger and/or department, and updates will trigger all of the webhooks that apply in the situation.
• Webhooks can be given an optional name to help identify and differentiate them.
• No longer needed webhooks can be disabled by unchecking the Active checkbox.

The following Webhook events are currently available in the settings of the Provet Cloud. Each of the hooks can have a different (or same) URL address, to which the Provet Cloud sends the hook when triggered at the event.

• Client create/update: parameter client_id
• Patient create/update: parameter patient_id
• Consultation create/update: parameter consultation_id
• Consultation delete: parameter consultation_id
• Consultation item create/update: parameter consultationitem_id
• Diagnostic imaging worklist create: parameter diagnosticimagingworklist_id
• Diagnostic imaging worklist update: parameter diagnosticimagingworklist_id
• Diagnostic imaging worklist delete: parameter diagnosticimagingworklist_id
• Invoice finalized: parameter invoice_id
• Invoice draft hook, notifies when a draft invoice is updated or items added automatically from insurance claim: parameter invoice_id
• Invoice payment create: parameter invoicepayment_id
• Prepayment create/update: parameter unallocatedpayment_id
• Insurance claim create/update: parameter insuranceclaim_id
• Organization item create/update: parameter organizationitem_id
• Accounting report create: parameter accountingreport_id
• Laboratory referral create/update: parameter laboratory_referral_id

REST API

Provet Cloud provides the REST API for enabling access to the data stored in the Provet Cloud. The API uses HTTP requests with authentication headers. The data is returned in the JSON format.

• To access the REST API, you must create an API token in Settings > General > Integrations > API tokens
  • Creating the API tokens is by default only possible for administrators & managers (Provet Cloud permission groups).
  • Please revoke any tokens not used!
• The API token must be set in header ‘Authorization: Token <token_key>’ for every HTTP request to the API
• The API can be viewed and tested online:
  • Instructions on how to set the header for testing in Chrome: Provet_Cloud-REST_API_headers
  • Instructions on how to make a request to Provet Cloud REST API using Postman: Provet_Cloud-REST_API_Postman
• The REST API can be accessed by using the following URL: https://provetcloud.com/<provet_id>/api/0.1/
  • In the URL <provet_id> is the unique id of the Provet Cloud instance for your company

Provet Cloud REST API is browseable, which should allow a good possibility for developers to evaluate the possibilities of data transfer.

Data Available Through the REST API

The REST API can be used to read most of the data and create/update some selected parts of the data. The first page of the browsable API lists all of the objects that can be accessed. Here’s the list of the most common objects.

Usage Example

To get information about a consultation with ID number 338, an HTTP GET request with the authentication parameters would be sent to the following URL: https://provetcloud.com/<provet_id>/api/0.1/consultation/338/

Response example:

{
    "url": "https://provetcloud.com/api/0.1/consultation/338/",
    "client": "https://provetcloud.com/4/api/0.1/client/1/",
    "patients": [
        "https://provetcloud.com/4/api/0.1/patient/1/"
    ],
    "complaint": "Test consultation",
    "admitted_time": "2017-05-18T10:35:00Z",
    "first_entry": null,
    "started": "2017-05-18T10:35:00Z",
    "finished": null,
    "ended": null,
    "status": 8,
    "type": 0,
    "invoice": "https://provetcloud.com/api/0.1/invoice/609/",
    "supervising_veterinarian": "https://provetcloud.com/api/0.1/user/1/",
    "department": "https://provetcloud.com//api/0.1/department/1/",
    "consultation_items": [
        "https://provetcloud.com/api/0.1/consultationitem/4558/",
        "https://provetcloud.com/api/0.1/consultationitem/4559/",
        "https://provetcloud.com/api/0.1/consultationitem/4560/"
    ],
    "reporting_dimension_1": null,
    "reporting_dimension_2": null
}

From the response it is possible to further find the ID of the invoice, that is related to this consultation, as well as all other items that are related to this consultation. Those can be then acquired by further REST API calls.

Filters

Some endpoints have fields that can be used to filter the results. The filterable fields can be seen at the top of your Provet Cloud REST API endpoint page (eg. https://provetcloud.com/<provet_id>/api/0.1/consultation/) if the endpoint has filterable fields.

The following methods are available for filtering (synonyms are comma-separated):

• is, eq (equal)
• is_not, not_eq, neq (not equal)
• lt (less than)
• lte (less than or equal)
• gt (greater than)
• gte (greater than or equal)
• range (values between, needs two values in order [from,to])
• not_in_range (above inversed)
• contains (text contains the searched text, case-sensitive)
• contains_not (above inversed)
• icontains (text contains the searched text, case-insensitive)
• icontains_not (above inversed)
• in (item is found in the given list [value1,value2,value3])
• not_in (above inversed)
• is_null (true or false)

The filtering methods can be used with query parameters using the following syntaxes:

  [field]__[method]=value (eg. client__is=10 which uses the id of the client for the search)

  [field].[property]__[method]=value (eg. client.id__is=10)

Note that dates should be given for the query parameters in the format YYYY-MM-DD hh:mm+[TimeZone]hh:mm (eg. 2017-12-24 15:30+00:00).

If we need to find all consultations with the conditions

• complaint contains the word “vacc” (case-insensitive)
• the admitted_time is between 2017-12-01 00:00+00:00 (greater than or equal) and 2018-01-01 00:00+00:00 (less than)
• department id is 1
• client id is 10
• one of the patients’ id in the consultation is 20

we would use the following url:

https://provetcloud.com/<provet_id>/api/0.1/consultation/?complaint__icontains=vacc&admitted_time__gte=2017-12-01 00:00%2B00:00&admitted_time__lt=2018-01-01 00:00%2B00:00&department__is=1&client__is=10&patients__is=20

Note that "+" signs are URL encoded (%2B) in the above example for the URL to work.

If we need to find all consultations where

• the client’s first name is John and
• the client’s last name is Doe

we would use the following URL:

https://provetcloud.com/<provet_id>/api/0.1/consultation/?client.firstname__is=John&client.lastname__is=Doe

Expose

Some endpoints have fields that can be exposed, which will then show some of the inner fields of the exposed object. The exposable fields can be seen at the top of your Provet Cloud REST API endpoint page (eg. https://provetcloud.com/<provet_id>/api/0.1/invoicerow/) if the endpoint has exposable fields. To expose a field, you can add ?expose_<field_name> into the URL, much like filters are used.

Example Source Code

As an example of the use of the REST API, we provide some examples in the PHP programming language.

Please download the attached ZIP file to review the code examples on the REST API usage from this link.

Custom Integrations

Even though our webhooks & REST API provide a possibility for self-service integrations, Nordhealth also provides consultancy services for the development of the integrations. See the related article below. Please contact Provet Cloud support to discuss any additional requirements.

See Also

Custom Integrations

https://developers.provetcloud.com/

Authorization Change 2023

Attachments