OSO:2017/Architectuur/Proces

Uit Kennisnet Developers Documentatie
< OSO:2017‎ | Architectuur
Versie door Vankrimpen01 (overleg | bijdragen) op 20 feb 2017 om 12:23 (KoppelSleutel)
Ga naar: navigatie, zoeken

Dossier uitwisseling

Vanaf OSO'17 worden er twee soorten uitwisselingen ondersteund:

  • Overstap tussen Scholen
  • Aanvragen bij Samenwerkingsverbanden Passend Onderwijs

In beide typen wordt een dossier uitgewisseld via het basisberichtenverkeer zoals hieronder beschreven. Daarnaast kennen beide varianten hun eigen uitbreidingen hierop:

  • Notificatie nav Aanvraag (Schooluitwisseling)
  • Notificatie met KoppelSleutel (Passend Onderwijs)
  • Terugkoppeling naar School (Passend Onderwijs)

Dossier uitwisseling

OSO aanroepen.png

In de figuur worden de stappen en berichten weergegeven die bij een succesvolle dossier overdracht worden doorlopen. Deze worden hieronder beschreven:

  1. Het doelsysteem verzendt een aanvraag (OverdrachtRequest) naar het Traffic Center (TC) voor het opvragen van een dossier.
    De aanvraag bevat het versleutelde BSN van de leerling . Het TC controleert of het doelsysteem bekend en gekwalificeerd is (zowel de school als de leverancier moeten gekwalificeerd zijn). Als dit het geval is, wordt een sessie id toegekend en teruggestuurd naar het aanvragende systeem (OverdrachtResponse). Sessie intiëren
    Binnen één Sessie word per bevraagd Aanleverpunt de berichten .2, .3 en .4 verzonden/ontvangen; deze kunnen meerdere malen binnen één Sessie voorkomen. (Berichten .1 en .5 worden éénmaal per Sessie uitgewisseld.)
  2. Het doelsysteem verzendt een aanvraag voor een dossier naar het systeem van de huidige school (DocumentRequest), het bronsysteem.
    De aanvraag bevat de BSN van de leerling (één dossier per aanvraag) en het sessie id. Het bronsysteem vraagt vervolgens eerst een controle op de sessie gegevens op bij het TC. Dossier opvragen
  3. Het bronsysteem verzendt een sessie controle verzoek (SessiecontroleRequest) naar het TC.
    Dit verzoek bevat het versleutelde BSN en de sessie id uit bericht 2. Het TC controleert deze gegevens; wanneer deze overeenkomen met een uitgegeven nog niet verlopen sessie wordt een ok teruggegeven (SessiecontroleResponse). Controleren sessie
  4. Het bronsysteem verstrekt het dossier aan het doelsysteem (DocumentResponse).
    Als het gevraagde dossier beschikbaar is wordt een valide dossier geleverd; indien het dossier niet beschikbaar is (onbekend of nog niet gereed voor verzending) wordt de bijbehorende foutmelding verstuurd. De levering van het dossier en de foutmeldingen vormen de response op bericht 2 en wordt beschreven in Dossier opvragen.
  5. Het doelsystem meldt de aanvraag af bij het TC. Bij het afmelden (AfmeldingRequest) geeft het doelsysteem aan of het dossier is ontvangen, of dit valide was of dat het niet beschikbaar was bij het bronsysteem. Het TC antwoordt (AfmeldingResponse) en administreert het resultaat en ruimt de sessie gegevens op. Sessie afmelden

Notificatie

Notificatie berichten.png

In de figuur worden de stappen en berichten weergegeven die bij een succesvolle Notificatie worden doorlopen. Deze worden hieronder beschreven:

  • A: Het Bronsysteem meldt een Notificatie bij het Traffic Center. Het Traffic Center controleert of het Aanleverpunt dat de Notificatie moet ontvangen valide is en een url heeft geregistreerd. Als dit het geval is, wordt de url teruggegeven aan het Bronsysteem.
  • B: Het Bronsysteem verstuurt de Notificatie (na ontvangst van de url) naar het Aanleverpunt dat het Dossier eerder heeft aangevraagd.

Push en Pull

In OSO is sprake van een 'pull mechanisme' waarbij de Doelschool het initiatief neemt voor het opvragen van een Dossier bij de Bronschool. De Doelschool heeft daarbij het PGN van het desbetreffende Dossier nodig. Dit verkrijgt de Doelschool buiten OSO om bij de aanmelding/inschrijving van een leerling bij de Doelschool.

In OSO'17 worden Samenwerkingsverbanden Passend Onderwijs aangesloten op OSO. In dit uitwisselproces is sprake van een 'push', waarbij de Bronschool het initiatief heeft. In het LAS van een School wordt een Dossier aangemerkt voor verzending naar een Samenwerkingsverband. Hierna wordt via een Notificatie een Koppelsleutel naar het Samenwerkingsverband systeem (SWV of RP) verstuurd (de PGN mag voor deze overdracht niet gebruikt). Met behulp van de KoppelSleutel wordt het Dossier vervolgens opgevraagd bij de Bronschool.

Sleutel tussen Systemen

In OSO wordt gebruik gemaakt van twee typen sleutels om Dossiers tussen verschillende systemen aan te duiden. De eerste is de 'Zoeksleutel', een sleutel gebaseerd op een gecodeerde versie van het PGN van het Dossier. De tweede is de 'KoppelSleutel', een aanduiding die wordt verstrekt door het TC aan het bronsysteem en via een notificatie naar het doelsysteem verstuurd.

Zoeksleutel

In OSO wordt het Persoonsgebonden Nummer (PGN) toegepast als 'key' voor het Dossier. De PGN is of het BSN of het Onderwijsnummer van de leerling. Bij aanroepen van het TC wordt het PGN versleuteld doorgegeven in het Zoeksleutel veld.
De Zoeksleutel kan door Systemen niet ontsleuteld worden (de Key is niet bekend bij deelnemende systemen).

De Zoeksleutel wordt door het Doelsysteem aangemaakt bij het aanvragen van de Sessie. Vervolgens wordt de Zoeksleutel via het DocumentRequest van Doel- naar Bron- systeem verstuurd. Het Bronsysteem stuurt de Zoeksleutel mee met de SessieControle.

KoppelSleutel

De Koppelsleutel wordt in plaats van de Zoeksleutel gebruikt bij de uitwisselingen in het kader van de aanvragen bij Samenwerkingsverbanden Passend Onderwijs. De KoppelSleutel wordt aan het Bronsysteem verstrekt door het TC bij het melden van een Notificatie. Via de Notificatie wordt deze dan doorgeven aan het Bronsysteem.
Een Koppelsleutel is uniek en alleen geldig voor de specifieke uitwisseling en terugkoppeling(en) van:

  • Bron Aanleverpunt
  • Dossier
  • Doel Aanleverpunt