List of resources available in jsslab module

List of resources available in jsslab module

List of resources available in jsslab module of OpenMRS

Resource

Resource URI

Description

Resource

Resource URI

Description

  • laborder

HOST + /ws/rest/v1/order?type=laborder

contains lab related orders which has been derived from class "order

  • labInstrument

HOST + /ws/rest/v1/jsslab/labInstrument

contains data of all labInstrument

  • labOrderSpecimen

HOST + /ws/rest/v1/jsslab/labOrderSpecimen

Join table for LabOrder and LabSpecimen

  • labPrecondition

HOST + /ws/rest/v1/jsslab/labPrecondition

contains necessary preconditions for a lab test

  • labReport

HOST + /ws/rest/v1/jsslab/labReport

what the lab produces; covers all tests for a set of orders and specimens

  • labSpecimen

HOST + /ws/rest/v1/jsslab/labSpecimen

what is received at the lab for testing

  • labSpecimenTemplate

HOST + /ws/rest/v1/jsslab/labSpecimenTemplate

contains list of attributes for a particular type of specimen

  • labSupplyItem

HOST + /ws/rest/v1/jsslab/labSupplyItem

contains list of items being used during a test (for inventory management)

  • labTest

HOST + /ws/rest/v1/jsslab/labTest

process by which a single result value is assigned to a specific specimen

  • labTestPanel

HOST + /ws/rest/v1/jsslab/labTestPanel

A collection of tests which are ordered together

  • labTestRange

HOST + /ws/rest/v1/jsslab/labTestRange

contains valid range of result for test

  • labTestResult

HOST + /ws/rest/v1/jsslab/labTestResult

contains result of a laborder

  • labTestSpecimen

HOST + /ws/rest/v1/jsslab/labTestSpecimen

what is prepared from the specimen that actually undergoes testing

NOTE: Name of resources will be changed to lowercase (from camelCase) in near future.

How to make REST calls

Basic info on how to make REST calls to create, retrieve, update or delete resources can be found on the OpenMRS Wiki.

To access a jsslab specific resource, use following string:

HOST + /ws/rest/v1/jsslab/<resource name>

Here are some sample calls (using our public test server):

http://openmrs.gielow.me/openmrs-1.8.4/ws/rest/v1/jsslab/labInstrument - retrieves a list of all LabInstruments

http://openmrs.gielow.me/openmrs-1.8.4/ws/rest/v1/jsslab/labInstrument/72a26526-21d2-11e1-9815-00265e639063 - retrieves one specific LabInstrument

To figure out the required fields in POST call, use one of 3 ways:

  •  Look for not null in the table definition in MySQL

  •  Look for a not-null property with true value in hbm.xml files

  •  Look at action in validator method for the class