Description: This workflow describes the process that the Shared Health Record will go through to save an inbound encounter.

Sponsor:  SHR community

Status:  Completed

Last Modified:  12th March 2015

Interfaces that an SHR should support

A Shared Health Record should support receiving of clinical document using an XDS.b interface. The document that is receives are expected to be IHE profiled CDA templates.

Another option for an interface into the SHR was to parse the document at the IL and pass the document in object form to the SHR for storage using a custom interface. We decided against doing this as the cons out weighed the pros. The pros and cons of this approach are listed below:




title SHR Internal save encounter workflow
participant IL
participant SHR Interface as INT
participant Document registry as REG
participant SHR Document store as DS
participant SHR Discrete data storage as DDS
IL->+INT: [1] Send clinical document
INT->+REG: [2] Register document metadata
REG->-INT: [3] Acknowledgement
INT->+DS: [4] Forward clinical document
DS->DS: [5] Store document as-is
DS->-INT: [6] Acknowledgement
INT->+DDS: [7] Send clinical document
DDS->DDS: [8] Parse and extract understood discrete data from the document
DDS->DDS: [9] Persist understood discrete data
DDS->-INT: [10] Acknowledgement
INT->-IL: [11] Acknowledgement that document was stored

Technical details

For a more detailed design of how this can be implemented in the OpenMRS SHR reference application see: OpenMRS as the SHR design document.

RefInteractionEndpointDataTransaction Specification
1Send clinical documentXDS.b provide and register  
2Register document metadataXDS.b specified transaction  
4Forward clinical documentInternal system function  
5Store document as-is   
7Send clinical documentInternal system function  
8Parse and extract understood discrete data from the document   
9Persist understood discrete data   
11Acknowledgement that document was storedXDS.b provide and register response