Päivitetty prosessikuvaus 30.10.2018 (tämän sivun tekstimuotoinen kuvaus päivitetään myöhemmin vastaamaan tätä prosessia)
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ä. Tässä dokumentissa on kuvattu myös periaatteet, joilla tietoalueet osallistuvat koodistojen hyväksymiseen. Mikäli tietoaluetta ei vielä ole perustettu tai tietoalueen koodistotyöryhmä ei vielä ole toiminnassa, sen vastuulla olevan koodistojen arvioinnin ja hyväksymisen hoitaa Ydinkoodistoryhmä. Ydinkoodistoryhmän on kuitenkin ensisijaisesti tarkoitus olla julkishallinnon koodistotyötä ohjaava ja koordinoiva taho 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. tietoalueiden ja Ydinsanastotyöryhmä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. Koodistoon voi tehdä myös muokkauksia ja täydennyksiä ennen kuin se julkaistaan Yhteentoimivuusalustalla. Usean organisaation yhteenliittymä voi haluta myös 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 viedään ja tallennetaan Koodistot-työkaluun. Tai valmista koodistoa ei ehkä vielä ole, vaan Koodistot-työkalua halutaan käyttää koodiston luonnosten jakelun ja kommentoinnin apuna.
Mikäli sisällöntuottajaorganisaatiolla ei ole kokemusta koodistojen määrittelystä tai Koodistot-työkalun käytöstä, sen kannattaa ottaa yhteyttä ja pyytää tukea VRK:n Yhteentoimivuusalustan tuelta.
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.
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 Yhteentoimivuusalustan tuen asiantuntijoita voi sisällöntuottajien itsensä lisäksi osallistua mallinnussessioon. 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.
Mikäli mikään aiempi koodisto ei sovellu sisällöntuottajan tarpeisiin, tuotetaan uusi koodisto tai uusi koodiston versio. Yksittäisenkin koodin muuttaminen valmiista koodistosta merkitsee, että koodistosta syntyy uusi versio.
Seuraavassa luvussa kuvataan prosessi yksittäisen koodin määrittelemiseksi. Prosessia toistetaan, kunnes kaikki halutut koodit on kuvattu, jolloin ne yhdessä muodostavat koodiston.
Tässä luvussa kuvataan yksittäisen koodin määrittelyprosessi. Kun kaikki koodien määrittelyt on tehty, ne kootaan yhteen koodistoksi, joka lähetetään ydinkoodistoryhmän käsittelyyn (luku 6).
Koodin määrittelyssä toistuvat seuraavat vaiheet:
Koko julkishallinnon yhteinen ydinkoodistoryhmä YKR koordinoi kokonaisuutta ja käy läpi sille hyväksyttäväksi toimitetut koodistoehdotukset.