This document explains the network infrastructure, messaging patterns and use cases for the Data Sharing Data Model.
Network infrastructure
The HDN Platform provides network access, over which connected actors such as Vidua and its customers exchange messages.
For these use cases, the data users do not need a Client Registration at Vidua. Instead, the HDN Platform maintains the API connection with Vidua services.
Messaging patterns
There are two relevant messaging patterns. One is request-response, exchanged as follows:
sequenceDiagram autonumber participant dp as Vidua participant plf as HDN Platform participant sp as Customer sp->>+plf: Request plf->>+dp: Request dp-->>-plf: Response plf-->>-sp: Response
The second relevant messaging pattern is notification, exchanged as follows:
sequenceDiagram autonumber participant dp as Vidua participant plf as HDN Platform participant sp as Customer dp-)+plf: Notification plf-)-sp: Notification
All relevant interactions on the HDN Platform happen in the context of a “dossier”. This needs to be created before the first interaction, and its identifier needs to be provided along with each message.
Use cases
In the following use cases, the technical intermediation by the HDN Platform is not visualized.
Request a connection
Any authorized customer may request a connection for data sharing. The customer needs to have user interaction with HTTP redirection support, for example through a web portal or mobile app.
sequenceDiagram autonumber participant dp as Vidua actor ds as User participant sp as Customer sp->>+dp: Connection URL Request activate dp dp-->>-sp: Connection URL Response sp->>+ds: Connection URL ds-)+dp: HTTP GET Connection URL ds->dp: Identification and Consent dp-)sp: Connection Notification dp-)-ds: Redirection URL ds-->>-sp: HTTP GET Callback URL dp-)-dp: Consent expiry
The customer may provide business intermediation services, requesting a connection for data sharing with multiple service providers. The user consent information represents this intent and its purpose.
Request source data
After connecting, all authorized customers can request source data as follows. They need to provide a key to the connection as part of their request.
sequenceDiagram autonumber participant dp as Vidua participant sp as Customer sp->>+dp: Source Data Request dp-)dp: Authorization dp-->>-sp: Source Data Response