...
For all user generated connect messages from a patient registry to a donor registry or vice versa the generic message flow consists of the message sent (e.g. a Sample Request) and a corresponding Message Response (6.2). The detailed message flow for such a message including the generic response message is shown below. The generic response message will be ommited omitted in request message flows in chapter 5, for better readability.
...
The message flow below also shows the direct answer to an API call (for simplicity only 200 and 400 are shown).
The flow includes the routinelyroutine, asychron asychronous check for pending messages that has to be implemented by each participating registry in the Connect system, see 2.4.2.
...
| PlantUML Macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
participant "Patient Registry" as PR control "Match-Connect" as MC control "Search & Match\nService" as SM participant "Donor Registry" as DR skinparam SequenceMessageAlign center skinparam dpi 92 == Sending a user generated message == PR -[#dodgerblue]> DR : Send 'Message A' group details note left DR: routinelyroutine asychronasychronous check for pending messages DR -[#green]> MC : Call /availableMessages to check for not-picked up messages activate MC #FFBBBB MC -> DR : 200 OK - Array of messages not yet delivered (**emtpy**) MC -> DR : 400 Bad Request deactivate MC PR -[#green]> MC : Call respective Request-API to send 'Message A' activate MC #FFBBBB MC -> PR : 200 OK MC -> PR : 400 Bad Request deactivate MC DR -[#green]> MC : Call /availableMessages to check for not-picked up messages activate MC #FFBBBB MC -> DR : 200 OK - Array of messages not yet delivered (**'Message A'**) MC -> DR : 400 Bad Request deactivate MC DR -[#green]> MC : Call respective Response-API to picked up 'Message A' activate MC #FFBBBB MC -> DR : 200 OK MC -> DR : 400 Bad Request deactivate MC end == Providing the generic response == DR -[#dodgerblue]> PR : Message response (ack, reject, warning to 'Message A') \nshould always include messageId of referring message group details PR -[#green]> MC : Call /availableMessages to check for not-picked up messages activate MC #FFBBBB MC -> PR : 200 OK - Array of messages not yet delivered (**emtpy**) MC -> PR : 400 Bad Request deactivate MC DR -[#green]> MC : Call /messageResponse API to send the generic response to 'Message A' activate MC #FFBBBB MC -> DR : 200 OK MC -> DR : 400 Bad Request deactivate MC PR -[#green]> MC : Call /availableMessages to check for not-picked up messages activate MC #FFBBBB MC -> PR : 200 OK - Array of messages not yet delivered (**generic response to 'Message A'**) MC -> PR : 400 Bad Request deactivate MC PR -[#green]> MC : Call /messageResponseRetrieve API to pick up the generic response to 'Message A' activate MC #FFBBBB MC -> PR : 200 OK MC -> PR : 400 Bad Request deactivate MC end |
...