Notificatiecomponent

Dit document beschrijft een applicatieprofiel, in dit geval Notificatiecomponent. Dit applicatieprofiel beantwoordt de vraag over hoe het corresponderende domeinmodel in de praktijk kan toegepast worden. Daarbij worden de beperkingen (kardinaliteit, codelijsten) toegelicht en de overeenkomstige (RDF) termen opgelijst.

Samenvatting

Dit applicatieprofiel beschrijft een informatiemodel voor een toepassing die als use case heeft het versturen van notificaties vanuit een Publieke Organisatie naar personen en organisaties en daarover informatie wil uitwisselen tussen verschillende informatiesystemen. Een notificatie is een bericht van een afzender naar een bestemmeling, met als doel de bestemmeling te informeren over een bepaalde gebeurtenis of nieuwswaardigheid. De intentie om een notificatie te versturen wordt uitgedrukt door de klasse InformeerActie (schema:InformAction) en kan beschreven worden aan de hand van eigenschappen die onder meer informatie meegeven over de doelgroep, inhoud en relevantie van het bericht. De doelgroep van een InformeerActie kan bepaald worden op basis van een doelgroep type — waarvan de invulling toepassing-specifiek is, bijvoorbeeld alle gebruikers van een bepaalde applicatie —, een geografisch gebied of een identificator. De vertaling van deze doelgroep in een set van bestemmelingen (met een e-mailadres of telefoonnummer voor elke bestemmeling) valt buiten de scope van dit applicatieprofiel en moet uitgewerkt worden binnen een specifieke toepassing.

Een InformeerActie kan resulteren in Notificatieberichten. Een Notificatiebericht (afgeleid van schema:Message) is één bericht, verstuurd via één notificatiekanaal (bijvoorbeeld sms) naar één bestemmeling. Voor een Notificatiebericht zijn tevens attributen gespecifieerd die toelaten de status van het notificatiebericht te bepalen zoals de datum verzending, datum ontvangen, datum gelezen...

Een publieke organisatie wordt verondersteld te communiceren onder één of meerdere merknamen, dit zit vervat in de entiteit Merk (schema:Brand). Een Merk kan bovendien gerelateerd zijn aan één of meerdere Publieke Diensten. De bestemmelingen in dit applicatieprofiel worden aangeduid door een abstract entiteit Agent (dct:Agent) met bepaalde contactinfo, in praktijk zal dit telkens een specifieke persoon, organisatie of hoedanigheid zijn. Deze aspecten worden verder beschreven door het OSLO-Organisatie en OSLO-Persoon vocabularium. Hoe de contactinfo voor bestemmeling kan verkregen en opgeslagen worden in lijn met de Algemene Verordening Gegevensbescherming wordt beschreven in een eigen applicatieprofiel met betrekking tot Contactvoorkeuren.

Status van dit document

Dit applicatieprofiel dient om het specifieke gebruik van de entiteiten relevant voor de beschreven applicatie te verduidelijken.

Dit document werd gepubliceerd als Kandidaat-standaard. De specificatie zoals in dit document beschreven doorloopt momenteel een periode van publieke review, tijdens het welke geen wijzigingen aan deze specificatie worden doorgevoerd.
Dit document is bedoeld om uit te groeien tot een standaard in het beschreven domein. Desalniettemin heeft het op dit ogenblik geen officieel statuut en vertegenwoordigt het geen consensus binnen OSLO.

Feedback op deze specificatie kan gegeven worden als een topic in onze publieke reviewdiscussielijst.

Licentie

Deze specificatie van Informatie Vlaanderen is gepubliceerd onder de "Modellicentie Gratis Hergebruik - v1.0".

Conformiteit

Een applicatieprofiel is een specificatie voor gegevensuitwisseling dat bijkomende beperkingen introduceert voor het toepassen van vocabularia. Dergelijke bijkomende beperkingen kunnen de volgende elementen bevatten:

  • verfijning van de terminologie (klassen en eigenschappen) consistent met de semantiek uit de betreffende specificaties met een welbepaald gebruik als doel;
  • externe terminologie (klassen en eigenschappen) gebruikt voor nieuwe/extra termen die niet in de bestaande vocabularia voorkomen.

Om conform te zijn met dit applicatieprofiel, geldt voor een implementatie dat ze:

  • MOET Voor elke klasse steeds de eigenschappen bevatten die als minimum kardinaliteit 1 hebben.
  • MAG NIET meer dan 1 instantie bevatten van eigenschappen die 1 als maximum kardinaliteit hebben.
  • MAG terminologie (klassen en eigenschappen) gebruiken op een manier die consistent is met haar semantiek (definitie, gebruik, domein en bereik).
  • MAG NIET terminologie van andere gecontroleerde vocabularia gebruiken dan diegene die gedefinieerd wordt in dit applicatieprofiel.
  • MAG uitgebreid worden met klassen en eigenschappen van andere datamodellen (vocabularia) die niet overlappen met terminologie uit dit applicatieprofiel.

Overzicht

In dit document wordt correct gebruik van de volgende entiteiten toegelicht:
| Administratieve Eenheid | Agent | Informeer Actie | Merk | Notificatiebericht | Publieke Dienstverlening | Publieke Organisatie |

In dit document worden de volgende datatypes toegelicht:
| Contactpunt | Doelgroep | Geografische Naam | Geometrie | Getypeerde String | Identificator | Sleutel/Waarde Paar |

Entiteiten

Administratieve Eenheid

Beschrijving
Een geografisch gebied, dat typisch onder de jurisdictie van een bepaalde publieke administratie valt.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: geometrie, naam.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
geometrie Geometrie 0...1 De geometrische voorstelling van het object.
naam GeografischeNaam 0...1 Naam van de Administratieve Eenheid.

Agent

Beschrijving
De Agent die het onderwerp vormt van het Profiel.
Gebruik
Agent is een abstracte klasse die in praktijk niet rechtstreeks wordt gebruikt. In praktijk zal telkens een subklasse van Agent,bijvoorbeeld Persoon,gebruikt worden.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: contactinfo.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
contactinfo Contactinfo 1 Informatie zoals email, telefoon... die toelaat de entiteit te contacteren. In de context van een notificatiebericht heeft een Agent slechts één set aan contactinfo. In de context van de applicatie kan een Agent meerdere sets van contactinfo bijhouden, bijvoorbeeld als onderdeel van zijn persoonlijk profiel binnen de toepassing.

Informeer Actie

Beschrijving
Kennisgeving van informatie aan zij die het aanbelangt. Deze informatie kan via meerdere kanalen naar een individu of naar een doelgroep genotificeerd worden.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: agent, doelgroep, inhoud, is gerelateerd met, notificatiekanaal, onderwerp, periode verzending, resulteert in.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
agent PubliekeOrganisatie 1 Duidt de agent aan die aanleiding gaf tot de InformeerActie.
doelgroep Doelgroep 1...* De bestemmeling(en) die de informatie dien(t)(en) te ontvangen.
inhoud SleutelWaarde 0...* De inhoud van een Notificatiebericht. De inhoudt van een Notificatiebericht wordt gevormd door een aantal key-value pairs.
is gerelateerd met InformeerActie 0...* Een relatie tussen twee Informeer Acties. Bijvoorbeeld wanneer een Informeer Actie aangemaakt wordt om aan te geven dat ramen en deuren gesloten moeten blijven wegens een brand in de buurt, kan deze gelinkt wordt met een tweede Informeer Actie om inwoners op de hoogte te brengen dat het gevaar geweken is.
notificatiekanaal Notificiatiekanaal 1...* Het notificatiekanaal duidt het technisch medium aan waarlangs het Notificatiebericht wordt verzonden. Er wordt verwacht dat het notificatiekanaal gedefinieerd is in een codelijst. Het bepalen en ontlsuiten van deze codelijst kan applicatie-specifiek worden ingevuld. Mogelijke waarden zijn sms en e-mail.
onderwerp 1...* Het onderwerp van de informeer actie. Er wordt verwacht dat de notificatiecategorie gedefinieerd is in een codelijst. Het bepalen en ontlsuiten van deze codelijst kan applicatie-specifiek worden ingevuld.
periode verzending TijdsInterval 1 Het tijdsinterval waarbinnen de Informeer Actie relevant is en bijgevolg kan resulteren in de verzending van notificatieberichten. Bijvoorbeeld, wanneer het stedelijk zwembad een week gesloten is, kan de periode voor verzending van de Informeer Actie beginnen een maand voor de sluiting en eindigen op de laatste dag van de sluitingsperiode.
resulteert in Notificatiebericht 0...* De relatie tussen een Informeer Actie en het (de) Notificatiebericht(en) die hier uit voortkomen.

Merk

Beschrijving
De naam gebruikt door een Publieke Organisatie om te communiceren over een bepaalde Publieke Dienstverlening.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: contactinfo, is gerelateerd met, naam.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
contactinfo ContactInfo 1 Informatie zoals email, telefoon... die toelaat de entiteit te contacteren.
is gerelateerd met PubliekeDienstverlening 0...* De Publieke Dienstverlening waar het Merk aan gerelateerd is.
naam String 1 De naam van het Merk.

Notificatiebericht

Beschrijving
Een bericht van een afzender naar een bestemmeling met als doel het informeren van de bestemmeling.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: afzender, bestemmeling, datum creatie, datum gelezen, datum ontvangen, datum verzending, notificatiekanaal, tekst, titel, url, vervalt.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
afzender Merk 1 De afzender van het Notificatiebericht.
bestemmeling Agent 1 De agent die het notificatiebericht ontvangt.
datum creatie DateTime 1 De datum waarop het Notificatiebericht gecreëerd werd.
datum gelezen DateTime 0...1 De datum waarop het Notificatiebericht werd gelezen door de bestemmeling.
datum ontvangen DateTime 0...1 De datum waarop het Notificatiebericht werd ontvangen door de bestemmeling.
datum verzending DateTime 1 De datum waarop het Notificatiebericht werd verzonden naar de bestemmeling.
notificatiekanaal Notificatiekanaal 1 Het notificatiekanaal duidt het technisch medium aan waarlangs het Notificatiebericht wordt verzonden. Er wordt verwacht dat het notificatiekanaal gedefinieerd is in een codelijst. Het bepalen en ontlsuiten van deze codelijst kan applicatie-specifiek worden ingevuld. Mogelijke waarden zijn sms en e-mail.
tekst String 1 De tekstuele inhoud van het Notificatiebericht. De tekst wordt afgeleid van de inhoud van een InformeerActie.In praktijk kan dit gebeuren door het vastleggen van sjablonen voor verschillende kanalen. De verderedere uitwerking hiervan is applicatie-specifiek.
titel String 1 Een titel voor het Notificatiebericht. De titel kan in praktijk automatisch worden samengesteld aan de hand van een aantal andere beschikbare velden.
url URI 0...1 Een url voor het Notificatiebericht. De url kan gebruikt worden om een doorverwijzing mee te geven naar een resource waarop het Notificatiebericht betrekking heeft.
vervalt DateTime 0...1 De datum waarop een Notificatiebericht vervalt.

Publieke Dienstverlening

Beschrijving
Een Publieke Dienstverlening is een geheel van verplichte of optioneel uitgevoerde of uitvoerbare acties door of in naam van een publieke organisatie. De dienstverlening is ten bate van een individu, een bedrijf, een andere publieke organisatie of groepen hiervan.
Gebruik
De dienstverlening vormt een aanbod (dat dus niet noodzakelijk wordt gebruikt). Ze houdt niet noodzakelijk het opnemen van een recht in,de dienstverlening kan de gebruiker ook toelaten een verplichting te vervullen.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: beschrijving, heeft contactpunt, heeft kost, ruimtelijke dekking, sector, status, taal, titel, trefwoord, type, verwerkingstijd.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
beschrijving TaalString 1 Beschrijving van de Publieke Dienstverlening.
heeft contactpunt ContactInfo 1 Informatie waarmee de Publieke Dienstverlening kan worden gecontacteerd. Verschillend van de informatie waarmee de Publieke Organisatie kan worden gecontacteerd.
heeft kost Kost 1 Kostprijs verbonden aan het gebruik van de Publieke dienstverlening.
ruimtelijke dekking ATU 1 Gebied waarin de Publieke Dienstverlening beschikbaar is. Typisch het werkingsgebied van de verantwoordelijke Publieke Organisatie. Link
sector NACE 1 Sector of bedrijvigheid waarop de Publieke Dienstverlening betrekking heeft of waarvoor deze is bedoeld. Bv milieu, veiligheid, wonen...
status ADMSStatusVocabularium 1 Geeft aan of een Publieke Dienstverlening actief, inactief, in ontwikkeling etc is. Link
taal NAL_language 1 Taal waarin een Publieke Dienstverlening wordt aangeboden. Link
titel TaalString 1 Officiële naam van de Publieke Dienstverlening.
trefwoord TaalString 1 Sleutelwoord, term, begrip dat de Publieke Dienst beschrijft.
type COFOG 1 Soort Publieke Dienstverlening. Bvb bescherming, gezondheid, recreatie, cultuur en religie, economische zaken.
verwerkingstijd String 1 Geschatte tijd nodig om de Publieke Dienstverlening af te leveren. De ISO8601 syntax moet worden gebruikt om de duurtijd te noteren. Bvb 5 jaar is P5Y, 1 maand is P1M.

Publieke Organisatie

Beschrijving
Een Organisatie die volgens een wettelijk kader behoort tot de publieke sector, ongeacht het bestuursniveau waarop dat kader van kracht is.
Gebruik
De overheids- en semioverheidsorganisaties die tot men zo tot de publieke sector kan rekenen worden in Europese richtlijn 2003/98/EG "openbaar lichaam" genoemd en gedefinieerd als: "de staat, zijn territoriale lichamen, publiekrechtelijke instellingen, en verenigingen gevormd door een of meer van deze lichamen of een of meer van deze publiekrechtelijke instellingen". En onder een publiekrechtelijke instelling verstaat men " iedere instelling die a) is opgericht met het specifieke doel te voorzien in behoeften van algemeen belang die niet van industriële of commerciële aard zijn, en b) rechtspersoonlijkheid heeft, en c) waarvan hetzij de activiteiten in hoofdzaak door de staat of zijn territoriale lichamen of andere publiekrechtelijke instellingen worden gefinancierd, hetzij het beheer is onderworpen aan toezicht door deze laatste, hetzij de leden van het bestuursorgaan, het leidinggevend orgaan of het toezichthoudend orgaan voor meer dan de helft door de staat, zijn territoriale lichamen of andere publiekrechtelijke instellingen zijn aangewezen.".
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: heeft merk, is verantwoordelijk voor, voorkeursnaam.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
heeft merk Merk 1...* Het merk dat geassocieerd is met één of meerdere Publieke Organisatie(s), in de context van Publieke Dienstverlening.
is verantwoordelijk voor PubliekeDienstverlening 0...* Verwijst naar de Publieke Dienstverlening waar de Publieke Organisatie verantwoordelijk voor is.
voorkeursnaam String 1 Naam waarmee de Organisatie bij voorkeur wordt aangeduid.

Datatypes

Contactpunt

Beschrijving
Informatie zoals email, telefoon, adres die toelaat om iemand of iets te contacteren.
Gebruik
Bvb een persoon of organisatie of dienstverlening… Mogelijke vormen van contact: bellen, mailen etc.
Eigenschappen
Voor dit datatype zijn de volgende eigenschappen gedefinieerd: aanschrijfvorm, adres, beschikbaarheid, contactnaam, email, fax, openingsuren, telefoon, website.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
aanschrijfvorm TaalString 0...1 Titel waarmee iemand wordt aangeschreven of aangesproken of waarmee naar iemand wordt verwezen. Bvb De heer/Mevrouw, Excellentie, Dokter…
adres Adresvoorstelling 0...1 Adres dat men kan aanschrijven of bezoeken.
beschikbaarheid OpeningsurenSpecificatie 0...1 Periode waarin contact kan worden opgenomen. Bv aanduiding van het seizoen waarin contact kan worden opgenomen. Begin- en einddatum volgens ISO8601 syntax.
contactnaam String 0...1 Naam van bvb de persoon die men kan contacteren.
email String 0...1 Email-adres waarnaar men kan mailen.
fax String 0...1 Faxnummer waarnaar men kan faxen.
openingsuren OpeningsurenSpecificatie 0...1 Uren waarbinnen contact kan worden opgenomen. Syntax volgens schema.org voor openingsuren. Bv als contact kan worden opgenomen tussen 8 en 20u maandag tot zaterdag en tussen 8 en 18u op zondag wordt dit gecodeerd als Ma-za 08:00-20:00, zo 08:00-18:00.
telefoon String 0...1 Telefoonnummer waarop men kan bellen.
website URI 0...1 Website waarnaar men kan surfen.

Doelgroep

Beschrijving
De beoogde doelgroep van een informeer actie.
Eigenschappen
Voor dit datatype zijn de volgende eigenschappen gedefinieerd: doelgroep type, geografisch gebied, identificator.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
doelgroep type String 0...1 Een typering van de doelgroep. Er wordt verwacht dat het type doelgroep gedefinieerd is in een codelijst. Het bepalen en ontlsuiten van deze codelijst kan applicatie-specifiek worden ingevuld. Voorbeelden zijn leerkrachten, vastgoedeigenaars, personen die een auto bezitten,...
geografisch gebied AdministratieveEenheid 0...* Het geografisch gebied geassocieerd met de doelgroep.
identificator Identificator 0...1 Een identificator voor de doelgroep. Kan bijvoorbeeld een specifieke persoon of organisatie identificeren, of een groep van personen of organisaties.

Geografische Naam

Beschrijving
Benaming toegekend aan of gebruikt voor een geografisch object.
Gebruik
Eigenschappen
Voor dit datatype zijn geen eigenschappen gedefinieerd.

Geometrie

Beschrijving
Vorm- en positiekenmerken van een object.
Gebruik
Beschrijft deze kenmerken dmv punten, lijnen, polygonen en coördinaten.
Eigenschappen
Voor dit datatype zijn de volgende eigenschappen gedefinieerd: gml, wkt.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
gml GetypeerdeString 0...1 Geometrie uitgedrukt in gml-formaat. Gebruik http://www.opengis.net/ont/geosparql#gmlLiteral als datatype.
wkt GetypeerdeString 0...1 Geometrie uitgedrukt in wkt-formaat. Gebruik http://www.opengis.net/ont/geosparql#wktLiteral als datatype.

Getypeerde String

Beschrijving
Combinatie van een string en het type van wat de string voorstelt.
Gebruik
Bvb '20170901' als string en 'datum' als type. Laat automatische interpretatie vd string toe.
Eigenschappen
Voor dit datatype zijn geen eigenschappen gedefinieerd.

Identificator

Beschrijving
Informatie gebruikt om de instantie ve object uniek te identificeren.
Gebruik
Uitgangspunt hier is dat deze string door een organisatie wordt toegekend en dat dit gebeurt volgens een welbepaald systeem.
Eigenschappen
Voor dit datatype zijn de volgende eigenschappen gedefinieerd: identificator, toegekend door, toegekend door (String), toegekend op.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
identificator GetypeerdeString 1 String gebruikt om de instantie ve object uniek te identificeren. Type vd string slaat op het identificatiesysteem (incl de versie ervan), de string zelf op de eigenlijke identificator.
toegekend door Agent 0...1 Link naar de agent die de identificator heeft uitgegeven.
toegekend door (String) String 0...1 Naam vd agent die de identificator heeft toegekend.
toegekend op DateTime 0...1 Tijdstip waarop de identificator werd uitgegeven.

Sleutel/Waarde Paar

Beschrijving
Een open data structuur dat uitbreiding toelaat aan de hand van een sleutel en een waarde.
Eigenschappen
Voor dit datatype zijn de volgende eigenschappen gedefinieerd: naam, waarde.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
naam String 1 Het label is de sleutel van het sleutel/waarde paar.
waarde String 1 De waarde van het sleutel/waarde paar.

JSON-LD context

Een herbruikbare JSON-LD context definitie voor dit applicatieprofiel is terug te vinden op: https://data.vlaanderen.be/context/notificatiecomponent.jsonld