Document toolboxDocument toolbox

Documentatie voor klanten en partners van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers


Overzicht basisbegrippen DOSIS

Meer info en configuratie na aanmelden (met de juiste rol) via:

Agent

Geeft aan wie een dossier kan consulteren en/of aanpassen. Een agent is opgebouwd uit:

  • Identificatie (wie)

    • Rijksregisternummer voor burgers

    • KBO-nummer voor ondernemingen en vzw’s

    • V-code voor feitelijke verenigingen en afdelingen

  • 1 of meer toegangsrechten (wat mag)

1 DOSIS-call kan combinaties van agenten bevatten.

Zie ook: https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6073615500/Dossierstatusinformatie+via+een+vereenvoudigde+interface#Agent

Bron

Een bron voor de DOSIS API is elke (Vlaamse) overheidsdienst die dienstverlening biedt aan:

  • een burger die in Vlaanderen woont

  • een onderneming of vereniging gevestigd in Vlaanderen

Om dossierstatussen aan te leveren, moet de bron van de dossierstatussen geregistreerd zijn. De bron-URI wordt toegewezen bij aansluiting op Dossierstatusinformatie (DOSIS), samen met bron-ID. De combinatie bron-URI en dossiernummer of de combinatie bron-ID en dossiernummer vormen de unieke dossieridentificatie binnen DOSIS. De bron-URI of de bron-ID + het dossiernummer zijn verplichte velden. Digitaal Vlaanderen geeft altijd de bron-URI, de bron-ID en het dossiernummer bij elke opvraging van een dossier.

Wanneer de afnemer werkt met meerdere back-endsystemen – bijv. voor burgers, ondernemers en/of verenigingen – en er een overlap in dossiernummers kan zijn, is het aangewezen meerdere bron URI’s aan te vragen.
Voorbeeld: urn://zaventem.be/burgers en urn://zaventem.be/ondernemers

DOSIS

DOSIS toont een subset van de gebeurtenissen die op een dossier van toepassing zijn en centraliseert de informatie over die gebeurtenissen. Welke gebeurtenissen in DOSIS worden getoond, kiest de bron. De dossiers zelf zitten bij de beheerders van die dossiers.

Dossierstatus

De status van een DOSIS-dossier kan meerdere agenten bevatten. Dat kan een mix zijn van agenten met als identificatie rijksregisternummer, KBO-nummer en/of V-code. De toegang tot een dossier gebeurt daarnaast ook op basis van de toegangsrechten (IDM).

  • Wie is aangemeld via Mijn Burgerprofiel heeft toegang tot een dossier als:

    • agent identificatie = rijksregisternummer

    • agent toegangsrecht = Raadpleger

  • Wie is aangemeld via ondernemingsloket/verenigingsloket heeft toegang tot een dossier als:

    • agent identificatie = ondernemingsnummer of vestigingsnummer binnen die onderneming

    • agent toegangsrecht = Wettelijk vertegenwoordiger

  • Wie is aangemeld via ondernemingsloket/verenigingsloket heeft toegang tot een dossier als de ACM/IDM-rol identiek is aan de agent identificatie + toegangsrecht

Het is mogelijk om meerdere ACM/IDM-toegangsrechten te hebben en tegelijk ook wettelijk vertegenwoordiger (onderneming)/hoofdvertegenwoordiger (vereniging) te zijn.

Doorverwijs-URL

Eigenschap van een dossierstatus en link om direct naar de detailinfo van een dossier te gaan in het eigen systeem. Dit is een optioneel veld dat bij voorkeur ook achter ACM/IDM zit zodat toegang kan binnen een SSO-ervaring.

Dossieridentificatie

De dossieridentificatie moet altijd uniek zijn. Het bestaat uit een combinatie van de toepassingsnaam en het dossiernummer.

Werkt u met 2 toepassingen waarin dossiers beheerd worden, met dossiernummers die alleen uniek zijn binnen de toepassing, maar niet over de beide toepassingen heen, dan moet u twee bronnen registreren in DOSIS.

DOSIS kent voor elke bron een namespace toe:

  • urn://www.agentschap/toepassing1

  • urn://www.agentschap/toepassing2

 

Zo kunnen twee verschillende dossiers met hetzelfde dossiernummer toch een unieke identificatie krijgen. De identificatie van de dossiers wordt dan:

  • urn://www.agentschap/toepassing1/BE123

  • urn://www.agentschap/toepassing2/BE123

DossierStatus - eigenschappen

Eigenschap

Omschrijving

DossierNummer

nummer dat de bron meegeeft voor een bepaald dossier, uniek ID van het dossier

Naam

bijv. “Bossubsidie Molenstraat”, ”Vergunning tuinhuis”,  enz.

Wijzigingsdatum

datum laatste update

Product-ID

nummer IPDC-product

Dossierbeheerder

dienst/persoon met contactgegevens zodat de burger/ondernemer weet met wie contact op te nemen met vragen bij het dossier

Doorverwijs-URL

link naar bijv. een digitaal loket voor meer gedetailleerde informatie
Dit is bij voorkeur een link met SSO (single sign-on) waar er meteen toegang kan gegeven worden tot het betreffende dossier.

Status, incl. historiek

Vlaamse Fase

Vlaamse Code

Detail: omschrijving van de status, extra uitleg

Wijzigingsdatum

Actie: omschrijving van de actie gevraagd aan de burger/ondernemer

Agent

ID: RRN voor burger, KBO-nummer voor ondernemingen of V-code (verenigingsnummer voor verenigingen)

Toegangsrecht (“IDM-rol” voor ondernemers, “Raadpleger” voor burgers):  geeft toegang tot de juiste informatie. Dit recht kan gelden voor meerdere gebruikers, bijv. de indiener en de mede-ondertekenaar.

Endpoints

Gebruik deze endpoints voor de DOSIS API-calls:

  • TNI:  https://dosis.api.tni-vlaanderen.be

  • Productie: https://dosis.api.vlaanderen.be

Meer informatie

IPDC

De interbestuurlijke Producten- en dienstencatalogus (iPDC)  biedt een beknopte omschrijving van alle ‘producten’ van de overheid. Een overheidsproduct wordt gedefinieerd als elke

  • overheidsdienstverlening

  • aan een externe doelgroep

  • aan meerdere klanten

  • waarbij er interactie is tussen de klant en de dienstverlenende overheid

DOSIS opzetten kan voor producten en diensten die voorkomen in de IPDC.

Zie ook:

OAuth client

De OAuth client is de applicatie van de afnemer die data opvraagt bij de Resource server (DOSIS REST-API) via het OAuth 2.0 protocol, beveiligd door ACM/IDM en de Client Credentials Grant flow.

Output

Geeft meer informatie over het resultaat van de dienstverlening waarbinnen het dossier kadert. Bijv. in een dossier om een erkenning/vergunning te krijgen, is de output de link naar de effectieve erkenning/vergunning.

  • Het dossierdetail bevat een sectie om de output van het dossier te tonen

  • De titel van de sectie wordt bepaald door het type output, bijv. erkenning, vergunning, …

  • De url kan een interne link in Mijn Burgerprofiel of een link naar een extern loket

 

Meer informatie over output in de payload:

Meer informatie over output in de vereenvoudigde interface:

OVO-code

OVO staat voor “Organisatie Vlaamse Overheid”. Elke organisatie-éénheid of suborganisatie binnen de Vlaamse overheid beschikt over zo'n OVO-code die verwijst naar het organisatieregister.

REST API

DOSIS is raadpleegbaar via een restful API die door verschillende loketten of (mobile) devices kan worden aangesproken. Welke informatie wordt ontsloten en voor wie, wordt geregeld via ACM/IDM.

De DOSIS API is een REST API, beveiligd via het OAuth 2.0 protocol. Voor de authenticatie en autorisatie van gebruikers die gegevens aanleveren, maakt DOSIS gebruik van het Vlaams Toegangsbeheer (ACM/IDM)

Upload-ID

Uniek ID dat u zelf genereert of terugkrijgt van DOSIS (als u zelf geen uniek ID kan genereren), en dat dient om achteraf het resultaat van de upload van dossierstatusinformatie te controleren.

 

 

Dit is een officiële website van de Vlaamse overheid - Uitgegeven door Digitaal Vlaanderen: https://www.vlaanderen.be/digitaal-vlaanderen

DISCLAIMER: http://www.vlaanderen.be/nl/disclaimer
TOEGANKELIJKHEID: http://www.vlaanderen.be/nl/toegankelijkheid