Koodistot-työkalu: Yhteentoimivuusmenetelmän mukainen toimintamalli koodistomäärittelyjen tuottamiseksi

(kesken) LUONNOS

1 Taustaksi

Tällä sivulla kuvataan yhteentoimivuusmenetelmän mukainen tapa toteuttaa koodistojen määrittelyjä ja kuvauksia Koodistot-työkalulla, kun organisaatiolla on tarve hyödyntää tai julkaista tietosisältöjään yli organisaatiorajojen.

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 tietoalueet osallistuvat koodistomäärittelyjen hyväksymiseen. Mikäli tietoaluetta ei vielä ole perustettu/tietoalueen koodistotyöryhmä ei vielä ole toiminnassa, sen vastuulla olevan koodistojen arvioinnin ja hyväksynnän hoitaa toistaiseksi Osaamiskeskus (VRK:n YTI-tiimi). 

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. 

VRK antaa uudelle sisällöntuottajaorganisaatiolle ohjeistuksen Yhteentoimivuusalustan periaatteista ja yhteistyömallista (mm. tietoalueiden rooli kokonaisuudessa, hyväksymiskäytännöt yms.)

Tämän jälkeen VRK 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

Mikäli sisällöntuottajaorganisaatiolla ei ole kokemusta Koodistot-työkalun käytöstä, sen kannattaa ottaa yhteyttä Osaamiskeskukseen ja pyytää tukea koodistojen määrittelyyn.

Osaamiskeskus järjestää Yhteentoimivuusalustan ja sen työvälineiden käytöstä koulutusta ja tukee käyttäjiä alustan käytössä, erityisesti teknisissä ongelmissa. Se myös koordinoi Yhteentoimivuusalustan soveltamista eri tietoalueilla ja tukee niiden välistä yhteistyötä. Tarvittaessa Osaamiskeskus auttaa sisällöntuottajaa löytämään sopivia koodistomäärittelyjen osaajia (mm. kuvaa, minkä tyyppistä osaamista näiltä edellytetään).

Eri tietoalueille on nimetty koodistotyöryhmiä (intressiryhmiä), joiden tehtävänä on tukea oman aihealueensa koodistojen määrittelyä, koodistojen hallinnointia (mm. versiointi) ja oman tietoalueensa organisaatioiden yhteistyötä.

• Käynnistysvaiheessa vuonna 2018 osaamiskeskus järjestää tukea itse koodistojen määrittelyyn, mutta jatkossa opastus ja tuki siirtyy enemmän tietoalueiden vastuulle.

Tarvittaessa osaamiskeskus ottaa yhteyttä asianomaiseen koodistotyöryhmään, jonka tehtävänä on tarjota apua omaan tietoalueeseensa kuuluville toimijoille. Tällaisen koodistotyöryhmän tehtävänä on pitää huolta siitä, että eri toimijat tuottavat tietoalueelle yhdenmukaisia kuvauksia yhteentoimivuusmenetelmän ja koodistojen määrittelyperiaatteiden mukaisesti.

• Osaamiskeskuksen keskeisiä tehtäviä on eri tietoalueiden tekemän työn koordinointi, jotta koodistojen määrittely eri tietoalueilla tehdään yhdenmukaisten periaatteiden mukaisesti ja vältetään päällekkäistä työtä.

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. Määrittelysessioita pidetään tarvittaessa useampikin, eli niin monta kuin tarvitaan koodiston ja siihen sisältyvien koodi(arvoj)en tuottamiseen.

Tarvittaessa myös Osaamiskeskuksen ja tietoalueen koodistotyöryhmän asiantuntijoita voi osallistua mallinnussessioon, sisällöntuottajaorganisaation itsensä lisäksi. On tärkeää varmistaa määrittelytyön yhdenmukaisuus tietoalueen aiempien koodistojen ja koodistojen määrittelyn periaatteiden kanssa. Laajoja koodistoja määriteltäessä on aiheellista sopia välitarkistuspisteitä tietoalueen 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, joka lähetetään tietoalueen koodistotyöryhmä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 Tietoalueen koodistotyöryhmän (TA-KTR) käsittely

Kunkin tietoalueen koodistotyöryhmän vastuulla on tarkastaa sille hyväksyttäväksi toimitetut koodistot.

1. Ensimmäiseksi tarkistetaan, onko koodistoehdotus laadittu ohjeiden ja linjausten mukaisesti.
   1. Mikäli koodisto on muodollisesti oikein laadittu -> siirry kohtaan TA-KTR-2
   2. Mikäli koodistossa on korjattavaa, se lähetetään takaisin laatijalleen korjausohjeiden kera, ja koodistotyöprosessi käynnistyy alusta - tosin sen läpivienti on nopeampaa kuin jos aloitettaisiin täysin alusta.
2. Seuraavaksi koodistotyöryhmä arvioi, onko käsittelyyn toimitetun koodiston tietosisältö määritelty siten, että se on yhdenmukainen tietoalueen muiden määrittelyjen kanssa ja onko tarjotulla koodistolla laajempaakin käyttöä - vai onko se sellainen, jota vain sen oma sisällöntuottajaorganisaatio tarvitsee?
   1. Mikäli koodistomääriykset tietosisältönsä puolesta kelpaavat sellaisinaan, eikä niille todeta tarvetta sisällöntuottajaorganisaationsa ulkopuolella, ne voidaan hyväksyä organisaation sisäiseksi koodistoksi -> siirry kohtaan TA-KTR-6
   2. Mikäli koodistolla arvioidaan olevan käyttöä koko julkishallinnossa tai se vaikuttaa soveltuvan paremmin toiselle tietoalueelle, nämä määrittelyt lähetetään julkishallinnon KTR:n käsittelyyn -> siirry lukuun 7
3. Kun koodistoehdotuksen käsittely jatkuu omalla tietoalueella, TA-KTR arvioi, soveltuuko se tietoalueen käyttöön sellaisenaan vai onko sitä muokattava.
   1. Tarvittaessa TA-KTR muokkaa koodistoa niin, että koodisto soveltuu paremmin koko tietoalueen käyttöön. 
4. Muokattu koodistoehdotus lähetetään kommenttikierrokselle.
   Saatujen kommenttien perusteella tietoalueen koodistotyöryhmä tekee tarvittavat muutokset. (Mikäli muutokset ovat merkittäviä, TA-KTR voi halutessaan lähettää koodistoehdotuksen uudelle kommenttikierrokselle.)
5. Lopuksi tietoalueen koodistotyöryhmä hyväksyy koodiston ja muuttaa sen tilaksi ”Voimassa oleva”.
   (Mikäli koodistoa ei hyväksytä, se palautuu takaisin koodistoprosessiin.)
   Tietoalue (eli koodistotyöryhmä) vastaa tässä yleistämisprosessissa muokattujen tai sellaisinaan hyväksyttyjen, yleistettyjen koodistojen ylläpidosta. Ne koodistot, joita TA-KTR ei katso tarpeellisiksi yleistää, jäävät sellaisinaan edelleen sisällöntuottajaorganisaationsa käyttöön ja vastuulle.
6. Tietoalueen koodistotyöryhmä ilmoittaa sisällöntuottajaorganisaatiolle läpikäytyjen koodistojen hyväksymisestä.
   
   

7 Julkishallinnon koodistotyöryhmän (KTR) käsittely 

Koko julkishallinnon koodistotyöryhmä KTR 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.