Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 2.0.0_202305

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents
maxLevel2


Het resource notification interface hoort de hoofdfunctie Uitwisseling, terwijl het subscription notification interface bij de hoofdfunctie Regie hoort.

1.De Notification Client en de Notification Server maken op het resource notification interface gebruik van HTTP 1.1.

Anchor
ext.abo.rscnotint.200
ext.abo.rscnotint.200
ext.abo.rscnotint.200

2.De Notification Client verstuurt de resource notification middels een HTTP POST van een Notification op het in de OAuth Client List aangetroffen Subscription Notification Endpoint.

Anchor
ext.abo.rscnotint.201
ext.abo.rscnotint.201
ext.abo.rscnotint.201

3.De resource notification hanteert  de structuur: <base uri>/Notification (zonder andere parameters in de URL).

Anchor
ext.abo.rscnotint.202
ext.abo.rscnotint.202
ext.abo.rscnotint.202

4.Voor Notificaties en foutmeldingen op het resource notification interface gebruiken Notification Client en de Notification Server het formaat JSON.

Anchor
ext.abo.rscnotint.203
ext.abo.rscnotint.203
ext.abo.rscnotint.203

5.

De twee parameters in de resource notification worden als volgt gevuld.

parameter

vulling

toelichting

subscription_id

De waarde waarmee de Subscription Server dit Abonnement in de subscription response heeft geïdentificeerd.Een gebeurtenis bij een Aanbieder kan theoretisch leiden tot meerdere Notificaties. Iedere Notificatie hoort echter bij precies één Abonnement.
notification_typeDe letterlijke waarde resource.Zo kan de Notification Server de resource notification van de subscription notification onderscheiden.


Expand
titleToelichting

Hier is niet, zoals in de subscription notification, een end_date opgenomen, omdat dat bij de hoofdfunctie Regie hoort. Communicatie over de Abonnementen-administratie vindt geheel plaats op het subscription notification interface. Het resource notification interface is alleen voor inhoudelijke notificaties. Mogelijk zal in toekomstige releases van het MedMij Afsprakenstelsel in de resource notification ook een nadere indicatie worden opgenomen van het onderdeel van de Gegevensdienst waarop er nieuwe informatie beschikbaar is.


Anchor
ext.abo.rscnotint.204
ext.abo.rscnotint.204
ext.abo.rscnotint.204

6.

De enige parameter van de resource notification response wordt als volgt gevuld.

parameter

vulling

toelichting

notification_id

identificatie waarmee de Notification Serverde Notificatie uniek voor dit Abonnement identificeert

Het id kan bijvoorbeeld een integer waarde zijn, of een UUID, maar kan ook volgens een ander geldig ID-patroon worden gevuld.


Anchor
ext.abo.rscnotint.205
ext.abo.rscnotint.205
ext.abo.rscnotint.205

7.

Een Notification Client plaats binnen één (1) uur na het beschikbaar komen van nieuwe (gezondheids)informatie voor die Persoon betreffende die Gegevensdienst, een resource notification  dienaangaande bij de betreffende Notification Server.

Expand
titleToelichting

Als het tijdstip van beschikbaar komen van nieuwe (gezondheids)informatie wordt het moment gezien waarop betreffende informatie namens verwerkingsverantwoordelijke Aanbieder (handmatig of automatisch) als "beschikbaar voor Persoon" wordt aangemerkt.


Anchor
ext.abo.rscnotint.206
ext.abo.rscnotint.206
ext.abo.rscnotint.206

8.Na ontvangst van een resource notification, zal de Notification Server, indien in antwoord daarop een resource notification response dient te worden gedaan, na maximaal tien (10) seconden dit antwoord ter beschikking stellen aan de Notification Client. Dit gedrag van de Notification Serveris gedurende minimaal 98,5% van de tijd beschikbaar.

Anchor
ext.abo.rscnotint.207
ext.abo.rscnotint.207
ext.abo.rscnotint.207

9.

Notification Server en Notification Client handelen uitzonderingssituaties inzake het resource notification interface af volgens onderstaande tabel.

Nummer

Implementeert uitzondering

Uitzondering

Actie

Melding

Vervolg

Resource notification interface 1Notificeren 1

Notification Server vindt de ontvangen resource notification ongeldig.

Notification Server informeert Notification Client over deze uitzondering.

Conform HTTP specificatie met met status code 400 "Foute aanvraag", en met in de body de van toepassing zijnde error code ("invalid_subscription_id" of "invalid_notification_type")

Allen stoppen de flow onmiddellijk na geïnformeerd te zijn over de uitzondering.

Wanneer Notification Client een error "invalid_subscription_id" ontvangt, dan dient het Abonnement direct te worden beëindigd, en wel zonder hiervoor opnieuw een notification te sturen.

Resource notification interface 2Notificeren 2

Notification Server kan in de request niet, niet geheel of niet tijdig verwerken.

Notification Server informeert Notification Client over deze uitzondering.Conform HTTP specificatie met met status code 500 "Interne serverfout"Allen stoppen de flow onmiddellijk na geïnformeerd te zijn over de uitzondering.


Anchor
ext.abo.rscnotint.208
ext.abo.rscnotint.208
ext.abo.rscnotint.208

...