Skip to content

Commit

Permalink
Merge pull request #4 from Logius-standaarden/mim-feature
Browse files Browse the repository at this point in the history
Mim feature
  • Loading branch information
mrtn78 authored Dec 18, 2024
2 parents f1bc861 + 0e639e6 commit cc4d067
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 18 deletions.
19 changes: 14 additions & 5 deletions CanoniekGegevensmodel.md → Informatiemodel.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
<!-- markdownlint-disable first-line-heading -->
## Canoniek Gegevensmodel
## Informatiemodel

Ter verduidelijking van de standaard is een Canoniek gegevensmodel uitgewerkt, dit gestandaardiseerd model voor datarepresentatie is ontworpen om de attributen eenduidig en consistenter te maken. Het biedt een uniforme structuur en terminologie voor alle relevante gegevens in de standaard. Zie voor de definitie van de gebruikte terminologie ook [Paragraaf 1.2 van de standaard](https://logius-standaarden.github.io/logboek-dataverwerkingen/#terminologie).
Ter verduidelijking van de standaard is een Informatiemodel uitgewerkt, dit model is opgesteld conform de [MIM standaard](https://docs.geostandaarden.nl/mim/mim/). Het MIM kent 4 beschouwingsniveaus:

### attribute
- Beschouwingsniveau 1 - Model van begrippen,
- Beschouwingsniveau 2 - Conceptueel informatiemodel,
- Beschouwingsniveau 3 - Logisch informatie- of gegevensmodel,
- Beschouwingsniveau 4 - Fysiek of technisch gegevens- of datamodel.

Deze inleiding bevat een aantal definities op beschouwingsniveau 3 ter toelichting.
In de standaard zelf zijn zowel een aantal [begrippen](https://logius-standaarden.github.io/logboek-dataverwerkingen/#componenten) gedefinieerd als een [conceptueel informatiemodel voor de interface](https://logius-standaarden.github.io/logboek-dataverwerkingen/#interface) uitgewerkt.
Zie voor de definitie van de gebruikte [terminologie § Paragraaf 1.2 van de standaard](https://logius-standaarden.github.io/logboek-dataverwerkingen/#terminologie).

### attributes

| **Attribuut** | **Beschrijving** |
| ---------------------------- | ------------------------------------------------------------ |
| **Attribuutnaam** | `attribute` |
| **Attribuutnaam** | `attributes` |
| **Definitie Engels** | Attributes in the form of key value pairs. |
| **Attribuutnaam Nederlands** | attribuut |
| **Attribuutnaam Nederlands** | attributen |
| **Definitie Nederlands** | Attributen in de vorm van key value pairs. |
| **Toelichting** | Organisaties hebben de vrijheid om zelf key value pairs te bepalen als dit bijdraagt aan de inzichtelijkheid van een gegevensverwerkingsactie. |
| **Noodzakelijkheid** | Vanuit de standaard is het onmogelijk om alle attribuutsoorten te definiëren die belangrijk zijn voor de inzichtelijkheid van een gegevensverwerkingsactie. Daarom is er in de standaard rekening gehouden met een mogelijkheid om per organisatie of per systeem eigen attribuutsoorten te bepalen. |
Expand Down
16 changes: 8 additions & 8 deletions architectuur_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,27 +74,27 @@ De standaard Logboek dataverwerkingen gaat er vanuit dat de het Logboekcomponent
#### Aspectgebieden

- *Informatiebeveiliging*
- De standaard Logboek dataverwerkingen gaat er vanuit dat zowel het Logboekcomponent als de gegevens in het Logboek beveiligd zijn volgens de BIO (=Baseline Informatiebeveiliging Overheid) – zie ook zie [Beleidskader 8.9](https://logius-standaarden.github.io/publicatie/api/Logboek_Juridisch/#beleidskader).
- De standaard Logboek dataverwerkingen gaat er vanuit dat zowel het Logboekcomponent als de gegevens in het Logboek beveiligd zijn volgens de BIO (=Baseline Informatiebeveiliging Overheid) – zie ook zie [Beleidskader 8.9](https://logius-standaarden.github.io/publicatie/api/logboek_juridisch/#beleidskader).
- *Beheer en exploitatie*
- Logius verzorgt het beheer en onderhoud van deze standaard volgens het [BOMOS](https://www.logius.nl/domeinen/infrastructuur/bomos)-model.

### Relaties GDI architectuurprincipes en de standaard
### Relaties GDI architectuurprincipes en de standaard

| **Architectuurprincipe** | **Relatie met de standaard** |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| 1.1. Gegevens die kunnen worden gedeeld zijn vindbaar, toegankelijk, interoperabel en herbruikbaar | - Logregels zijn voorzien van metagegevens ten aanzien van tracering zodat gerelateerde Logeregels altijd gevonden kunnen worden.<br> - Identificatoren worden aangemaakt zodat deze over de gehele wereld uniek zijn.<br> - Het processingActivityId is gerelateerd aan het Register van Verwerkingsactiviteiten zodat per Logregel altijd verwezen kan worden naar een activiteit van een (overheids)organisatie en daarmee de context direct duidelijk wordt. |
| 1.2. Gegevensuitwisseling is gebaseerd op open standaarden | - API’s gerelateerd aan deze standaard moeten worden ontworpen en gebouwd volgens de standaarden [REST-API Design Rules](https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules), [OpenAPI](https://www.openapis.org/) en [DigiKoppeling](https://www.logius.nl/domeinen/gegevensuitwisseling/digikoppeling).<br> - Het metadatamodel van deze standaard is gebaseerd op [OpenTelemetry](https://opentelemetry.io/). Dit is een internationale standaard voor het genereren, verzamelen en exporteren van telemetrie gegevens (metrieken, logging en tracering). |
| 1.3 De kwaliteit van gegevens is afgestemd op het gebruik | - Door de registratie van verwerkte data in een Logboek kan er op een later moment inzicht gegeven worden aan andere (overheids)organisaties en burgers. Eventuele foutieve data komen dan direct aan het licht en kunnen hersteld worden. |
| 1.4. Gegevensdiensten zijn afgestemd op de behoeften van afnemers | - Gegevens die gelogd worden bij een gegevensverwerking zijn afgestemd op het doel waarvoor er gelogd moet worden (bijvoorbeeld de gegevens die gevraagd worden op basis van de AVG-wetgeving). Er wordt niet minder opgeslagen, meer zeker niet meer dan nodig is.<br> - Het ontwerp van het gegevensmodel van deze standaard is gebaseerd op OpenTelemetry, vertaling van gegevens is dus niet nodig. |
| 1.5. De bron van de gegevens is leidend | - Overheidsapplicaties moeten rekening houden met de onderhoud van data bij de [bron](https://www.digitaleoverheid.nl/data-bij-de-bron/). Dit betekent dat gegevens niet zonder meer gekopieerd opgeslagen mogen worden. Bij sommige dataverwerkingen zijn data nodig van andere databronnen (in de eigen organisatie of bij een andere organisatie). De standaard Logboek Dataverwerkingen schrijft een traceringsmechanisme voor zodat kopiëren van specifieke data naar het Logboek niet nodig is, er kan altijd nagegaan worden waar data vandaan kwamen en welke data er gebruikt werden.<br> - De standaard verwijst zo veel mogelijk naar bestaande databronnen elders in plaats van de data te dupliceren (zie besluit [4.2](https://logius-standaarden.github.io/publicatie/api/Logboek_Algemeen/#logregels-bevatten-geen-gegevens-die-al-vastliggen-in-een-register) en [4.4](https://logius-standaarden.github.io/publicatie/api/Logboek_Algemeen/#geen-gegevens-over-gebruikers-in-logregels)) |
| 1.5. De bron van de gegevens is leidend | - Overheidsapplicaties moeten rekening houden met de onderhoud van data bij de [bron](https://www.digitaleoverheid.nl/data-bij-de-bron/). Dit betekent dat gegevens niet zonder meer gekopieerd opgeslagen mogen worden. Bij sommige dataverwerkingen zijn data nodig van andere databronnen (in de eigen organisatie of bij een andere organisatie). De standaard Logboek Dataverwerkingen schrijft een traceringsmechanisme voor zodat kopiëren van specifieke data naar het Logboek niet nodig is, er kan altijd nagegaan worden waar data vandaan kwamen en welke data er gebruikt werden.<br> - De standaard verwijst zo veel mogelijk naar bestaande databronnen elders in plaats van de data te dupliceren (zie besluit [§ 5.2](https://logius-standaarden.github.io/logboek-dataverwerkingen_Inleiding/#logregels-bevatten-geen-gegevens-die-al-vastliggen-in-een-register) en [§ 5.4](https://logius-standaarden.github.io/logboek-dataverwerkingen_Inleiding/#geen-gegevens-over-gebruikers-in-logregels)) |
| 1.6. Burgers en organisaties hebben regie over hun eigen gegevens | - Burgers, (overheids)organisaties en parlement hebben recht om inzicht te krijgen in verwerkte data. Door toepassing van deze standaard kan er een rapportage gemaakt worden die voldoet aan die informatiebehoefte.<br> - De standaard Logboek dataverwerkingen biedt geen handreiking ten aanzien van de manier waarop gegevensinzicht plaats moet vinden richting belanghebbende, wel op de in de inhoud van het gegevensinzicht. |
| 1.7. Persoonsgegevens zijn beschermd bij het uitwisselen van gegevens | - Deze standaard gaat er vanuit dat autorisatie- en beveiligingsmechanismen worden toegepast rondom Applicatie en Logboek, daarom zijn er geen extra richtlijnen op dit vlak. Zie ook [Beleidskader 8.9](https://logius-standaarden.github.io/publicatie/api/Logboek_Juridisch/#beleidskader). |
| 1.7. Persoonsgegevens zijn beschermd bij het uitwisselen van gegevens | - Deze standaard gaat er vanuit dat autorisatie- en beveiligingsmechanismen worden toegepast rondom Applicatie en Logboek, daarom zijn er geen extra richtlijnen op dit vlak. Zie ook [Beleidskader § 8](https://logius-standaarden.github.io/publicatie/api/logboek_juridisch/#beleidskader). |
| 1.8. Uitwisseling van gegevens wordt gelogd als deze later aantoonbaar moet zijn | - Logging van verwerkte data is de kern van deze standaard. Door gebruikt te maken van een traceringsmechanisme en unieke identificatoren, kan er altijd worden voldaan aan de eis dat ontvangen en verzonden data aan elkaar gerelateerd kunnen worden. |
| 2.1. Gegevensuitwisseling is federatief georganiseerd | - Logboek Dataverwerkingen maakt het mogelijk om in een gefedereerde omgeving en in informatieketens verantwoording te kunnen afleggen over gegevensuitwisseling. Hiervoor wordt tracing ingezet, een concept dat gebaseerd op de open standaard OpenTelemetry. Zie voor enkele juridische en beleidsmatige uitgangspunten het Juridisch Beleidskader [hoofdstuk 6](https://logius-standaarden.github.io/publicatie/api/Logboek_Juridisch/#een-standaard-opstellen-om-deze-kaders-te-faciliteren) en [hoofdstuk 8](https://logius-standaarden.github.io/publicatie/api/Logboek_Juridisch/#beleidskader).<br> - Nadere invulling t.a.v. gegevensuitwisseling in het kader van inzage zal volgen als de extensie voor inzage wordt gemaakt. |
| 2.1. Gegevensuitwisseling is federatief georganiseerd | - Logboek Dataverwerkingen maakt het mogelijk om in een gefedereerde omgeving en in informatieketens verantwoording te kunnen afleggen over gegevensuitwisseling. Hiervoor wordt tracing ingezet, een concept dat gebaseerd op de open standaard OpenTelemetry. Zie voor enkele juridische en beleidsmatige uitgangspunten het Juridisch Beleidskader [§ 6](https://logius-standaarden.github.io/publicatie/api/logboek_juridisch/#een-standaard-opstellen-om-deze-kaders-te-faciliteren) en [§ 8](https://logius-standaarden.github.io/publicatie/api/logboek_juridisch/#beleidskader).<br> - Nadere invulling t.a.v. gegevensuitwisseling in het kader van inzage zal volgen als de extensie voor inzage wordt gemaakt. |
| 2.2. Voorwaarden en afspraken zijn expliciet en inzichtelijk | - Afspraken in het kader van deze standaard zullen vooral gemaakt worden op het gebied van tracering van data binnen organisaties en over organisaties heen. |
| 3.1. Gemeenschappelijke begripsvorming is het startpunt | - De data die gebruikt worden in deze standaard, staan vermeld en uitgelegd in het [Canoniek Gegevensmodel](https://logius-standaarden.github.io/publicatie/api/Logboek_Algemeen/). Het is van belang dat alle (overheids)organisatie die gebruik maken van de standaard hetzelfde beeld hebben ten aanzien specifieke data en uitwisseling daarvan om foutsituaties en verwarring te voorkomen. |
| 3.2. Metagegevens zijn begrijpelijk voor mensen | - De metagegevens zijn veelal ontstaan op basis van de internationale standaard OpenTelemetry. Daarnaast worden de begrippen ook uitgelegd in het Canoniek Gegevensmodel. |
| 3.3. Gegevens worden contextrijk vastgelegd | - Het gebruik van metadata in deze standaard is essentieel. De context wordt uitgelegd in het Canoniek Gegevensmodel. Daarnaast zijn er verdiepingsdocumenten aanwezig zoals het traceringsmechanisme [nog toe te voegen] en concrete [voorbeelden](https://logius-standaarden.github.io/publicatie/api/Logboek_Algemeen/#voorbeelden) van loggingssituaties. |
| 3.1. Gemeenschappelijke begripsvorming is het startpunt | - De data die gebruikt worden in deze standaard, staan vermeld en uitgelegd in het [informatiemodel](https://logius-standaarden.github.io/logboek-dataverwerkingen_Inleiding/). Het is van belang dat alle (overheids)organisatie die gebruik maken van de standaard hetzelfde beeld hebben ten aanzien specifieke data en uitwisseling daarvan om foutsituaties en verwarring te voorkomen. |
| 3.2. Metagegevens zijn begrijpelijk voor mensen | - De metagegevens zijn veelal ontstaan op basis van de internationale standaard OpenTelemetry. Daarnaast worden de begrippen ook uitgelegd in het informatiemodel. |
| 3.3. Gegevens worden contextrijk vastgelegd | - Het gebruik van metadata in deze standaard is essentieel. De context wordt uitgelegd in het informatiemodel. Daarnaast zijn er verdiepingsdocumenten aanwezig zoals het traceringsmechanisme [nog toe te voegen] en concrete [voorbeelden § 6](https://logius-standaarden.github.io/logboek-dataverwerkingen_Inleiding/#voorbeelden) van loggingssituaties. |
| 3.4. Metagegevens zijn aan elkaar verbonden | - Metagegevens tussen de verschillende Logboeken zijn aan elkaar gerelateerd middels de beschrijvingen en afspraken zoals gespecifieerd in de standaard . |
| 3.5. Metagegevens zijn beschikbaar als Linked Data | - De gedefinieerde metadata is gerelateerd aan de standaard [NL-SBB – standaard voor het beschrijven van begrippen](https://docs.geostandaarden.nl/nl-sbb/nl-sbb/). |
| 4.1. Gegevens worden geleverd vanuit herbruikbare gegevensdiensten | - Nadere invulling volgt bij het ontwerp van de Inzage extensie. |
Expand Down
2 changes: 1 addition & 1 deletion docs/besluiten/00-introductie.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Deze sectie is *tijdelijk* en *niet normatief*, bedoeld om informatie te geven o

In de definitieve standaard wordt deze lijst niet opgenomen, omdat veel afwegingen specifiek zijn voor de context van de Nederlandse overheid waarin deze standaard is ontstaan. De standaard is breder inzetbaar, en voor de implementatie is het niet relevant om de afwegingen bij alle aspecten van de standaard in de context van de Nederlandse overheid te kennen.

Een aantal besluiten en overweging hebben relatie met het [Juridische Beleidskader](https://logius-standaarden.github.io/publicatie/api/Logboek_Juridisch/)
Een aantal besluiten en overweging hebben relatie met het [Juridische Beleidskader](https://logius-standaarden.github.io/publicatie/api/logboek_juridisch/)
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<h2>Architectuur</h2>
<section data-include-format="markdown" data-include="architectuur_context.md"></section>
<section data-include-format="markdown" data-include="relatie_logboekelementen.md"></section>
<section data-include-format="markdown" data-include="CanoniekGegevensmodel.md"></section>
<section data-include-format="markdown" data-include="Informatiemodel.md"></section>
</section>
<section>
<h2>Besluitenlijst</h2>
Expand Down
4 changes: 2 additions & 2 deletions js/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ var respecConfig = {
specType: "PR",
pubDomain: "api",
shortName: "logboek_algemeen",
publishDate: "2024-10-23",
publishVersion: "0.1.0",
publishDate: "2024-12-17",
publishVersion: "0.8.1",
title: "Algemene inleiding - Logboek dataverwerkingen",

edDraftURI: "https://logius-standaarden.github.io/logboek-dataverwerkingen_Inleiding/",
Expand Down
2 changes: 1 addition & 1 deletion relatie_logboekelementen.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ In de gemeente-applicatie krijgt elke (sub)Operation een eigen, unieke Operation
Als alle relaties gelegd zijn, ziet de traceringsconstructie er als volgt uit:
![Alt text](./medias/relatie_logboekelementen_afbeelding14.png)

Meer gedetailleerde voorbeelden staan beschreven in de [inleiding](https://github.com/Logius-standaarden/logboek-dataverwerkingen_Inleiding/blob/main/ch05_voorbeelden.md) van de standaard logboek dataverwerkingen.
Meer gedetailleerde voorbeelden staan beschreven in de [inleiding](https://logius-standaarden.github.io/logboek-dataverwerkingen_Inleiding/#voorbeelden) van de standaard logboek dataverwerkingen.

0 comments on commit cc4d067

Please sign in to comment.