Inhoud

Metadataschema i.c.m. Common Ground API's

In onderstaand schema is aangegeven hoe de metadata van de verschillende API's van 'Common Ground' corresponderen met de Minimale Metadataset en vice versa. Eventuele additionele verplichte 'Common Ground' metadata die niet in de Minimale Metadataset voorkomen, kunnen in de vrije velden van DMS/Cloud worden geplaatst.

Er zijn 21 verplichte metadata velden, daarnaast is er nog een veld voor de entiteit, die als “verplicht indien van toepassing dient te worden beschouwd. Voor sommige metadatavelden ('Resultaat' en 'Einddatum') geldt dat deze gedurende de levenscyclus van de informatie dienen te worden aangepast . Voor sommige velden geldt ook dat deze niet in de procesapplicatie hoeven te worden ingevuld, maar dat dit plaatsvindt wanneer de informatie naar het DMS verhuist (bijvoorbeeld 'Thema' en 'Subthema').

Metadata / API's op documentniveau

#MetagegevenRGBZ 2 / API'sAdditionele informatieLink naar GEMMA
1DatumEIO.Creatiedatum, EIO.OntvangstdatumBij een inkomende brief wordt de ontvangstdatum gebruikt, is dit niet het geval, gebruik de creatiedatumCreatiedatum, Ontvangstdatum
2DocumenttypeEIO.InformatieobjectTypeVoor de vulling van dit veld de vaste waarden uit de Stamtabel [tabblad 'Documenttype'] gebruikenInformatieobjecttype
3OnderwerpEIO.TitelVrij invulbaar veld, wordt 1 op 1 overgenomen uit aanleverende applicatieInformatieobject
4StatusEIO.StatusVoor de vulling van dit veld de vaste waarden uit de Stamtabel [Tabblad 'Status'] gebruiken: 'Concept' en 'Definitief'. Het API statusniveau 'In Bewerking' niet gebruikenStatus

Metadata / API's op zaak / dossier(zaak)niveau

#MetagegevenRGBZ 2 / API'sAdditionele informatieLink naar GEMMA
5EinddatumZaak.EinddatumOnbekend tot het resultaat bekend is. Bij het vullen van het veld 'Resultaat' moet dit veld worden ingevuldEinddatum
6Gemeenschappelijk kenmerkN.v.t.Wordt door DMS/Cloud gevuldN.v.t.
7ResultaatZaak.ResultaattypeHet resultaattype is op het moment van ontvangst of creatie nog onbekend. Gebruik dan default de waarde 'Nader te bepalen'. Dit moet worden aangepast wanneer het resultaat wél bekend is. Voor de vulling van dit veld vervolgens de vaste waarden uit de Stamtabel [tabblad 'Resultaat(type)'] gebruikenResultaattype
8StartdatumZaak.StartdatumOp het moment van ontvangst of creatie invullenStartdatum
9VertrouwelijkheidEIO.VertrouwelijkheidsaanduidingVoor de vulling van dit veld de vaste waarden uit de Stamtabel [Tabblad 'Vertrouwelijkheid'] gebruiken (o.b.v de BIO): 'Geheim', 'Intern', 'Openbaar' en 'Vertrouwelijk'. De API-niveau's 'Zaakvertrouwelijk', 'Confidentieel' en 'Beperkt Openbaar' dus niet gebruikenVertrouwelijkheidsaanduiding

Metadata / API's op procesniveau

#MetagegevenRGBZ 2 / API'sAdditionele informatieLink naar GEMMA
10ProcesZaak.IsvanZaaktypeVoor de vulling van dit veld de vaste waarden uit de Stamtabel [Tabblad 'Thema's en processen'] gebruikenZaaktype
11ThemaN.v.t.Wordt door DMS gevuld op basis van de Stamtabel [Tabblad 'Thema's en processen']N.v.t.
12SubthemaN.v.t.Wordt door DMS gevuld op basis van de Stamtabel [Tabblad 'Thema's en processen']N.v.t.

Metadata / API's m.b.t. de behandelaar

#MetagegevenRGBZ 2 / API'sAdditionele informatieLink naar GEMMA
13AccountnaamMedewerker.medewerkeridentificatieLogin IDMedewerker
14AfdelingN.v.t.Wordt afgeleid uit de Active DirectoryN.v.t.
15DienstN.v.t.Wordt afgeleid uit de Active DirectoryN.v.t.
16FunctieN.v.t.Wordt afgeleid uit de Active DirectoryN.v.t.
17Naam behandelaarN.v.t.Wordt afgeleid uit de Active DirectoryN.v.t.

Metadata / API's m.b.t. de technische gegevens

#MetagegevenRGBZ 2 / API'sAdditionele informatieLink naar GEMMA
18AutorisatiesN.v.t.Worden binnen de applicaties zelf geregeldN.v.t.
19BestandsformaatEIO.FormaatBestandsformaten dienen op versieniveau van het informatie-element te worden vastgelegdFormaat
20OmvangEIO.BestandsomvangDe omvang dient op versieniveau van het informatie-element te worden vastgelegdBestandsformaat
21Unieke codeEIO.Integriteit.waardeHASH-codes dienen op versieniveau van het informatie-element te worden vastgelegdWaarde

Metadata / API's m.b.t. entiteiten (let op: verplicht indien van toepassing!)

#MetagegevenRGBZ 2 / API'sAdditionele informatieLink naar GEMMA
ALocatieZaak.zaakobject [type 'kadaster/vestiging'])Afhankelijk van het proces of de zaakZaakobject
BPersoon (BSN #)Zaak.zaakobject [type 'natuurlijk persoon'])Afhankelijk van het proces of de zaakZaakobject
CRechtspersoon (RSIN #)Zaak.zaakobject [type 'niet natuurlijk persoon'])Afhankelijk van het proces of de zaakZaakobject
DVraagstukZaak.identificatieWordt gevuld met het ID van de zaakZaakobject

Voor verdere uitleg over de achtergronden van dit schema, volg deze link naar technische en semantische interoperabiliteit.