Contents


Configuration

  1. About & current partners
  2. On-boarding a new partner
  3. Configuring the SPI integration in Central
  4. Configuring the API Partner integration in the client's site
  5. Configuring the SPI integration in the client's site
  6. Setting up diagnostics
  7. Mapping Species/Breeds


Using the integration
  1. Creating a request
 

About



The Standard PACS Integration (SPI) allows other PACS partners to integrate with ezyVet. It will allow ezyVet users to make a diagnostic request to integrated modalities (e.g. Ultrasound, PACS etc), and the results will come back into ezyVet through the integration.

To read more about what a standard integration is, please see the following article: What are Standard Integrations?

 

This article can be used to configure the following integrations, however for partner specifications and contacts please refer to each article below: 

SoundVet (Sound)

* Please make sure you have read the specifications for each partner integration. If there is anything regarding the integration that does not conform to this article, it will be noted there. For example, the SOUND integration does not support unallocated results.



On-boarding A New Partner


The following is the life-cycle for on-boarding a new SDI partner. Without the following having been completed, the integration will not be available.

1. External company completes the following form with an SDI integration proposal: http://www.ezyvet.com/api-signup/ 
2. API support reviews their business case and provides the partner an agreement to sign.
3. Upon both the external party and ezyVet signing the agreement, the integration proceeds to the development stage.
4. The external party builds against ezyVet's SDI specification.
5. Upon completion of development, end-to-end testing is carried out in the sandbox (testing environment).
6. The integration is then documented.
7. The integration will then go live on a pilot site.



Configuring the SPI Integration in Central (for ezyVet Support)



Before you can configure the SPI integration in Central, the SPI partner will need to be on-boarded as a new partner with ezyVet as outlined in the section above (titled On-boarding A New Partner).

The integration must first be created in the Central sites before they will be available to any client's site.


1. Go to the central site the client's site is linked to.

2. Go to Admin -> integrations → support tool → Click Populate Standard Integrations. This makes the SPI integration available for configuration in Central.

3.  Create the SPI integration in the central site (the SPI Integration will be named after the partner i.e. a partner called 'Test' will have an SDI integration in central called 'Test'.
Navigate to Admin → Integration → Integrations.
Under the integration search, look for the SPI integration and select - This will bring up some more fields.


4. Choose a supplier for this integration (this is mandatory). If it does not exist, you will need to create a new one. To do so, double click into the supplier field, fill out the new client form and click SAVE & CLOSE.

5. Ignore the section 'API Partner' as per the screenshot below:



6. All credentials required under the '[partner] Integration Settings' (i.e. All Endpoints, Client ID's and Client Secrets) are provided by the partner (in the case below, partner = Sound). Support will need to contact the partner for these credentials.


Setting
Description
Required?
Diagnostic Request Endpoint
The URL which ezyVet will use to send diagnostic requests
Required
Fetch Species/Breeds List Endpoint
The URL which ezyVet will use to gather the species/breeds list from the partner
Required
Modalities Endpoint
the URL which ezyVet will use to gather all available modalities from an SPI integration partner (i.e. PACS Supplier)
Required
Company Logo

Not required
Access Token Endpoint
The URL which ezyVet will use to gather an OAuth token for authorization
Required
Client ID & Client Secret
ezyVet will use these to gather an access token from the access token endpoint. These credentials must be specific to the central site only. (must not be the same as any other client site).
Required
Modality
click the modality drown-down once - this will take time to retrieve the modalities in the list. Click the modality drop-down again to produce the list and select a modality. Please note you will need a new integration for each modality (however you do not need a separate API partner integration for each modality).
Not Required in Central. Modality will be required however, when configuring in the client's site.


7. Click SAVE.

8. Under the section 'Tools', click the 'Update Species/Breeds' button.

The species and breeds will sync with the SPI partner's species/breed list once every week.

9. Once the SPI integration has been set up in a central site, you can go ahead and set up the integration on the client's site.




Configuring the API Partner Integration in the Client's Site



1. On the client's site, go to Admin → Integration → Integrations.

2. From the drop down (of the new integration settings tab) choose 'API Partner'.

3. Under the section 'Integration Settings', select a partner from the 'Partner' drop down list.

4. Click SAVE.

5. Upon saving, credentials will be generated and the list of scopes will be displayed. You must click the button 'Select All' under the section 'Scopes'.

6. Click SAVE.

7. Once this is complete, if an SPI partner asks for credentials for that client's site click the 'Download Credentials' button on the top tool bar (next to SAVE) and provide them the downloaded file.






Configuring the SPI Integration in the Client's Site


1. On the client's site, go to Admin → Integration → Integrations.

2. From the drop down (of the new integration settings tab) choose '[partner name]' e.g. a partner called 'Test' will have an SPI integration in the drop-down called 'Test'.)

3. Select division if applicable.

4. Under 'Supplier', choose a supplier. (Create one if necessary). PLEASE NOTE - DO NOT USE A SUPPLIER THAT IS ALREADY BEING USED FOR ANY OTHER TYPE OF INTEGRATION.

5. Under the 'API Partner' section, you must select the API Partner integration you created in the section above Configuring the API Partner Integration in the Client's Site.


6. The partner must provide a unique set of credentials i.e. the Client ID and Client Secret. The 'Client ID' and 'Client Secret' fields under the section '[Partner name] Integration Settings' must be populated using these credentials. Please note, these are NOT the credentials (Client ID and Client Secret) found under the 'API Partner integration' of the previous section.

7. Set the 'Modality' under '[Partner name] Integration Settings'. If this is the first time configuring a SPI, click the modality list once - this will start generating the list of modalities. You can then click the drop-down again with the list of modalities to choose from. Please note, you will need a separate integration AND a separate Supplier for each modality.

9. Click SAVE.


NOTE: These diagnostics will be found under Diagnostics (NOT  integrated diagnostics). 





Setting Up Diagnostics


To send a request to any modality, you will first require the set up of:

1. Products
2. Diagnostics (not integrated diagnostics) mapped to the product and correct supplier (partner supplier).


Diagnostics are created under ADMIN > Clinical > Diagnostics.



Mapping Species/Breeds


To use the integration, you will need to map your species and breeds. Under ADMIN → Species / Breeds.  Click '+ Species Maps' or '+ Breed Maps' and enter the integration, as well as the species.
If a species type does not have a know breed on the 3rd party's end, then an UNKNOWN type of breed can be created in ezyVet, such that those cases can be handled by passing a breed type of UNKNOWN.

 

You can also use the Records dashboard to map species/breeds in bulk.

To map breeds, select record type Breed and click Show Records. Select the breeds you would like to map and set the Action to "Breed - Map Integration Breed".



This will give you a popup where you can select your integration supplier. Adding the integration supplier will then allow you to map each breed you have selected.

To map species, select record type Species and click Show Records. Select the species you would like to map and set the Action to "Species - Map Integration Species".



Creating A Request (to Send to a Modality)


1. Under a patient's clinical record, go to the section 'Diagnostics and Treatments' (white button near the top).

2. Click the + icon next to 'Diagnostic Request' to create a new request. This will bring up a new pop-up.

3. Enter the Vet information, supplier (if you have different modalities you will have different suppliers so ensure you are selecting the appropriate supplier), and diagnostic request.

4. Enter any diagnostic request specifics or history, and click ADD.


5. This will send the request to your worklist on the modality.

6. From there, you can carry out the study. Once the study is complete the result will return to the patient's record in ezyVet. The result will be under 'Diagnostic Result' on the same page where you created the request.

7. If a study was done without a request from ezyVet, the result will still return to ezyVet but will be listed under the unallocated diagnostic results found on the Work List Dashboard.



Find your result, double click on the result and assign the correct client, patient and clinical record.

* Please make sure you have read the specifications for each partner integration. If there is anything regarding the integration that does not conform to this article, it will be noted there. For example, the SOUND integration does not support unallocated results.