Reference Data Management

Overzicht

Gecentraliseerd beheersysteem voor referentiecodes en terbeschikkingstelling van specifieke REST API's bedoeld voor het raadplegen van deze codes

Dienen je toepassingen of services openbare lijsten met referentiecodes van de sociale zekerheid te raadplegen? Dan kunnen zij rechtstreeks een REST-service referenceData  oproepen, specifiek voor hun domein, en de gewenste versie van deze referentiecodes volgens een bepaalde periode verkrijgen.

Wil je een lijst met referentiecodes beheren die specifiek zijn voor je business domein? Dan kan je met de hulp van het supportteam een REST API ontwikkelen die specifiek is voor je business en beschikken over een online interface en gecentraliseerd systeem om te voorkomen dat de gegevens in meerdere versies worden gedupliceerd.

Functionele beschrijving

In veel toepassingen worden zogenaamde 'referentiegegevens' gebruikt die up-to-date moeten worden gehouden. Deze referentiegegevens zijn fundamentele informatie die als basis dienen voor een organisatie/informatiesysteem. Ze zijn over het algemeen stabiel en veranderen niet vaak.

Het Reference Data Management-systeem maakt het mogelijk om deze referentiecodes en bijbehorende gegevens of koppelingen te beheren en ze beschikbaar te stellen voor toepassingen van derden in de vorm van specifieke REST API’s om het hergebruik ervan te vergemakkelijken.

De REST API referenceData bieden volgende functionaliteiten:

• Raadplegen van verschillende types referentiecodes
• Zoeken en raadplegen van de verschillende referentiecodes van een bepaald type
• Raadplegen van de referentiecodes en hun details zoals labels, activiteitenperioden en attributen
• Raadplegen van de verschillende types koppelingen tussen referentiecodes
• Zoeken en raadplegen van de verschillende koppelingen van een bepaald type
• Raadplegen van de koppelingen tussen de referentiecodes
• Exporteren van referentiecodes en koppelingen

Reference Data Management is ook een online interface waarmee gebruikers referentiecodes en hun details zoals labels, perioden van activiteit en attributen, en de koppelingen tussen referentiecodes centraal kunnen raadplegen en beheren.

De gebruikersinterface voor beheer beantwoordt aan de wettelijke vereisten inzake digitale toegankelijkheid, in het bijzonder aan de WCAG 2.1 niveau AA.
Het hergebruik ervan zorgt ervoor dat toegankelijke gebruikersinterfaces kunnen geproduceerd worden, maar stelt de site of toepassing die er gebruik van maakt niet vrij van een algemene controle.

Technische beschrijving

Het Reference Data Management-systeem is een set REST API's voor het beheren van referentiecodes die zijn opgeslagen in een PostgreSQL database. Deze API's kunnen ook worden opgeroepen via een grafische Angular interface.

Doelpubliek

Elke partnerinstelling die referentiecodes en de onderlinge koppelingen wenst te raadplegen of die referentiecodes ter beschikking wenst te stellen voor andere partnerinstellingen.

Integratievoorwaarden

Als de referentiecodes aangeboden worden via niet-beveiligde REST API's zijn ze toegankelijk zonder integratievereisten.

Als de referentiecodes aangeboden worden via beveiligde REST API's heeft de gebruiker een aanvraagcertificaat nodig dat kan aangevraagd worden op supportcertificates@smals.be. De URN van de toepassing moet toegevoegd worden aan de toegangsregels van de service via het 'Uniek dossier'.

Om nieuwe referentiecodelijsten aan het Reference Data Management-systeem toe te voegen moet gecontroleerd worden of de situatie aan de volgende acceptatiecriteria voldoet:

• De gegevens zijn referentiegegevens, fundamentele informatie die als basis dient voor een organisatie/informatiesysteem. Ze zijn over het algemeen stabiel en veranderen niet vaak
• Referentiegegevens worden door meerdere klanten/business gebruikt
• De referentiegegevens zijn niet privé (GDPR)

De aanvraag wordt vervolgens geanalyseerd door het ReferenceDataMgt-team op basis van:

• Context (domein, stakeholders, usecase van codificaties, enz.)
• Planning
• Lijst met de codes en koppelingen

In samenwerking met de klant moet een specifieke referenceData-API gedefinieerd worden conform de Reference Data Management-standaarden.

Documentatie

• Gouvernance
• Nieuwe integratie
• Functionele analyse
• Technische informatie

Contact

Contact: ReuseOperational@smals.be