Interfaces

Op pagina Interfaces aanpassen en uitbreiden:

Interfaces en use cases

Op deze pagina staan de verantwoordelijkheden die horen bij de interfaces in het MedMij Afsprakenstelsel. In elke use case-implementatie wordt gebruik gemaakt van één of meer van deze interfaces. Onderstaande tabel laat voor de interfaces van de Dienstverleners zorgaanbieder en van de Dienstverleners persoon zien door welke use case-implementaties ze worden gebruikt.

interface	subscription notification interface	resource notification interface	user interface	authorization interface	token interface	resource interface	subscription interface
rol	Notification Server		*Authorization Server*			*Resource Server*	Subscription Server
UCI Verzamelen			X	X	X	X
UCI Delen			X	X	X	X
UCI Abonneren			X	X	X		X
UCI Notificeren	X	X

Verantwoordelijkheden over de adressering van deze interfaces komen hieronder aan de orde. Verantwoordelijkheden voor de specifieke interfaces zijn opgenomen in specifieke subpagina's, die klikbaar zijn in bovenstaande tabel.

Adressering

Adressen en interfaces

In de flow van UCI Verzamelen, UCI Delen, UCI Abonneren en die van UCI Notificeren, adresseren (OAuth-)rollen elkaar, op basis van een URI. Onderstaande tabel geeft een overzicht.

interface	geadresseerde	bericht	kanaal
authorization interface	Authorization Endpoint van de OAuth Authorization Server	authorization request	frontchannel
authorization interface	OAuth Client (`redirect_uri`)	authorization response	frontchannel
token interface	Token Endpoint van de OAuth Authorization Server	access token request	backchannel
resource interface	Resource Endpoint van de OAuth Resource Server	resource request
subscription interface	Subscription Endpoint van de OAuth Resource Server	subscription request
subscription notification interface	Subscription Notification Endpoint van de Notification Server	notification
resource notification interface	Resource Notification Endpoint van de Notification Server	notification

In de nu volgende verantwoordelijkheden wordt bepaald hoe de URI's zijn opgebouwd waarmee de adresbepaler de adresgebruiker de geadresseerde laat adresseren, en hoe de parameters worden gevuld. De opbouw van het adres is steeds dezelfde, ook voor frontchannel en backchannel. Desondanks maken we in het logische informatiemodel, in de Zorgaanbiederslijst, wel onderscheid tussen Frontchanneluri en Backchanneluri. Dat houdt dat model wendbaarder, mocht er ooit wel adresseringsverschillen tussen frontchannel en backchannel ontstaan.

2a. In alle adressering op het authorization interface, het token interface, het resource interface, het subscription interface , het subscription notification interface en het resource notification interface is het gebruik van het voor https bedoelde poortnummer, zoals opgenomen in de Service Name and Transport Protocol Port Number Registry van IANA, verplicht.

2b. Voor het samenstellen van alle adressen van het authorization request, het token request, het resource request en het subscription request, betrekt de OAuth Client de eerste onderdelen van de URI, namelijk host en path, uit de Zorgaanbiederslijst, op basis van de van toepassing zijnde Zorgaanbieder en hetzij Gegevensdienst (wanneer geadresseerde OAuth Authorization Server is) of Systeemrol (wanneer geadresseerde OAuth Resource Server is). Andere elementen van de algemene URI-syntax, zoals user, password, query en fragment, zijn afwezig in de adressen.

2c. Voor het samenstellen van het adres van een notification, betrekt de Notification Client de eerste onderdelen van de URI, namelijk host en path, uit de OAuth Client List, op basis van de van toepassing zijnde hostname en Gegevensdienst.