Atom Feed Based Synchronization in Bahmni

Introduction to Atom Feed Based Synchronization

Video Overview - AtomFeed Sync

YouTube Video giving an overview of Atom Feed sync mechanism of Bahmni: ATOM Feed Integration in Bahmni (Online session)

Bahmni uses ATOM Feed synchronization (event notification over REST APIs) to allow services to pull for changes occurring in Bahmni. The Bahmni EMR (OpenMRS) publishes various event feeds, like Patient, Encounter, Lab, Drug feeds, and the other systems subscribe to these event feeds, to be notified of changes. Based on the "notification", the downstream consuming systems make a REST API call to OpenMRS, to pull relevant data. Typically a sync service is written for each consumer, that listens to these events, constructs the relevant data packets, and then pushes to downstream system (like ELIS, ERP, etc).

Different Components like OpenMRS, OpenERP and OpenELIS are kept in Sync using the "Atom Feed Based Synchronization".  The following is the depiction:

Lets take an example of Drug creation in bahmni.  The following are the sequence of events:

  1. Administrators create Drugs using OpenMRS or using the "CSV Upload" feature on Bahmni's Admin module
  2. Once the drug is created, an event is published (in the Drug Feed)
  3. The "OpenERP atom feed service" contains batch jobs that are scheduled to consume these atom feed events.
  4. The job then creates an event in OpenERP (or Odoo).

Various Feeds Published in Bahmni

Feed NameURLDescription
1OpenMRS Patient Feed

Recent Events:

Page1 Events:

Click on "View Source" to see the actual XML feed
2OpenMRS Encounter Feed between Provider and Patients (along with data logged in those encounters)
3OpenMRS Lab Events
4OpenMRS Drug Events

 See this sample configuration file for various feeds (in OpenERP Sync Service):

Reference Code in Bahmni for Various Atom Feed Sync Services

Data FlowEntities being sentCode RepoCode Link
1OpenMRS (EMR) → OpenELIS (Lab)Patient, Tests/Panels, Lab
2OpenELIS (Lab) → OpenMRS (EMR)Test
3OpenMRS (EMR) → Odoo (ERP)

Patient, Drugs, Tests/Panels, Drug Orders, Lab Orders, 

Service Orders

4OpenMRS (EMR) → DCM4chee (Radiology)Patient, Radiology (Atomfeed + HL7)
5Sample Code Repo to write your own integration

Underlying ATOM Feed Libraries

Bahmni uses an Atom Feed based framework created by ThoughtWorks ICT4H team for data synchronization between OpenMRS, OpenELIS and OpenERP (in fact also with Reference Data app). For more information on the underlying atomfeed implementation please refer to: 

Underlying Database Tables for Atom Feed Synchronization Book-Keeping

The tables used behind the scene in Atom Feed are:

Table NameUsed in ModeDescription

This tables holds the list of events which are to be published by Atom Feed for others to consume. The category column is used to indicate the event types (like patient, encounter, etc).

Note: For the same patient updates there might be multiple rows. So to see unique rows: "select distinct object from event_records where category = 'patient';"

markersCONSUMERThis table holds marker entries to indicate the records which have ALREADY been processed. 
event_records_offset_markerCONSUMERThis table holds cached records for faster event process by the CONSUMER.
failed_eventsCONSUMERThis table holds the list of events which failed and could not be consumed. They are retried later by a different event handler.

Note: The PUBLISH mode is when the system is publishing its events on an Atom Feed. The CONSUME mode is when the system is reading events from another system and writing/updating its own data based on consumed events. OpenMRS, OpenELIS, Odoo – all act as Publisher and Consumer depending on the scenario. For instance, when a Patient is created in Bahmni(OpenMRS), then Bahmni is PUBLISHER and ELIS/Odoo are CONSUMERS. When a Lab result is entered in ELIS, then ELIS is PUBLISHER and Bahmni/OpenMRS is CONSUMER of results. Therefore, these 4 tables will exist in each sub-system that acts as Atom Feed publisher & consumer.

AtomFeed Console Viewer

Atom Feed Console Viewer

In version v0.86 of Bahmni an Atom Feed viewer has been released with Bahmni which can allow you to see Failed events in Bahmni. It can be accessed at url: http://<ip>/atomfeed-console. For instance here is the online demo url for atomfeed console: The Github project for Atom Feed console is:

The Bahmni documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)