Laboratory API Spec

Submitted by svrkenny on Mon, 14/10/2024 - 16:19

General developer's discussion

Hi team,

Currently i'm building an API layer (in C#) to communicate with OpenVPMS laboratory API. But i couldn't found any specification detail about the Laboratory APIs. The spec details i manage to get is referring this page https://www.openvpms.org/developers-handbook/online-booking-api/v2

Please advice

Kenny Oh

Re: Laboratory API Spec

Submitted by tanderson on Mon, 14/10/2024 - 18:00.

To integrate OpenVPMS with a laboratory, you need to implement the Laboratory API in an OSGi plugin.

Take a look at the sample plugin implementation at https://bitbucket.org/OpenVPMS/openvpms/src/2.4/openvpms-laboratory/open...

In particular, the SampleLaboratoryService class.

Re: Laboratory API Spec

Submitted by svrkenny on Mon, 14/10/2024 - 18:37.

Hi Tanderson

What's OSGI plugin? The plugin implementation is build using java on top of OpenVPMS ?

Thanks

Re: Laboratory API Spec

Submitted by tanderson on Mon, 14/10/2024 - 18:49.

Yes. You provide an implementation of org.openvpms.laboratory.service.LaboratoryService packaged in a jar conforming to the OSGi spec.

This implementation is responsible for:

making the tests your laboratory supports available to users
validating and submitting orders to your laboratory
attaching results to the order when they become available

You can grab a pre-built version of the sample plugin from https://repository.openvpms.org/releases/org/openvpms/openvpms-sample-la... and deploy it via Administration -> System -> Plugins if you want to try it out.

Re: Laboratory API Spec

Submitted by svrkenny on Tue, 15/10/2024 - 11:15.

Hi Tanderson

Correct me if i'm wrong. Logically the plugin implementation internally access OpenVPMS's database, process and revert back the information back to external (Eg. third party vendor via API).

Thanks