From f9c97042099ce241f505c229076fa02d1a4a2c9c Mon Sep 17 00:00:00 2001 From: sytskevanhasselt Date: Tue, 4 Nov 2025 08:52:11 +0100 Subject: [PATCH] Added Logboek schema --- .../Logboek/Logboek-schema.json | 168 ++++++++++++++++++ community-concepts/Logboek/README.md | 11 ++ 2 files changed, 179 insertions(+) create mode 100644 community-concepts/Logboek/Logboek-schema.json create mode 100644 community-concepts/Logboek/README.md diff --git a/community-concepts/Logboek/Logboek-schema.json b/community-concepts/Logboek/Logboek-schema.json new file mode 100644 index 0000000..bcc4d3d --- /dev/null +++ b/community-concepts/Logboek/Logboek-schema.json @@ -0,0 +1,168 @@ +{ + "type": "object", + "title": "activiteitenlog", + "$schema": "http://json-schema.org/draft-07/schema#", + "examples": [], + "required": [ + "heeftBetrekkingOp", + "activiteiten" + ], + "properties": { + "activiteiten": { + "type": "array", + "items": { + "type": "object", + "title": "Activiteit", + "required": [ + "datum", + "type", + "omschrijving" + ], + "properties": { + "type": { + "type": "string", + "title": "Type", + "description": "Vaste waardes waarmee verschillende de soorten activiteiten herkend kunnen worden. Bijvoorbeeld: 'afsluiting' of 'toewijzing'" + }, + "actor": { + "type": "object", + "title": "Actor", + "required": [ + "actoridentificator" + ], + "properties": { + "naam": { + "type": "string", + "title": "Naam", + "description": "Naam van de actor die deze activiteit aan het logboek heeft toegevoegd" + }, + "actoridentificator": { + "type": "object", + "title": "Actoridentificator", + "required": [ + "codeRegister", + "codeObjecttype", + "codeSoortObjectId", + "objectId" + ], + "properties": { + "objectId": { + "type": "string", + "title": "Het id van de actor", + "description": "De waarde van het in het codeSoortObjectId aangeduide veld, bijvoorbeeld: 'een.naam@degemeente.nl" + }, + "codeRegister": { + "type": "string", + "title": "De naam van het register", + "description": "Naam van het register waarin het object is geregistreerd, bijvoorbeeld: 'entraId'" + }, + "codeObjecttype": { + "type": "string", + "title": "De naam van het soort object in het register", + "description": "Type van het object: bijvoorbeeld: 'user'" + }, + "codeSoortObjectId": { + "type": "string", + "title": "De naam van het veld van het object", + "description": "Naam van het identificerende veld in het object, bijvoorbeeld: 'Id'." + } + }, + "description": "Een verwijzing naar de actor in het bronsysteem waarin deze is vastgelegd" + } + }, + "description": "Verwijzing naar de persoon die dit item aan deze log heeft toegevoegd" + }, + "datum": { + "type": "string", + "title": "Datum", + "format": "date-time", + "description": "De datum waarop dit item is toegevoegd aan de log." + }, + "notitie": { + "type": "string", + "title": "Notitie", + "description": "Informatie over deze activiteit" + }, + "omschrijving": { + "type": "string", + "title": "Omschrijving", + "description": "Gebruiksvriendelijke informatieve omschrijving van de soort activiteit." + }, + "heeftBetrekkingOp": { + "type": "array", + "items": { + "type": "object", + "title": "Object", + "required": [ + "codeRegister", + "codeObjecttype", + "codeSoortObjectId", + "objectId" + ], + "properties": { + "objectId": { + "type": "string", + "description": "De waarde van het veld" + }, + "codeRegister": { + "type": "string", + "title": "De naam van het register", + "description": "Naam van het register waarin het object is geregistreerd, bijvoorbeeld: 'OpenKlant-v2'" + }, + "codeObjecttype": { + "type": "string", + "title": "De naam van het soort object in het register", + "description": "Type van het object, bijvoorbeeld Klantcontact" + }, + "codeSoortObjectId": { + "type": "string", + "title": "De naam van het veld van het object", + "description": "Naam van het identificerende veld in het object, bijvoorbeeld: 'id'." + } + }, + "description": "Verwijzing naar een object waar deze activiteit betrekking op heeft. Bijvoorbeeld een klantcontact of een medewerker" + }, + "title": "heeftBetrekking op", + "description": "Lijst van objecten waar deze activiteit betrekking op heeft. Bijvoorbeeld een klantcontacten en medewerkers" + } + }, + "description": "Activiteit" + }, + "title": "Activiteiten", + "description": "Lijst van activiteiten" + }, + "heeftBetrekkingOp": { + "type": "object", + "title": "Het object waar deze activiteitenlog betrekking op heeft", + "required": [ + "codeRegister", + "codeObjecttype", + "codeSoortObjectId", + "objectId" + ], + "properties": { + "objectId": { + "type": "string", + "title": "De waarde in het bij codeSoortObjectId aangeduide veld ", + "description": "De waarde van het veld, bijvoorbeeld: '575fc9e4-a73c-495b-a8a1-1e718656e847'" + }, + "codeRegister": { + "type": "string", + "title": "De naam van het register", + "description": "Naam van het register waarin het object is geregistreerd, bijvoorbeeld: 'OpenKlant'" + }, + "codeObjecttype": { + "type": "string", + "title": "De naam van het soort object in het register", + "description": "Type van het object, bijvoorbeeld: internetaak" + }, + "codeSoortObjectId": { + "type": "string", + "title": "De naam van het veld in het objecttype", + "description": "Naam van het identificerende veld in het object, bijvoorbeeld: 'uuid'" + } + }, + "description": "Dit is een referentie naar het object waar deze activiteitenlog betrekking op heeft, bijvoorbeeld een interne taak" + } + } +} \ No newline at end of file diff --git a/community-concepts/Logboek/README.md b/community-concepts/Logboek/README.md new file mode 100644 index 0000000..4a7949d --- /dev/null +++ b/community-concepts/Logboek/README.md @@ -0,0 +1,11 @@ +## Logboek +This objecttype was created for [ITA](https://ita.readthedocs.io/). ITA stores information about activities surrounding the processing of a Contactverzoek in a Activity Log. While still researching what would be the proper common ground standard for this information, we created an Objecttype to store this information. +Some properties are not reflected in the JSON-schema and are shown below. + +- Scope: public +- Version: 1.0 +- Created: 2025-07-10 +- Modified: 2025-07-10 +- Status: Proposed + +__By Sytske van Hasselt and Mark Stoker, ICATT.menselijk digitaal__ \ No newline at end of file