Kodeværdier anvendes på tværs af webservices som en delt nøgle med en entydig betydning. Kodeværdier inddeles i typer som udstilles via kodelister, en for hver type. Kodelisterne anvendes af serviceaftagerne, og beskriver det lovlige udfaldsrum for de pågældende kodetyper.
Kodelister kan være simple kode/værdi lister eller mere avancerede strukturer, som f.eks. hierarkier eller netværksstrukturer.
Koder samles i kodelister ud fra det forretningsområde og forretningsbegreb koden tilhører. Det er ikke altid simpelt at konstruere gode kodelister. Det bør tilstræbes at kodelisten kun indeholder en dimension i forhold til det forretningsbegreb, der forsøges beskrevet. En dimension kan f.eks. være kursustype en anden kan være myndighed.
Følgende minimumsmodel anvendes for kodeværdier:
Både Navn og Beskrivelse skrives i et neutralt sprog og vil ikke indeholde brugergrænseflade eller applikationsspecifikke værdier. Målet er, at teksterne kan anvendes på tværs af sagsbehandler- og borgerrettede løsninger, og det anbefales aftagerne at aftage teksterne direkte, og kun supplere specifikke koder med egne beskrivelser, hvor det på kodelisten angivne Navn/Beskrivelse ikke kan anvendes.
En guide på hvor man opretter en kodeliste fra en teknisk synpunkt finder du på /wiki/spaces/CITY/pages/38666305.
Følgenden regler overholdes:
Aftagere DFDG webservices (og dermed kodelister) skal afhente kodelisterne dagligt og indlæse i eget system. Denne caching af listerne skal anvendes for ikke at belaste DFDG unødigt.
Kodelisterne indeholder kun offentlige data. Alle må tilgå kodelisterne. Det anbefales at kodelister udstilles offentligt.
De fleste webservices anvender følgende struktur (OBS:enkelte kodeliste fraviger fra denne struktur):
Element | Beskrivelse |
---|---|
Identifier | Identifier elementet, der angiver den id, der skal benyttes til servicen for dette kode liste element. Type: int |
Name | Et sigende navn for kodeværdien. Min. Length: 1 Max. Length: 100 Type: string |
Description | En kort beskrivelse af kodes betydning Min. Length: 1 Max. Length: 500 Type: string |
StartDate | Dato som kodeværdien er gyldig fra Format: xsd:dateTime |
EndDate | Dato for hvornår kodeværdien udløber Format:xsd:dateTime |
Se kodeliste webservices her: CodeListsService
En kodeliste er som udgangspunkt kun ejet af et forretningsdomæne (se Webservice-struktur (TO-BE på moderniserende DFDG webservice)), hvorfra kodelisten udstilles til aftagere via forretningsdomænets webservice til afhentning af kodelister. Eksempelvis vil kodelisten til kontaktgrupper været ejet af forretningsdomænet DFDG Visitering og status.
Kodelister kan dog benyttes på tværs af forretningsdomæner, således at webservices i ét forretningsdomæne kan benytte og udstille kodeværdier fra kodelister, som er ejet af ét andet forretningsdomæne. Et tænkt eksempel kunne være, at en webservice i forretningsdomænet DFDG Borgerrettet indsats har behov for at benytte og/eller udstille kodeværdien for en kontaktgruppe.
Den nuværende webservicestruktur følger dog ikke overstående mønster, hvilket betyder, at de fleste kodelister i dag er udstillet fra DFDG på webservicen CodeListService. Fremadrettet er målet at følge ovenstående mønster, hvilket betyder, at forretningsdomæner begynder at udstille de kodelister, som de hver især ejer. Mønsteret benyttes også i forhold til de webservices, der udstilles af henholdsvis Jobnet og Vitas og som hver især har deres egen websevice indeholdende deres kodelister.
Den tekniske beskrivelse af, hvorledes kodelister benyttes på tværs af forretningsdomæner og systemsiloer (DFDG, Jobnet og Vitas) er beskrevet på DFDG Foundation, kodelister.