REST Module

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.

Downloads

Source at: https://github.com/openmrs/openmrs-module-webservices.rest
Download at: https://addons.openmrs.org/#/show/org.openmrs.module.webservices-rest

User Documentation

Visit https://rest.openmrs.org/#openmrs-rest-api 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

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

• Quick java swing client that displays patients and encounters: http://svn.openmrs.org/openmrs-contrib/examples/webservices/hackyswingexample/
• In the following link you can download a client (API) java that allows  add - edit a person (any resource) and make a query to Webservice.Rest https://project-development-software-victor-aravena.googlecode.com/svn/trunk/ClientOpenMRSRest/ 

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	type	assignee	reporter	priority
    Unable to locate Jira server for this macro. It may be due to Application Link configuration.

• 2.12
  

  key	summary	type	assignee	reporter	priority
  Unable to locate Jira server for this macro. It may be due to Application Link configuration.

• 2.11
  

  key	summary	type	assignee	reporter	priority
  Unable to locate Jira server for this macro. It may be due to Application Link configuration.

• 2.10
  

  key	summary	type	assignee	reporter	priority
  Unable to locate Jira server for this macro. It may be due to Application Link configuration.

• 2.9 Released January 15th 2015
  
  

  key	summary	type	assignee	reporter	priority
  Unable to locate Jira server for this macro. It may be due to Application Link configuration.

  
   
• 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

Bugs

• • [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	type	assignee	reporter	priority
  Unable to locate Jira server for this macro. It may be due to Application Link configuration.

• 2.4

  	RESTWS-371	There should be a way to create a patient in a single call
  	RESTWS-395	should be allowed to supply identifierType by uuid which creating patient
  	RESTWS-394	saving attributes on PersonResource fails with NullPointerException
  	RESTWS-397	Cannot search for numeric concept "full" representation
  	RESTWS-399	REST API for patient not returning person.personDateCreated
  	RESTWS-393	ConceptResource does not return full tree of its members
  	RESTWS-400	OrderResource1_8 does not have voided property in Default or Full Representation
  	RESTWS-401	Properties should be allowed to be set to null
  	RESTWS-396	Obs with 1 groupMember does not fetch the group members.
  	RESTWS-402	BaseRestController unnecessarily stores state
  	RESTWS-398	Support gender, birthdate, birthdateEstimated, addresses, attributes and names as updatable properties in PersonResource.

• 2.3
  • New Features
    
    • RESTWS-392 - APIAuthenticationException handler always adds WWW-Authenticate header when user is not logged in.
  • Bug Fixes
    • Changed setMembers to full representation
• 2.2
  • New Features
    
    • [RESTWS-348] - Require that user have View REST WS Menu privilege to view the menu in the administration page
    • [RESTWS-391] - Rest API to search drug by name
  • Bug Fixes
    
    • [RESTWS-373] - Incorrect Converter returned in ConversionUtil convertToRepresentation()
    • [RESTWS-381] - Return object representation instead of id for person attribute
    • [RESTWS-384] - restService.getSearchHandler fails with ClassCastException
    • [RESTWS-389] - Cannot set location person attribute with uuid
    • [RESTWS-390] - PersonAttributeTypeResource should render hydrated concept
• 2.1
  • Better XML support (backwads incompatibility, see RESTWS-206)
  • Replaced .../concept/<conceptname> with .../concept?name=<conceptname> (backwards incompatibility, see RESTWS-370)
  • Additional search handlers
  • Improvements to the catalog
• 2.0 (see Migration from REST 1.x to 2.x)
  • Integrated Webservices.rest 1.9 extension module
  • Removed controllers (single point of entry)
  • Added search handlers
  • Added support for Concept mappings
• 1.1
  • (23 bugs/features fixed/added)
  • Fixed concept.answers
  • Fixed patient.identifiers
  • Made more resources editable
  • Added ability to return retired resources generally
  • Added Provider and Visit support to the 1.9ext module
• 1.0
  • Main functionality realized with no new bugs
• 0.9 (Beta)
  • Bugfixes
• 0.8 (Alpha)
  • All use cases working as defined on the Web Service 1.0 User Stories page
  • Download omod to install in your own OpenMRS installation

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