SAVE THE DATE - #OHIE19 Nov 4-8, 2019 in Addis Ababa, Ethiopia - CLICK HERE
Skip to end of metadata
Go to start of metadata


Description: This workflow supports an HIE requesting updated mechanism data from an external source system.  



Referenced Standards and APIs:

Assumptions and Prerequisites

  • There is a single source where mechanism metadata is managed and maintained.  
  • Implementers not using DHIS2 will need to determine how to take the mechanism updates that are provided and import them into the HMIS that is used for aggregate data reporting (step 10 below).  


External System Actor (Actor outside this HIE)

  • The system where the mechanism metadata is managed / curated.   

OpenHIE System Actors (Actors within the HIE requesting the mechanism metatdata.)

  • IL -The Interoperability Layer (IL) is the component that enables easier interoperability between disparate information systems by connecting the infrastructure services and client applications together. An interoperability layer receives transactions from the external system and coordinates interaction between components of the HIE and provides common core functions to simplify the interoperability between systems.
  • ILR  - InterLinked registry. 
  • HMIS - This is the system where the mechanism data needs to be used.  


Technical Details 

Technical details are being captured here until they are finalized -

Step NumberInteractionDesign NotesDataTransaction Standard


Initiate Refresh of metadata

This is an implementation option.  For DATIM Node, the IL initiates an HTTP GET to the ILR. In future versions, consider assigning responsibility for initiating metadata updates to the consuming application.The data to be refreshed is the "DATIM Mechanism List" document 


Generate Query for updated metadata 

Generate a query request to get the metadata that has been updated since the last request.  Query for Updated Services (ITI-74) request.  


Log the message headers

Log the query header and record a date/time stamp.  

Record headers of Query for Updated Services (ITI-74) request 



Send the query to the external system.  

Ensure a secure connection and pass-through the query for Updated Services (ITI-74) request to an external system.



Receive Query Response

Support the receipt of an ITI-74 response document.  

ITI-74 response document with additions and updates that have been made since the date of last update.   


Log the response document

Log the response document and the date/time the response document received.

ITI-74 Response Document 


Pass-through Query for Updated Services response

 ITI-74 Response Document 


Begin workflow by  getting query parameters

Generate Find Matching Services (ITI-73) request parameters based on user input\n(DHIS2 webapp)  


Initiate a Find Matching Services request using a stored query.  

Initiate a Find Matching Services Request using a stored query and the parameters provided by the user.  

Option 1 - HMIS systems that support CSD

Initiate Find Matching Services (ITI-73) request using a stored query  to generate CSD.  The intent is to move DHIS2 to option one as soon as possible.  


Option 2 - DHIS2

Initiate Find Matching Services (ITI-73) request using specialized stored query:\n"" to generate DXF



Generate Find Matching Services response.

Generate a Find Matching Services (ITI-73) Response based upon the query parameters.  



Load the mechanism list

This is implementation specific. For the DATIM Node implementation this will be code that selects the required mechanisms based upon DATIM access lists.   




Test Cases 

The following are the high-level test cases that this workflow must support:  

Test CaseDescription

Message Examples

Document where implementers can find example messages

  • No labels