View Source

OpenSRP atomfeed module is based on ICT4H Atomfeed Module and it`s source code can be cloned here. This module creates feeds for different transactions happening into OpenMRS.

Setup instructions:

Download module release from here
Once installed goto configure and change property 'atomfeed.data-update.data-entry.roles-to-ignore'.
- NOTE: For data pushed by OpenSRP we may only want to get feeds which are generated by direct usage of OpenMRS system or are from any other external system.
- We would want to skip data pushed by OpenSRP daemon service (syncer service which push data updated on OpenSRP side)
- This property would force system to skip entries from specified roles.
- OpenSRP daemon (data sync) service should not use credentials of admin or any other user. Rather it should be a special daemon service credentials with Developer Role and Another role which distinguishes i from all other users and should never be used for administering OpenMRS via UI.
If your system handles all atomfeeds make value empty.

Rightnow feeds are available for Patient data Save and Update and Encounter data Save and Update. Full implementation would have following

Entity Type	Child Entity	Transaction Type	Is Available	API Method	Category
Patient	Patient Demographics	Save, Update, Void	Yes	savePatient	OpenSRP_Patient
	Patient Identifier	Save, Update, Void	Yes	savePatient	OpenSRP_Patient
	Patient Address	Save, Update, Void	Yes	savePatient	OpenSRP_Patient
	Patient Attributes	Save, Update, Void	Yes	savePatient	OpenSRP_Patient
Encounter	Encounter Data	Save, Update, Void	Yes	saveEncounter	OpenSRP_Encounter
	Observations	Save, Update, Void	Yes	saveEncounter	OpenSRP_Encounter
Order	Drug Orders	save, Update, Void	Yes	saveOrder	OpenSRP_DrugOrder
Cohort	Cohort Data	Save, Update, Void	No	saveCohort	OpenSRP_Cohort
	Cohort Attributes	Save, Update, Void	No	saveCohort	OpenSRP_Cohort
	Cohort Members	Save, Update, Void	No	saveCohort	OpenSRP_Cohort
Relationship	Patient Relationship	Save, Update, Void	No	saveRelationship, voidRelationship, purgeRelationship	OpenSRP_Relationship

ERD of Atomfeed module:

Documentation > OpenSRP atomfeed module > atomfeederd.png

Note: The highlighted part shows new addition to original module. This module is supposed to work well with orignal module without any conflicts and is using same tables to maintain feeds. The category used by this module has Prefix OpenSRP_category-type. Hence system interested in OpenSRP feeds should be able to distinguish feeds generated by both systems.

Flow diagram or protocol for all Spring Advices module is handling:

Documentation > OpenSRP atomfeed module > ENTITYAdvice-atomfeed.png