Wiki Spaces


Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack


Page tree
Skip to end of metadata
Go to start of metadata

What this module does

The module exposes the OpenMRS API as REST web services.  If an OpenMRS instance is running the Webservices.REST module, other programs (and languages) can connect to retrieve and post certain information to an OpenMRS database.


Source at:
Download at:

User Documentation

Visit for an overview of our Rest Documentation.

Required OpenMRS Version

The REST Web Services module requires at least OpenMRS 1.9.0 or 1.8.1 to run.

Basic Configuration Options

Configuration keyDescription setting determines the maximum number of resources that can be accessed on any webservice call.  The default is 50. setting determines the absolute maximum number of resources that can be accessed on any web service call. If the client requests more than this limit, then receives an error. The default is 1000.

This should point at the root of your exposed web application.  This is typically http://localhost:8080/openmrs during testing, but after being deployed will be something like or

If this is empty or not filled in, the user will see NEEDSTOBECONFIGURED/ws/rest/ as the "self" urls on all objects.

By default this is an empty string: "", which means anyone can access the rest URLs. If you put any IP addresses into this list, only calls from those are allowed. IPs should be separated by a whitespace or a comma.

IPs can be declared with bit masks to denote whole subdomains e.g. matches - and matches - Non matching IP addresses will receive a 403 HTTP error. Both IPv4 and IPv6 addresses are supported.

Technical Documentation

The module exposes the OpenMRS API through light-weight resource objects off of the core OpenMRS objects. The structure is very similar, but not guaranteed to match up exactly.

This module uses Spring 3 annotations to expose URLs. Primary transport language is currently JSON and XML (beta in 2.1).

For Creators of Web Service Core/Module Methods

Adding a Web Service Step by Step Guide for Core Developers
Adding a Web Service Step by Step Guide for Module Developers

For Web Service Client Developers

See REST Web Services API For Clients

Development History

Initial project page: Enhanced Web Services (Design Page)
Development sprint 1: 2011-05-16 Development Sprint
Followup sprint: 2011-05-30 Development Sprint
Development sprint 2: 2011-07-05 Development Sprint
Development sprint 3: 2013-02-07 Integration of RESTWS

Example Client code

Release Notes

  • 2.14+
    • See JIRA for details
  • 2.13 Released January 7th 2016
    • Add support for OpenMRS Platform 2.0.0 (beta)
    • And:

      Key Summary T Assignee Reporter P

  • 2.12

    Key Summary T Assignee Reporter P

  • 2.11

    Key Summary T Assignee Reporter P

  • 2.10

    Key Summary T Assignee Reporter P

  • 2.9 Released January 15th 2015

    Key Summary T Assignee Reporter P

  • 2.8
  • 2.7

    Release Date: Wednesday November 26th 2014

    2.7 represents version: 20afb1bcdbc46a75859e2c736a8651fa38614720

    A huge thank you goes out to the following contributors: Daniel Kayiwa, Darius Jazayeri, Jon Skeet, Pawe? Muchowski, Rafal Korytkowski, Willa Ahmed, Wyclif Luyima

    New Features

    • [RESTWS-453] - Expose login locations via REST
    • [RESTWS-455] - Add ConceptSearchResource
    • [RESTWS-457] - orderfrequency resource should have a representation that includes the full concept representation
    • [RESTWS-461] - Should automatically convert to Double
    • [RESTWS-463] - encounter resource should let you create real-time encounters without explicitly specifying encounterDatetime
    • [RESTWS-465] - Get inactive orders

    Bug Fixes

    • [RESTWS-451] - Nested custom type will fail with conversion exception
    • [RESTWS-454] - deathDate property should be editable on the person resource
    • [RESTWS-458] - orderfrequency resource should have display property
    • [RESTWS-464] - encounter resource has a typo that prevents creating an encounter with orders easily
    • [RESTWS-467] - Going to catalog API using JSON causes stack overflow due to subtypes
    • [RESTWS-469] - NPE generating catalog
    • [RESTWS-470] - Catalog incorrectly shows sub-resources
    • [RESTWS-471] - A resource implementing Listable without Searchable fails in MainResourceController
  • 2.6

New Features

    • [RESTWS-281] - REST does not expose relationships or relationship_types
    • [RESTWS-444] - Add brandName and dispenseAsWritten to DrugOrderSubclassHandler1_10


    • [RESTWS-426] - REST can return a Patient representation when we want a Person rep
    • [RESTWS-441] - User and concept search handlers do not work for OpenMRS 1.10
    • [RESTWS-442] - ProviderSearchHandler should handle OpenMRS 1.10

  • 2.5

    Key Summary T Assignee Reporter P

Download standalone with webservices module for an out of the box openmrs with rest web services ready to go.

1 Comment

  1. Is there any good reason it shouldn't be "requires at least OpenMRS 1.8.1 to run" instead of  "requires at least OpenMRS 1.9.0 or 1.8.1 to run"?