Yhteentoimivuusmenetelmän mukainen toimintamalli - Koodistot

 LUONNOS

1 Taustaksi

Tällä sivulla kuvataan yhteentoimivuusmenetelmän mukainen tapa määritellä ja kuvata koodistoja Koodistot-työkalulla, kun organisaatio haluaa julkaista koodistojaan myös muiden organisaatioiden tietoon ja käytettäväksi.

Tämä sivusto ei kuvaa Koodistot-työkalun käyttöä, vaan sen käyttöohje on oma dokumenttinsa.

Tässä dokumentissa on kuvattu myös periaatteet, joilla tuleva "ydinkoodistoryhmä" osallistuisi koodistomäärittelyjen hyväksymiseen. Ydinkoodistoryhmän on ajateltiu toimivan samalla periaatteella kuin Ydinsanastoryhmä sanastojen ja Käsitemallityöryhmä tietomallien määrittelyssä.

Alla koodistomäärittelyjen kuvausprosessi kokonaisuudessaan

Huom. Selkeyden vuoksi tässä vuokaaviokuvauksessa ei ole mukana koodiston hylkäämistä eikä prosessin keskeytymistä tai päättymistä. (Sisällöntuottaja voi tarvittaessa keskeyttää prosessin missä vaiheessa tahansa.)

2 Käyttöoikeudet

Mikäli organisaatio haluaa tuoda koodistonsa Yhteentoimivuusalustalle, mutta ei vielä ole rekisteröitynyt sisällöntuottajaksi eli Yhteentoimivuusalustan käyttäjäksi, on sen ensimmäiseksi haettava alustan käyttöoikeutta VRK:lta eli Yhteentoimivuusalustan tuelta. 

Yhteentoimivuusalustan tuki antaa uudelle sisällöntuottajaorganisaatiolle ohjeistuksen Yhteentoimivuusalustan periaatteista ja yhteistyömallista (hyväksymiskäytännöt yms.)

Tämän jälkeen Yhteentoimivuusalustan tuki antaa käyttöoikeudet sisällöntuottajaorganisaation pääkäyttäjälle, joka puolestaan antaa käyttöoikeuksia oman organisaationsa muille käyttäjille.

Käyttöoikeudet saatuaan sisällöntuottajaorganisaatio pääsee tuottamaan sisältöjä Koodistot-työkalulla, mutta myös muilla Yhteentoimivuusalustan työkaluilla (Tietomallit ja Sanastot).

3 Koodistojen määrittelyosaamisen hankkiminen

Yleensä sisällöntuottajilla on jo valmis koodisto, joka halutaan tuoda Koodistot-työkaluun, mutta koodistoon ehkä halutaan tehdä muokkauksia ja täydennyksiä ennen kuin se julkaistaan Yhteentoimivuusalustalla. Tai usean organisaation yhteenliittymä voi haluta yhdenmukaistaa (harmonisoida) aineistojaan ennen kuin niitä tuodaan Koodistot-työkaluun. Tässä tapauksessa koodistojen sisällön määrittelyyn voidaan tarvita apua ennen kuin koodistot teknisesti siirretään Koodistot-työkaluun. Tai ehkä koodistoja ei vielä ole valmiina, mutta Koodistot-työkalua halutaan käyttää koodiston luonnosten jakelun ja kommentoinnin apuna.

Mikäli sisällöntuottajaorganisaatiolla ei ole kokemusta Koodistot-työkalun käytöstä, sen kannattaa ottaa yhteyttä VRK:n Yhteentoimivuusalustan tukeen ja pyytää apua koodistojen määrittelyyn.

Vuonna 2018 VRK järjestää Yhteentoimivuusalustan ja sen työvälineiden käytöstä koulutusta ja tukee käyttäjiä alustan käytössä, erityisesti teknisissä ongelmissa. Tarvittaessa Yhteentoimivuusalustan tuki auttaa sisällöntuottajaa löytämään sopivia koodistomäärittelyjen osaajia (mm. kuvaa, minkä tyyppistä osaamista näiltä edellytetään).

4 Koodistomäärittelyjen käynnistäminen

Kun sisällöntuottajaorganisaatiolla on koodistojen määrittelyn asiantuntija käytettävissään, varsinainen määrittelytyö alkaa aihealueen eli substanssin asiantuntijoiden nimeämisellä. Nämä asiantuntijat kootaan yhteiseen määrittelysessioon, joissa yhdessä kuvataan koodiston ja siihen kuuluvien koodien ominaisuudet. Määrittelysessioita pidetään tarvittaessa useampikin, eli niin monta kuin tarvitaan koodiston ja siihen sisältyvien koodi(arvoj)en tuottamiseen.

Tarvittaessa myös VRK:n asiantuntijoita voi osallistua mallinnussessioon, sisällöntuottajien itsensä lisäksi. On tärkeää varmistaa määrittelyjen yhdenmukaisuus aiempien koodistojen ja koodistojen määrittelyn periaatteiden kanssa. Laajoja koodistoja määriteltäessä on aiheellista sopia välitarkistuspisteitä asiantuntijoiden kanssa, jotta voidaan varmistaa työn eteneminen sovittujen periaatteiden mukaisesti.

Yhteentoimivuusmenetelmän mukaisessa määrittelytyössä pyritään hyödyntämään (uudelleenkäyttämään) aiemmin määriteltyjä koodistoja mahdollisimman paljon. Näin samoja tietomäärityksiä ei tarvitse tehdä moneen kertaan, vaan voidaan tehdä viittauksia jo aiemmin tehtyihin koodistoihin. Ensimmäinen vaihe siis on tarkistaa, onko jossain jo aiemmin tehty omaan käyttötarpeeseen sopiva koodisto ja hyödyntää sitä sellaisenaan.

• Mikäli täsmälleen omaan tarpeeseen sopivaa koodistoa ei löydy, tarkistetaan, voidaanko jo olemassa olevasta koodistosta hyödyntää jotain osuutta, jolloin tarvitsee määritellä vain siitä puuttuvat osuudet. Tällöin siis tuotetaan olemassaolevasta koodistosta uusi variantti. Koodistojen osalta on muistettava, että yksikin muutos tekee koodistosta variantin, jotta eri koodistojen eheys voidaan varmistaa. Vaikka jokin koodisto poistettaisiin aktiivisesta käytöstä - esimerkiksi koska tästä samasta koodistosta on tuotettu uusi versio - jätetään myös koodiston vanha versio referenssisyistä saataville. (Joskin sen tilakoodi muutetaan

Mikäli mikään aiempi koodisto ei sovellu sisällöntuottajan tarpeisiin, tuotetaan uusi koodisto.

Kun halutut koodit/koodiarvot on määritelty seuraavassa luvussa kuvatulla tavalla, määritellyt koodit (1 - n kpl) kootaan yhteen koodistoksi. Yhteentoimivuusalustan tuki käy läpi tämän koodiston ja tarvittaessa lähettää sen Ydinkoodistoryhmän käsittelyyn -> katso alla luku 6

5 Yksittäisten koodimäärittelyjen tekeminen

Yksittäisenkin koodin muuttaminen valmiista koodistosta merkitsee, että koodistosta syntyy uusi variantti. Tässä luvussa kuvataan yksittäisen koodin määrittelyprosessi. Kun kaikki koodien määrittelyt on tehty, ne kootaan yhteen koodistoksi, joka lähetetään oman tietoalueen koodistoryhmän käsittelyyn (luku 6). 

Koodin määrittelyssä toistuvat seuraavat vaiheet:

1. Löytyykö koodin tietosisällön kuvaamiseen sopiva käsite jossain Sanastot-työkalun sanastossa?
   1. Mikäli sopiva käsite löytyy, se voidaan ottaa koodin määrittelyn pohjaksi. 
      Esimerkki: Julkisen hallinnon yhteisestä sanastosta löytyy käsite Äidinkieli, jonka määritelmä on seuraava: kieli, joka on merkitty väestötietojärjestelmään henkilön kieleksi. Lisäksi määritelmässä on huomautus: Yleiskielessä äidinkielellä tarkoitetaan kieltä, jonka henkilö on oppinut ensimmäisenä ja johon hän samaistaa itsensä.
      Mikäli tämä Julkisen hallinnon yhteisen sanaston määritelmä sopii määrittelijöiden käyttötarkoitukseen, koodin kuvauksessa voidaan viitata tämän käsitteen määritelmään. 
   2. Mikäli sopivaa aiemmin määriteltyä käsitettä ei löydy, sisällöntuottaja määrittelee koodin itse ilman käsiteviittausta
2. Täydennetään koodin kuvaus muilla tarvittavilla metatiedoilla (esimerkiksi viittaukset kansainvälisiin referenssikoodistoihin ym.).
3. Kun kaikki koodimäärittelyt ovat valmiina, lähetetään niistä koostuva koodisto oman tietoalueen koodistotyöryhmän käsittelyyn (luku 6). 

6 Ydinkoodistoryhmän (YKR) käsittely

Koko julkishallinnon yhteinen ydinkoodistotyöryhmä YKR koordinoi kokonaisuutta ja käy läpi sille hyväksyttäväksi toimitetut koodistoehdotukset.

1. KTR tarkistaa ensimmäiseksi, mikä on ehdotetulle koodistolle soveltuvin tietoalue.
   1. Mikäli koodisto on lähetetty käsittelyyn esimerkiksi tietoalueelta A, mutta se tietosisältönsä perusteella sopii paremmin tietoalueelle B, KTR lähettää koodistoehdotuksen saatetietoineen tietoalueelle B, ja jossa sen käsittely alkaa uudelleen -> siirry lukuun 6
   2. Mikäli KTR on sitä mieltä, että koodistoehdotuksella ei ole yleisempää käyttöä sen enempää koko julkisessa hallinnossa kuin millään tietoalueellakaan, se lähettää koodiston kommenttikierrokselle. -> siirry kohtaan KTR-5
2. Mikäli KTR katsoo, että koodistomäärittelyjen läpikäynti on sen vastuulla, se tarkistaa, onko koodiston kuvaus laadittu ohjeiden ja linjausten mukaisesti.
   1. Mikäli koodisto on muodollisesti oikein laadittu, se lähetetään kommenttikierrokselle -> siirry kohtaan  KTR-5
   2. Mikäli koodiston määrittelyssä on korjattavaa, se lähetetään takaisin laatijalleen korjausohjeiden kera, ja koodiston määrittelyprosessi käynnistyy alusta.
3. Kun KTR arvioi, että koodiston käyttöalueena on koko julkishallinto, se ottaa sen omalle vastuulleen eli yleistää koodiston määritelmineen osaksi julkisen hallinnon yhteisiä koodistoja.
   1. Mikäli koodisto tietosisältönsä puolesta kelpaa sellaisenaan, se hyväksytään -> siirry kohtaan KTR-5
4. Tarvittaessa KTR muokkaa koodiston määrittelyä niin, että se soveltuu paremmin koko julkishallinnon käyttöön. 
5. Koodisto lähetetään kommenttikierrokselle.
   Saatujen kommenttien perusteella KTR tekee mahdollisesti tarvittavat muutokset koodistoon. 
6. KTR hyväksyy koodiston ja muuttaa sen tilaksi ”voimassa oleva”. 
7. Mikäli kyseessä on sisällöntuottajan tai tietoalueen koodisto, sen hyväksymisestä ilmoitetaan asianomaiselle sisällöstä vastaavalle organisaatiolle ja KTR:n käsittely päättyy tähän.
   Mikäli kyseessä on julkishallinnon keskeisiin koodistoihin otettava kuuluva koodisto, KTR ilmoittaa sisällöntuottajaorganisaatiolle, että koodisto on hyväksytty muokatussa muodossa  Jatkossa KTR vastaa tämän koodiston ylläpidosta.