Tällä sivulla kuvataan yhteentoimivuusmenetelmän mukainen tapa määritellä ja kuvata koodistoja Koodistot-työkalulla, kun organisaatio (eli sisällöntuottaja) haluaa julkaista koodistojaan myös muiden organisaatioiden tietoon ja hyödynnettäväksi.
Kansallisella tasolla Ydinkoodistoryhmän (YKR) on tarkoitus koodinoida julkishallinnossa tehtävää koodistotyötä. Tavoitteena on edistää eri tahojen tekemää koodistotyötä, välttää päällekkäinen työ ja auttaa eri osapuolia käyttämään Yhteentoimivuusalustan työkaluja sovittujen periaatteiden mukaisesti. Yhteentoimivuusalustan tuki auttaa Ydinkoodistoryhmää tässä työssä mm. antamalla tukea Koodistot-työkalun käytössä ja tekemällä Ydinkoodistoryhmän käsittelyyn tuleville koodistoille teknisluontoiset tarkastukset. Varsinainen sisällön ja substanssin arviointi on Ydinkoodistoryhmän tehtävä. Ydinkoodistoryhmä huolehtii myös siitä, että eri tahojen tarpeet ja näkökulmat otetaan riittävästi huomioon muun muassa kommentointikierrosten avulla.
Tässä dokumentissa on kuvattu periaatteet, joilla Ydinkoodistoryhmä osallistuu koodistojen hyväksymiseen. Sen on tarkoitus toimia samalla periaatteella kuin Ydinsanastoryhmän sanastojen ja Käsitemalliryhmän tietomallien kansallisen tason määrittelytyössä. Ydinkoodistoryhmän on ensisijaisesti tarkoitus olla julkishallinnon koodistotyötä ohjaava ja koordinoiva eikä varsinaista koodistotyötä tekevä taho, vaikka sillä koodistotyön asiantuntemusta onkin.
Alla koodistojen määrittelyn prosessi kokonaisuudessaan (versio 0.95; päivitetty 30.10.2018)
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.)
Mikäli organisaatio haluaa tuoda koodistonsa Yhteentoimivuusalustalle, mutta ei vielä ole rekisteröitynyt sisällöntuottajaksi, on sen ensimmäiseksi haettava alustan käyttöoikeutta VRK:n Yhteentoimivuusalustan tuelta (katso myös Käytön aloittamisen ohjeet).
Yhteentoimivuusalustan tuki antaa uudelle sisällöntuottajaorganisaatiolle ohjeistuksen Yhteentoimivuusalustan periaatteista ja yhteistyömallista (mm. Ydinkoodistoryhmän rooli kokonaisuudessa, 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 halutessaan myös muilla Yhteentoimivuusalustan työkaluilla (Tietomallit ja Sanastot).
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 määrittelyyn voidaan tarvita apua ennen kuin koodistot teknisesti viedään ja tallennetaan Koodistot-työkaluun.
Mikäli sisällöntuottajaorganisaatiolla ei ole kokemusta koodistojen määrittelystä tai Koodistot-työkalun käytöstä, sen kannattaa ottaa yhteyttä ja pyytää opastusta VRK:n Yhteentoimivuusalustan tuelta.
Yhteentoimivuusalustassa koodistot on kytketty johonkin rekisteriin: rekisteri on looginen kokonaisuus, joka sisältää tiettyyn asiayhteyteen liittyviä koodistoja. Ensimmäiseksi sisällöntuottaja tarkistaa, onko Koodistot-työkalussa jo olemassa sopiva rekisteri. Mikäli sopivaa rekisteriä ei löydy, sisällöntuottajan pitää pyytää Yhteentoimivuusalustan tukea perustamaan uusi rekisteri.
Mikäli koodistoon tarvitaan muutoksia tai koodistoa aletaan määritellä alusta alkaen, varsinainen määrittelytyö alkaa aihealueen eli substanssin asiantuntijoiden nimeämisellä. Nämä asiantuntijat kootaan työpajaan, jossa yhdessä kuvataan koodiston ja siihen kuuluvien koodien ominaisuudet. Työpajoja pidetään tarvittaessa useampikin, eli niin monta kuin tarvitaan koodiston ja siihen sisältyvien koodi(arvoj)en tuottamiseen.
On tärkeää varmistaa määrittelyjen yhdenmukaisuus aiempien koodistojen kanssa ja Yhteentoimivuusalustan tietojen uudelleenkäyttöperiaatteen mukaisesti. 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.
Jos sopivaa aiempaa koodistoa ei ole, niin riittääkö entisen oman koodiston päivittäminen? Mikäli tämä sopii, sisällöntuottaja tekee omasta koodistostaan uuden version.
Mikäli Koodistot-työkalusta löytyy lähes tarvetta vastaava koodisto, sisällöntuottaja voi tehdä tämän aiemman koodiston pohjalta uuden koodiston eli variantin.
Mikäli mikään aiempi koodisto ei sovellu sisällöntuottajan tarpeisiin, tuotetaan kokonaan uusi koodisto koodeineen ja koodiarvoineen. Tarvittaessa koodin ja/tai koodiston nimi voidaan linkittää sopivaan Sanastot-työkalun käsitteeseen. Ja jos tarvittava käsite puuttuu, sen voi ehdottaa lisättäväksi sanastoon
Kun koodisto on valmis hyväksyttäväksi, sen tilaksi muutetaan Odottaa hyväksyntää.
Tämän jälkeen Yhteentoimivuusalustan tuki arvioi, onko koodisto teknisesti valmis eli tehty Yhteentoimivuusalustan ohjeiden ja linjausten mukaisesti.
Koko julkishallinnon yhteinen ydinkoodistoryhmä YKR koordinoi kokonaisuutta ja käy läpi sille hyväksyttäväksi toimitetut koodistoehdotukset.