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 de Notificatiecomponent, een generieke bouwsteen van Informatie Vlaanderen.

Status van dit document

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

Dit document werd gepubliceerd als Ontwerpdocument. De specificatie zoals in dit document beschreven is in ontwikkeling. Bijgevolg kan dit document op elk moment aangepast, vervangen of achterhaald worden.
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 vertegenwoordigd het geen consensus binnen OSLO.

Feedback op deze specificatie kan gegeven worden via 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 yerminologie (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:
| Agent | Merk | Notificatiebericht | Publieke Organisatie | Status |

In dit document worden de volgende datatypes toegelicht:
| Contactpunt | Sleutel/Waarde Paar |

Entiteiten

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 geen eigenschappen gedefinieerd.

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, url.
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.
url URI 0...1 De url geassocieerd met het Merk.

Notificatiebericht

Beschrijving
Een Notificatiebericht van een afzender naar een bestemmeling.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: afzender, bron, datum creatie, inhoud, status, titel, type, url, vervalt.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
afzender Merk 1 De afzender van het Notificatiebericht.
bron PubliekeOrganisatie 1 Duidt de bron aan van een Notificatiebericht.
datum creatie DateTime 1 De datum waarop het Notificatiebericht gecreëerd werd.
inhoud SleutelWaardePaar 0...* De inhoud van een Notificatiebericht. De inhoudt van een Notificatiebericht wordt gevormd door een aantal key-value pairs.
status Status De status van een Notificiatiebericht per bestemmeling.
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.
type Notificatiecategorie 1 Het type van het Notificatiebericht.
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 1 De datum waarop een Notificatiebericht vervalt.

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 0...* 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.

Status

Beschrijving
De Status van het Notificatiebericht voor een bepaalde bestemmeling.
Eigenschappen
Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: agent, datum gelezen, datum verzending, notificatie status, notificatiebericht, notificatiekanaal.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
agent Agent 1...* De Agent waarop deze Status betrekking heeft.
datum gelezen DateTime 1 De datum waarop het Notificatiebericht werd gelezen door de bestemmeling.
datum verzending DateTime 1 De datum waarop het Notificatiebericht werd verzonden naar de bestemmeling.
notificatie status NotificatieStatus 1 De status van een notificatie voor een bepaalde bestemmeling.
notificatiebericht Notificatiebericht 0...* Het Notificatiebericht waarop deze Status betrekking heeft.
notificatiekanaal Notificiatiekanaal 1...* Het notificatiekanaal duidt het technisch medium aan waarlangs het Notificatiebericht wordt verzonden.

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 opgenoment aangeboden. 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.

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: label, waarde.
Eigenschap Verwacht Type Kardinaliteit Beschrijving Gebruik Codelijst
label 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: http://data.vlaanderen.be/context/notificatie.jsonld