Vervallen op 14 mei 2022
Interfaces
Inleiding
Op deze pagina's 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 zien welke use case-implementaties welk interface gebruiken.
Regie | Uitwisseling | Coördinatie | ||||||||
interface | ||||||||||
geboden door rol | Authorization | Subscription | Notification | Resource | MedMij | |||||
X | X | X |
|
|
| X |
|
|
| |
X | X | X |
|
|
| X |
|
|
| |
X | X | X | X |
|
|
|
|
|
| |
|
|
|
| X | X |
|
|
|
| |
|
|
|
|
|
|
| X |
|
| |
|
|
|
|
|
|
|
| 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.
Adressen en interfaces
Op de zes interfaces in de flows van UCI Verzamelen, UCI Delen, UCI Abonneren en UCI Notificeren, adresseren Applicatie-rollen elkaar, op basis van een URI. Onderstaande tabel geeft een overzicht.
interface | geadresseerde | bericht | kanaal | |
|---|---|---|---|---|
Regie | Authorization Endpoint | authorization request | frontchannel | |
OAuth Client ( | authorization response | |||
Token Endpoint | access token request | backchannel
| ||
Subscription Endpoint | subscription request | |||
Subscription Notification Endpoint | subscription notification | |||
Uitwisseling | Resource Endpoint | resource request | ||
Resource Notification Endpoint | resource 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.
Adressering
1a. | De OAuth Client stelt conform RFC 3986 de URI samen waarmee hij zichzelf, de Authorization Server, de Subscription Server of de Resource Server adresseert. De Notification Client stelt conform RFC 3986 de URI samen waarmee hij de Notification Server adresseert. |
1b. | De URI's bedoeld in verantwoordelijk 1a hebben een hostname die een fully-qualified domain name is, conform RFC3696, sectie 2, en heeft het patroon scheme://host path, waarbij:
De eis dat |
2a. | In alle adressering op het authorization interface, het token interface, het subscription interface, het subscription notification interface, het resource notification interface en het resource interface is het gebruik van het voor Dat geldt dus ook voor de In release 1.1.1 van het MedMij Afsprakenstelsel was deze verantwoordelijkheid alleen van toepassing op frontchannel-verkeer en had de Dienstverlener Zorgaanbieder voor back-channelverkeer de vrijheid om een ander poortnummer te kiezen dan dat conform de IANA-lijst bij |
2b. | Voor het samenstellen van alle adressen van het authorization request, het token request en het subscription request, betrekt de OAuth Client de eerste onderdelen van de URI, namelijk |
2c. | De adressen voor de subscription notification en de resource notification betrekt de Notification Client uit de OAuth Client List, op basis van de van toepassing zijnde OAuth Client en Gegevensdienst. |
3. | MedMij Registratie wordt in UCI Opvragen ZAL, UCI Opvragen OCL en UCI Opvragen GNL geadresseerd met de hostname stelselnode.medmij.nl. |