Afsprakenstelsel Edu-V
Titel | Afsprakenstelsel Edu-V |
Status | Final - Recommended |
Versie | 1.0 |
Beheer | Stichting Edu-V |
Ingangsdatum | December 2024 |
Introductie
Het Edu-V afsprakenstelsel beschrijft de afspraken die door publieke en private partijen zijn gemaakt over de uitwisseling van digitale gegevens tussen leer- en onderwijsmiddelen voor het primair onderwijs, gespecialiseerd onderwijs, voortgezet onderwijs en middelbaar beroepsonderwijs in Nederland.
Inhoudsopgave
Het afsprakenstelsel bestaat uit de volgende onderdelen:
Introductie met achtergrondinformatie en de aanleiding voor de totstandkoming van het Edu-V afsprakenstelsel.
Scope met hierin de werkings- en toepassingsgebieden van het Edu-V afsprakenstelsel.
Beheerprocessen om de continuïteit, compliance van het afsprakenstelsel Edu-V te kunnen borgen en naleven.
Privacy richtlijnen om persoonsgegevens van onderwijsdeelnemers en onderwijsmedewerkers doelmatig, veilig en betrouwbaar te verwerken en uit te wisselen.
Architectuurkader met de architectuurprincipes en de generieke afspraken voor alle gegevensdiensten om technische, semantische en procesinteroperabiliteit te borgen binnen de scope van het Edu-V afsprakenstelsel én de overige werkings- en toepassingsgebieden in het Nederlandse onderwijs.
Regie op gegevens met afspraken om onderwijsorganisaties als gegevenshouder de regie te geven over het uitwisselen van gegevens tussen applicaties die gebruik maken van de Edu-V gegevensdiensten.
Edu-V praktijksituaties met de functionele specificatie voor:
Edu-V gegevensdiensten met een totaaloverzicht van alle gegevens die via het Edu-V afsprakenstelsel uitgewisseld kunnen worden. Voor de gegevensdiensten zijn de technische vereisten beschreven. Voor iedere referentiecomponent is aangegeven wat de verplichte en optionele gegevensdiensten zijn.
APIs met de technische specificatie voor alle gegevensdiensten.
Status labels
Iedere pagina in het Afsprakenstelsel heeft een status over de fase waarin de afspraak zich bevindt:
Alpha - Public Draft: De afspraak is in ontwikkeling bij de werkgroep, wordt gereviewd door de klankbordgroep en/of de architectenraad. Het versienummer is in de range van 0.0.X. Deze versie is niet geschikt voor productiegebruik.
Beta - Implementation Draft: De afspraak is gereed voor implementatie. Het versienummer is in de range van 0.9.X. De kernfunctionaliteit is stabiel, maar brekende wijzigingen zijn nog mogelijk.
Release Candidate: Deze versie volgt de huidige afspraak met status Final - Recommended op. Het moment van invoeren wordt bepaald op basis van het advies van de werkgroep, het CAB en de adviesraad van Edu-V. Het bestuur van Edu-V neemt dit advies over.
Final - Recommended: Deze afspraak is definitief en stabiel. Goedgekeurd voor productiegebruik. Het beheer wordt uitgevoerd o.b.v. het change en releasebeleid.
Final - Depricated: Deze afspraak is verouderd. Nieuwe implementaties moeten de Final - Recommended versie toepassen. Alleen security patches worden doorgevoerd in deze beheer fase.
Retired - Archived: Deze afspraak is uitgefaseerd en wordt niet meer onderhouden. Alleen beschikbaar voor naslag.
Werkgroepen
Leveranciers en scholen uit het primair onderwijs, voortgezet onderwijs, gespecialiseerd onderwijs en middelbaar beroepsonderwijs ontwikkelen het Edu-V afsprakenstelsel. De totstandkoming vindt plaats in werkgroepen gericht op specifieke onderdelen van het Afsprakenstelsel. Bij iedere pagina van het Afsprakenstelsel is aangegeven welke werkgroep de afspraken op de pagina onder beheer heeft.
De volgende werkgroepen zijn op dit moment actief:
Architectenraad Edu-V
Werkgroep Beheersing
Werkgroep Doorgifte identiteiten
Werkgroep Doorgifte administratie
Werkgroep Verwerven en in gebruik nemen
Werkgroep Toetsen en Examineren
Werkgroep Combineren en arrangeren leermaterialen
Werkgroep Evalueren leervoortgang en -resultaten
De algemene pagina’s in het afsprakenstelsel worden beheerd door stichting Edu-V.
Contactpersoon
Indien u vragen, opmerkingen of suggesties heeft over de inhoud van het Afsprakenstelsel dan kunt u contact opnemen met Stichting Edu-V via info@edu-v.org.
Release notes
Deze uitwerking is gebaseerd op basis van de volgende stappen:
0.0.1: De introductie en aanleiding is gebaseerd op het startdocument Edu-V.
0.0.2: De scope is gebaseerd op basis van werkconferenties van het Keten Beleidsoverleg Edu-K in de periode februari – maart 2023.
0.0.3: De architectuur is gebaseerd op bijeenkomsten van de Architectenraad Edu-V in de periode december tot en met april 2023.
0.0.4: Edu-V praktijksituaties toegevoegd en use cases voor praktijksituaties Verwerven en in gebruik nemen ter review gedeeld met de werkgroep Verwerven en in gebruik nemen.
0.0.5: De architectuur is op basis van de werkconferentie van de Architectenraad Edu-V verder uitgewerkt in:
0.0.6: Aanvullingen in Architectuur en werkgroepen:
De architectuur is op basis de feedback uit de bijeenkomsten van de Architectenraad Edu-V van 12 en 24 mei uitgewerkt voor:
Scenariobeschrijvingen Uitwisselen summatieve toetsresultaten
0.0.7: De draft versies voor de POC specificaties zijn toegevoegd. Het betreft de volgende pagina’s:
Uitwisselen summatieve toetsresultaten:
Verwerven en in gebruik nemen:
0.0.8: Er is een pagina toegevoegd waarin leveranciers die interesse hebben in de proof of concepts een overzicht hebben van de te ontwikkelen onderdelen uit het afsprakenstelsel: Proof of concept handreiking leveranciers.
0.0.9: Op basis van feedback uit de werkgroepen is de 80% specificatie voor de proof of concepts opgeleverd. Tegelijkertijd is gestart met het uitwerken van de 100% technische specificatie. Dit heeft tot de volgende wijzigingen geleid:
Architectuurkader
Mandatenregister is hernoemd naar Verwerkersregister
Bij de gegevensdefinities zijn de Engelse technical terms toegevoegd aan de Nederlandse benamingen
De pagina over de berichtenstructuur is aangepast naar het transactiepatroon Abonneren op wijzigingen middels notificaties
BasispoortId is toegevoegd als identifier voor onderwijsorganisaties voor de Proof of Concept in het primair onderwijs
Verwerven en in gebruik nemen leermiddelen
Nieuwe pagina Conceptueel model toegevoegd waarin het samenspel tussen alle referentiecomponenten inzichtelijk is.
Varianten van ketensamenwerkingen is aangepast. Bestellen van leermiddelen is in consistentie aangepast naar nieuwe varianten van ketensamenwerkingen
APIs
Events API is aangepast naar een abonneeservice en een notificatieservice voor het transactiepatroon Abonneren op wijzigingen middels notificaties.
Mandate API is nieuw gespecificeerd.
Consent API is aangepast naar het nieuwe model waarbij consent wordt gegeven op een gegevenssoort (dit was een API).
Catalogue API heeft een GET all products endpoint gekregen.
SIS API heeft GET all endpoints gekregen, teacher is hernoemd naar employee met een rol en class is een separaat object geworden.
Entitlement API, Usage API, Results API zijn voorzien van PUT endpoints om berichten direct te kunnen pushen naar de ontvangers.
SIS API, Entitlement API, Usage API, Results API bevatten persoonsgegevens. De edu_org_id is toegevoegd als query parameter aan de endpoints om zo te voldoen aan de M2M identificatie en authententicatie flow.
In de Results API is de nieuwe berichtdefinitie voor Result opgenomen.
0.0.10: Labels aangepast en verwijzing naar POC’s verwijderd.
0.0.11: In deze versie zijn wijzigingen gedaan in het architectuurkader, is de herziening consent verwerkt, zijn de gegevensdiensten uitgewerkt en is functionele en technische documentatie voor de praktijksituaties toegevoegd. Dit heeft geleid tot de volgende wijzigingen:
In het Architectuurkader Edu-V:
Zijn de Architectuurprincipes in TOGAF formaat uitgewerkt.
Zijn de Business en ondersteunende rollen verwijderd en is de lijst met referentiecomponenten geactualiseerd en afgestemd op het ROSA begrippenkader.
Zijn de transactierollen specifiek uitgewerkt op de pagina Transactiepatronen.
Zijn de gegevensdefinities en is het gegevensmodel herzien op basis van de definities uit het ROSA begrippenkader.
Is de herziening Consent verwerkt in de pagina over M2M gegevensuitwisselingen.
Is het nieuwe patroon voor federatieve toegang toegevoegd aan H2M identificatie en authenticatie.
Zijn de primaire en secundaire identifiers voor onderwijsdeelnemers en onderwijsorganisaties uitgewerkt op de pagina Identiteiten.
Is de pagina gegevenssoorten geactualiseerd met de nieuwe gegevensdefinities en de toegevoegde APIs.
Er is een nieuwe sectie Regie op gegevens uitgewerkt waarin de herziening Consent is verwerkt:
Consent is volledig herzien op basis van feedback ontvangen vanuit leveranciers die zich ingeschreven hebben voor de POC’s. Er is een laagdrempelige variant van Consent ontwikkeld voor leveranciers die geen noodzaak hebben tot een eigen API. Ook is het verwerkersregister geen verplicht onderdeel meer van de Consent flow en leidt het niet aanwezig zijn van een verwerkersovereenkomst niet tot een operationele blokkade maar tot een notificatie aan de applicatiebeheerder.
De Consent API en de DPA (Data Processing Agreement) API zijn opnieuw gespecificeerd.
Er is een nieuwe sectie Edu-V gegevensdiensten uitgewerkt waarin de Edu-V gegevensdiensten zijn beschreven. Deze gegevensdiensten kunnen door referentiecomponenten worden uitgewisseld. In de sectie is voor iedere gegevensdienst de technische vereisten beschreven. Voor iedere referentiecomponent zijn de verplichte en optionele gegevensdiensten gespecificeerd.
De praktijksituatie Verwerven en in gebruik nemen is aangepast waarbij de documentatie is herschreven vanuit referentiecomponenten en gegevensdiensten. Daarnaast zijn de ontbrekende praktijksituaties functioneel gedocumenteerd. Dit heeft geleid tot een aantal nieuwe APIs:
De praktijksituatie Combineren en arrangeren leermiddelen is voorbereid met een draft uitwerking van de Course API.
De praktijksituatie Evalueren leervoortgang en -resultaten is voorbereid met een draft uitwerking van de Progress API.
0.0.12: De sectie Beheerprocessen en Privacy richtlijnen is toegevoegd vanuit de werkgroep Beheersing. Daarnaast is functionele documentatie toegevoegd van de werkgroepen:
0.0.13: De volgende wijzigingen zijn doorgevoerd:
De adviezen uit de ROSA-architectuurscan zijn verwerkt in het Architectuurkader.
Het wijzigingsverzoek op Regie op gegevens is verwerkt.
De feedback vanuit de werkgroep Verwerven en in gebruik nemen is verwerkt in de functionele en technische specificaties.
De praktijksituatie Doorgifte identiteiten is toegevoegd.
De gegevensdiensten uit de Administratiesystemen zijn functioneel en technisch uitgewerkt.
De verplichte en optionele gegevensdiensten zijn scherper geformuleerd voor alle referentiecomponenten.
De feedback vanuit de werkgroep Toetsen en examineren is verwerkt voor Administreren leerresultaten.
De waardelijst Onderwijsniveaus en leerjaren is toegevoegd.
De APIs zijn bijgewerkt met alle wijzigingen.
0.0.14: Het Architectuurkader Edu-V (en de daartoe behorende secties Regie op gegevens en de Edu-V gegevensdiensten) zijn vastgesteld als startpunt voor de implementatie. Tevens is instemming verleend op verdere doorontwikkeling van het Architectuurkader Edu-V op basis van de Architectuurprincipes. Dit akkoord is verleend op het Bestuurlijk Overleg van 27 mei 2024.
0.9.0: Het Bestuurlijk Overleg heeft tijdens de bijeenkomst van 27 juni 2024 het Afsprakenstelsel Edu-V als versie 0.9.0 goedgekeurd voor implementatie.
Op iedere pagina is op basis van het versienummer en het label IMPlementatie inzichtelijk of de betreffende pagina in scope is van de implementatie.
Een aantal onderdelen blijven in ontwikkeling. Deze hebben het label in ontwikkeling.
1.0.0 Het bestuurlijk overleg heeft het afsprakenstelsel 1.0 vastgesteld dec 2024.
1.0.1 Status labels van het afsprakenstelsel zijn bijwerkt en in lijn gebracht met het Change en Release proces.