10.2.1 | | TTA SOAP - Indexed Pull
- Ben van der Stigchel
This Twiin Technical Agreement (TTA) describes and specifies technical responsibilities to which parties agree when connecting to exchange transactions to facilitate the Indexed Pull.
The Indexed Pull starts with several transactions required to locate where data is to be retrieved, aswell as the required endpoints where this data can be retrieved.
Sequence diagram
The sequence diagram below visualizes the full flow for the Indexed Pull interaction sequence.
Twiin describes the transaction between the GtK applications, applications behind these GtK applications can communicate with a GtK in any way they want, as long as the GtK uses the transactions as in this diagram
Each section consists of several steps. The steps correspond to the numbers in the sequence diagram.
For all IHE transactions it is required to include a SAML token. This is usually included in the request the XIS (source) sends to a GtK.
As Twiin decribes the transactions between GtK’s, the transaction between a XIS and a GtK can be however the implementators of these applications see fit, as long as the transactions between GtK’s include the SAML token as Twiin decribes it to be.
Section | Step | Description |
Authorisation (Open) | 1 | Before initiating the retrieval of the Timeline data, a XIS behind the Initiating GtK sends a request to this GtK. After this request is recieved the GtK first sends an ‘open’ authorisation request to the Public Service know as ‘MITZ’ 10.3.14.2 | Mitz Transacties - OTV-TR-00020 |
2 | This request is replied to by MITZ, in this request, the GtK’s where data is available, are given back to the Initiating GtK 10.3.14.2 | Mitz Transacties - OTV-TR-00030 | |
Localisation | 3 | After the GtK ‘knows' where available data can be retrieved, the Initiating GtK then requests the endpoints at the Public Service know as ZORG-AB |
4 | ZORG-AB replies to this request with the endpoints | |
Retrieve Timeline data | 5 | Using the endpoints the GtK uses this information to send the query. With this transaction a SAML token is included |
6 | The responding GtK then checks if the patients permission is in check at MITZ 10.3.14.2 | Mitz Transacties - OTV-TR-00040 | |
7 | A response is sent back 10.3.14.2 | Mitz Transacties - OTV-TR-00050 | |
8 | After the ‘closed authentication’ transaction is done, the Responding GtK retrieves the metadata at the XIS(es) connected with the Responding Gtk and sends this back to the Initiating Gateway. 10.4.2 | IHE ITI-38 | Cross Gateway Query 10.4.2.1 | ITI-38 examples | ITI 38 response The Initiating GtK bundles the replies of the one or more Responding GtK’s and sends this back to the XIS application originally requesting the data from the Initiation Request. A Timeline can now be built using this data in the XIS | |
Retrieve Document | 9 | Using the Timeline data, a request for a document can now be done from within the XIS (Consumer, connected to the Initiating GtK). The XIS then sends this request to the Initiating GtK. The Initiating GtK then sends a request including a SAML token to the Responding GtK where the XIS (Source, connected to the Responding GtK) is behind and the requested document is available. |
10 | (see step 6) 10.3.14.2 | Mitz Transacties - OTV-TR-00040 | |
11 | (see step 7) 10.3.14.2 | Mitz Transacties - OTV-TR-00050 | |
12 | After the ‘closed authentication’ transaction is done, the Responding GtK retrieves the document from the XIS where this document is available and sends this back to the Initiating Gateway https://vzvz.atlassian.net/wiki/spaces/TA12/pages/398070514 The Initiating Gateway on its turn returns this document to the XIS from where the document is requested from. | |
Streaming Images | 13 | the WADO-WS transaction can be used by a Requesting GtK to retrieve DICOM images in a different format and resolution. |
14 | The images are sent back in the requested format | |
Retrieving Images | 15 | It is also possible the request is done for images instead of documents. Prior to this transaction a KOS object is retrieved using steps 9-12. Using the information in the retrieved KOS object images can be requested. 10.4.6 | IHE RAD-75 | Cross Gateway Retrieve Imaging Document Set |
| 16 | The images are sent back 10.4.6 | IHE RAD-75 | Cross Gateway Retrieve Imaging Document Set |