JHS XXX Koodistot ja luokitukset Versio: 29.8.2011 Luonnos Julkaistu: Voimassaoloaika: toistaiseksi Sisällys 1 Johdanto... 2 1.1 Taustaa... 2 1.2 Suosituksen tavoitteet... 2 2 Soveltamisala... 2 3 Termit ja määritelmät... 3 4 Julkisen hallinnon koodistojen hallintamalli... 4 4.1 Roolit... 4 4.2 Prosessit... 5 5 Opastavat tiedot... 13 6 Liitteet... 14 LIITE 1: JHS Koodistopalvelun käyttötapaukset... 15 LIITE 2: JHS Koodistopalvelun tekninen toteutusmalli... 17 LIITE 3: JHS Koodistopalvelun metatiedot... 19 1/19
1 Johdanto 1.1 Taustaa Julkishallinnon eri organisaatioissa käytetään runsaasti erilaisia koodistoja ja luokituksia. Useat koodistot ovat käytössä koko julkishallinnossa tai tietyllä toimialalla, eli ne ovat yhteisiä eri organisaatioille. Koodistojen yksilöintikäytännöt ja tekniset esitystavat vaihtelevat kuitenkin organisaatioittain, mikä vaikeuttaa organisaatioiden välistä tietojen vaihtoa. Luokitukset on pääsääntöisesti dokumentoitu tekstimuotoisina asiakirjoina, joista luokitusta tarvitsevat tahot voivat ottaa luokitukset omaan käyttöönsä haluamallaan tavalla. Käyttöönotto vaatii kuitenkin luokitusten sisältämien luokitusarvojen manuaalista syöttämistä luokitusta käyttäviin järjestelmiin. Koodistojen linkittämistä tietorakenteisiin, kuten XMLskeemoihin ei ole ohjeistettu, ja siihen sovelletaan useita eri toteutustapoja. Nykyisin useita eri kopiota samasta koodistosta ylläpidetään jollakin tasolla kahdessa tai useammassa eri organisaatioissa, mistä aiheutuu päällekkäistä työtä. Suosituksen antamisen lähtötilanteessa Suomessa ei ole yhteistä keskitettyä julkishallinnon koodistopalvelua, jonka kautta hallinnossa yleisesti käytettävät koodistot olisivat yhdenmukaisella tavalla ylläpidettävissä ja teknisesti suoraviivaisesti hyödynnettävissä. JHS-suositusjärjestelmä suosittelee joitakin koodistoja (esim. JHS 121 Toimialaluokitus), joiden sisältö- ja ylläpitovastuu ovat koodistokohtaisesti aina tietyllä organisaatiolla. Käytännössä useimpia JHS-suositusten kohteena olevia luokituksia hallinnoi Tilastokeskus. Joillakin hallinnonaloilla on perustettu omia koodistopalveluita. Esimerkiksi Terveyden ja hyvinvoinnin laitoksen (THL) ylläpitämä koodistopalvelu sisältää useita koodistoja, joita hyödynnetään sosiaali- ja terveydenhuollon tietojärjestelmissä. THL:n koodistopalvelu sisältää myös koodistoja, joiden ylläpitovastuu on muilla organisaatioilla. THL:n koodistopalvelun hallinta- ja ylläpitoprosessi on yhdenmukaistettu. Ulkoisten tahojen omistamien koodistojen osalta THL laatii sopimukset omistaja- tai hallinnoijatahojen kanssa. 1.2 Suosituksen tavoitteet Suosituksessa kuvataan hallintamalli, jolla julkisen hallinnon toimijoiden käyttämät koodistot ja luokitukset harmonisoidaan semanttiselta sisällöltään ja tekniseltä toteutukseltaan julkaistavaksi JHS Koodistopalvelimella. Koodistojen yhdenmukaisten muodostamis-, ylläpito- ja käyttöprosessien ja keskitetyn teknisen ratkaisun avulla vähennetään päällekkäistä koodistojen hallinnointiin ja käyttöön liittyvää manuaalista työtä eri organisaatioissa. Hallintamallin soveltamisen tueksi on välttämätöntä toteuttaa kansallinen keskitetty ratkaisu koodistojen ylläpitoon ja jakeluun. Koodiston muodostamisprosessin tuloksena harmonisoidut koodistot ja luokitukset julkaistaan JHS Koodistopalvelussa, joka on osa julkisen hallinnon metatietopalvelua ja yhteentoimivuuden tietopankkia. Suosituksen liitteissä on esitetty vaatimusmäärittely JHS Koodistopalvelulle. 2 Soveltamisala Suosituksessa kuvataan koodistojen ja luokitusten muodostamiseen, ylläpitoon ja jakeluun toimintamalli, jossa yksittäisen koodiston tai luokituksen sisältämien koodien tai luokkien nimet perustuvat JHS-sanaston käsitteisiin, mikäli tämä on mahdollista. Suositus muodostaa yhdessä JHS 170- ja JHS 175 -suositusten kanssa kokonaisuuden, jonka pyrkimyksenä on edistää julkisen hallinnon tietojärjestelmien yhteentoimivuutta kokonaisarkkitehtuurin suunnittelun keinoin. JHS Koodistopalveluun suunnitellaan vietäväksi JHS-suositusten sisältämät koodistot ja luokitukset, julkisessa hallinnossa käytettävät asiakirjatyypit sekä muut julkishallinnon tietoarkkitehtuurin kannalta keskeiset koodistot ja luokitukset. 2/19
Suositus koskee sekä yksilöiviä että luokittelevia koodistoja. Yksilöivissä koodistoissa jokaiselle uudelle objektille luodaan oma yksilöivä koodi. Tässä tapauksessa koodiarvo toimii objektin tunnisteena. Luokittelevissa koodistoissa (luokituksissa) objektit pyritään luokittelemaan koodistossa jo olevien koodien (luokkien) avulla. Koodistot voivat olla yksitasoisia tai hierarkkisia. Hierarkkisessa koodistossa koodit muodostavat monitasoisia rakenteita, joissa korkeammalla tasolla olevia koodeja voidaan tarkentaa alemmilla tasolla olevien koodien avulla. Suositus ei kuitenkaan koske ISO OID -yksilöintitunnusten hallintaa, mistä on annettu suositus JHS 159. JHS Koodistopalvelun tekninen toteutus voi kuitenkin tukea myös ISO OID -järjestelmään perustuvien yksilöivien koodistojen tallentamista palveluun. Suosituksen kohderyhmiä ovat julkisen hallinnon tietoarkkitehtuurin ja tietojärjestelmien kehittäjät: julkisen hallinnon yhteisessä tietoarkkitehtuurissa ehdotettu metatietopalvelu ja sitä hallinnoiva toimija. julkisen hallinnon käyttämien koodistojen omistajat. julkisen hallinnon toiminnan ja prosessien kehittäjät. julkisen hallinnon tietojärjestelmien kehittäjät. järjestelmäkehityshankkeiden vetäjät ja asiantuntijat. 3 Termit ja määritelmät Kuva 1. Koodistoon liittyviä termejä sekä JHS Sanaston ja JHS Koodiston välistä suhdetta havainnollistava kuva 3/19
Koodi (code) Tiettyä käsitettä kuvaava objekti, jonka ominaisuuksia ovat mm. koodin nimi ja sen koodiarvo. Koodiarvo (code value) Koodin yksilöivä tunnus. Koodin nimi Koodin selväkielinen nimi. Koodin metatiedot (metadata) Kokoelma yksittäistä koodia kuvaavia tietoja. Koodisto, luokitus (code set, code list, classification) Käsite, joka kuvaa sallituista koodeista ja koodistoon liittyvistä metatiedoista muodostuvaa kokonaisuutta. Koodistotunnus (code set identifier) Koodiston yksilöivä tunnus. Koodiston metatiedot (metadata) Kokoelma yksittäistä koodistoa kuvaavia tietoja. Käsite (concept) Käsite on kielellisen ilmaisun sanan, lauseen tai termin kognitiivinen merkityssisältö. Koodistossa usein koodin nimenä oleva käsite ja sen yksilöivä koodiarvo muodostavat yhden koodin. Sovittu termi Termi, joka on sovittu käytettäväksi tietystä käsitteestä Suomen julkisessa hallinnossa julkaisemalla se kyseistä käsitettä kuvaavan käsiteartikkelin metatietona JHS-metatietorekisterissä.[lähde:JHS175] 4 Julkisen hallinnon koodistojen hallintamalli Tässä luvussa kuvataan julkisen hallinnon koodistojen hallintamalli. Hallintamalli koostuu julkisen hallinnon toimijoiden roolien kuvauksista ja koodistojen muodostamis-, ylläpito- ja käyttöprosesseista. Lisäksi hallintamallissa kuvataan prosesseja ohjaavia linjauksia sekä prosessien toteuttamiseen tarvittavaa teknistä ratkaisua (JHS Koodistopalvelu -tietojärjestelmä). 4.1 Roolit JHS Koodistopalvelun tietosisällön laadun ja ajantasaisuuden hallintaan on suunniteltu keskitetty organisaatio, johon kuuluvat palvelun omistajan lisäksi koodistokohtaiset sidosryhmät. JHS Koodistopalvelun hallintaan liittyvät seuraavat roolit: 1. JHS Koodistopalvelun omistaja Julkisen hallinnon tietoarkkitehtuurin kehittämisestä vastaava organisaatio (valtiovarainministeriö), joka vastaa JHS Koodistopalvelun toteutuksesta, ylläpidosta ja kehittämisestä. 2. JHS Koodistopalvelun johtoryhmä Johtoryhmän muodostavat JHS Koodistopalvelun omistaja (puheenjohtaja) ja palvelun sisältämien koodistojen ja luokitusten omistajat. Johtoryhmä vastaa JHS Koodistopalvelun sisältämien koodistojen käsittelyn ja päätösten kirjaamisesta, julkaistavien koodistojen hyväksymisestä ja 4/19
ylläpidon laadunvarmistuksesta, koodistojen ylläpidon resursseista, palvelun tietosisällön jatkokehittämisestä ja tiedottamisesta. 3. JHS Koodistopalvelun asiantuntijaryhmä Asiantuntijaryhmä muodostuu koodistopalvelun, koodistoteknologioiden ja standardien asiantuntijoista, jotka tukevat johtoryhmän toimintaa ja koodistohankkeita sekä varmistavat julkaistavien harmonisoitujen koodistojen laadun toteutumisen. JHS Koodistopalvelun johtoryhmä nimeää asiantuntijaryhmän. 4. Koodistojen omistajat Koodiston omistaja on organisaatio, jolla on lain ja asetusten tai julkisen hallinnon tietoarkkitehtuurin määritysten mukaan osoitettu vastuu tietyn koodiston tai luokituksen ylläpidosta. Koodiston omistaja vastaa koodiston sisällön ylläpidosta, koodistoa koskevien muutosten tiedottamisesta sidosryhmille ja koodiston käyttöehdoista. 5. Koodistokohtaiset asiantuntijaryhmät Koodistokohtainen asiantuntijaryhmä muodostuu kyseisen koodiston aihepiirin asiantuntijoista, jotka tukevat koodiston tietosisällön ylläpitoa. 6. Aloitteen tekijä JHS Koodistopalvelua tai yksittäistä koodistoa koskevan aloitteen tekijä voi olla kuka tahansa, henkilö tai organisaatio. Aloite voi käsitellä esim. olemassa olevan koodiston tietosisällön muutostarvetta tai uuden koodiston perustamistarvetta. 4.2 Prosessit JHS Koodistopalveluun liittyvät hallinta- ja käyttöprosessit on kuvattu lyhyesti seuraavissa kappaleissa. Pääprosessit ja niiden aliprosessit ovat Koodistojen muodostaminen ja ylläpito, joka muodostuu aliprosesseista - Koodiston tarpeen arviointi ja ehdotuksen laatiminen. - Koodistoehdotuksen käsittely. - Koodiston valmistelu (so. olemassa olevan koodiston harmonisointi JHS Koodistopalvelumuotoon). - JHS Koodistohanke (so. uuden koodiston muodostaminen erillisenä projektina). - Koodiston hyväksyminen ja julkaiseminen. - Koodiston ylläpito. Koodiston käyttö ja käytön tuki 5/19
Kuva 2. JHS Koodistopalvelun hallinnan (koodistojen muodostamisen ja ylläpidon) sekä käytön prosessit 4.2.1 Koodistojen muodostaminen ja ylläpito JHS Koodistopalvelulle on suunniteltu yhteiset toimintaprosessit koodistojen muodostamiseen, ylläpitoon ja käyttöön. Ehdotettu malli perustuu pitkälti THL:n koodistopalvelun 1 käytössä olevaan toimintamalliin. Hallintamallin perustana ovat keskitetyn JHS Koodistopalvelun omistajuus (esim. julkishallinnon tietoarkkitehtuurin kehittämisestä vastaavalla organisaatiolla) sekä palvelussa ylläpidettävien koodistojen ja luokitusten omistajuudet. Omistajatahojen muodostamat toimielimet tarvittavilla koodistoasiantuntijoilla vahvistettuina vastaavat JHS Koodistopalvelun tietosisällön hallinnasta. 4.2.1.1 Koodiston tarpeen arviointi ja ehdotuksen laatiminen Aloitteen tekijä (organisaatio, yksityishenkilö) laatii ehdotuksen tarvittavasta koodistosta JHS Koodistopalvelun asiantuntijaryhmälle käsiteltäväksi. Koodistoehdotuksen tulee täyttää määritellyt sisältövaatimukset, jotta se voidaan ottaa käsittelyyn. 1 THL Koodistopalvelu http://www.thl.fi/fi_fi/web/fi/tutkimus/palvelut/koodistopalvelu 6/19
Kuva 3. JHS Koodistopalvelun prosessit: Koodiston tarpeen arviointi ja ehdotuksen laatiminen Linjauksia: Edellytykset koodiston tai luokituksen liittämiselle JHS Koodistopalveluun ovat: 1. Koodiston tai luokituksen käytölle on olemassa selkeä tunnistettu tarve ja käytön arvioidaan olevan laajaa yli organisaatio- ja toimialarajojen. 2. Koodisto tai luokitus on sisällöltään ja rakenteeltaan laadukas (mm. kattava, täsmällinen, ajantasainen). 3. Koodiston tai luokituksen käyttöehdot mahdollistavat keskitetyn jakelun veloituksetta ja rajoituksetta kaikille julkishallinnon organisaatioille ja sidosryhmille. 4. Koodiston tai luokituksen käyttöönotosta on odotettavissa merkittävää lisäarvoa julkisen hallinnon tietoarkkitehtuurin ja tietojen yhteentoimivuuden edistämiselle. 5. Koodiston tai luokituksen käyttöönotto ei aiheuta haittaa, tai mahdollinen haitta arvioidaan merkittävästi hyötyjä pienemmäksi. 6. Koodiston tai luokituksen omistaja on olemassa tai nimettävissä, eikä omistukseen liity ristiriitoja tai epäselviä vastuita, ylläpidosta on uskottavasti sovittu ja siihen on käytettävissä riittävät resurssit. JHS Koodistopalvelun käytön perusteena voi olla myös julkishallinnon keskitetyn yhteisen teknisen välineen hyödyntäminen ja yhteentoimivuuden edistäminen, vaikka koodistolle ei olisi aluksi nähtävissä laajaa käyttöä. Mikäli organisaation ylläpitämä koodisto täyttää edellä mainitut ehdot, organisaation tulee ehdottaa koodiston (semanttista) harmonisointia ja tallentamista JHS Koodistopalveluun. 7/19
4.2.1.2 Koodistoehdotuksen käsittely JHS Koodistopalvelun asiantuntijaryhmä käsittelee vastaanottamansa koodistoehdotuksen ja arvioi voidaanko sen pohjalta laatia ehdotus JHS Koodistopalvelun johtoryhmälle. JHS Koodistopalvelun johtoryhmä käsittelee koodistoehdotukset ja arvioi, tarvitseeko uuden koodiston muodostamiseksi asettaa erillinen JHS Koodistohanke, vai voidaanko jo olemassa oleva koodisto valmistella (harmonisoida) suoraan koodiston omistajan ja asiantuntijoiden toimesta JHS Koodistopalveluun tuotavaksi. Päätöksestä toimitetaan palaute ja tarvittava toimeksianto sidosryhmille. Kuva 4. JHS Koodistopalvelun prosessit: Koodistoehdotuksen käsittely 4.2.1.3 JHS Koodistohanke JHS Koodistopalvelun johtoryhmän asettama hanke, josta vastaa koodiston (tuleva) omistaja yhdessä tarvittavan asiantuntijatyöryhmän kanssa. Hankkeessa perustetaan ja harmonisoidaan koodisto, joka on tarkoitus viedä osaksi JHS Koodistopalvelua. Hankkeessa ratkaistaan koodiston sisällön lisäksi sen omistajuuteen, hallintaan, kustannuksiin ja käyttöehtoihin liittyvät kysymykset. Hanke toteutetaan erillisenä projektina. 8/19
Kuva 5. JHS Koodistopalvelun prosessit: JHS Koodistohanke 4.2.1.4 Koodiston valmistelu JHS Koodistopalvelun johtoryhmän hyväksymä koodistoehdotus valmistellaan siten, että se täyttää JHS Koodistopalveluun liittämiselle asetetut tekniset ja tietosisällölliset vaatimukset (harmonisointi). Koodistolle määritellään käyttöehdot ja sen sisältö muokataan teknisten määritysten mukaiseksi. Koodistoluonnos toimitetaan JHS Koodistopalvelun asiantuntijaryhmän tarkistettavaksi. Kuva 6. JHS Koodistopalvelun prosessit: Koodiston valmistelu 9/19
Linjauksia: 1. Koodistossa käytettävät käsitteet tulee määritellä suosituksen JHS 175 mukaisesti Julkisessa hallinnossa käytettävien koodistojen ja luokitusten arvoina käytettävät käsitteet ja niitä edustavat termit määritellään JHS-sanastotyöprosessin mukaisesti. Käsitteistön määrittely voi perustua myös kansainväliseen harmonisointityöhön tai standardisointiin. Prosessin lopputuloksena harmonisoidut ydin-, yhteiset ja erikoisalakohtaiset käsitteet tallennetaan JHS-metatietorekisteriin, josta niitä tulee hyödyntää JHS Koodistopalvelussa. 2. Koodistoluonnoksen on noudatettava tämän suosituksen liitteessä 3 esitettyjä metatietovaatimuksia. 4.2.1.5 Koodiston hyväksyminen ja julkaiseminen JHS Koodistopalvelun asiantuntijaryhmä tarkistaa koodistoluonnoksen teknisen laadun ja viimeistelee sen palautekierrokselle. Palautekierroksella sidosryhmät voivat ottaa kantaa koodistoehdotukseen ennen kuin se hyväksytään julkaistavaksi. JHS Koodistopalvelun asiantuntijaryhmä käsittelee vastaanotetut palautteet ja viimeistelee niiden perusteella koodiston JHS Koodistopalvelun johtoryhmän hyväksymiskäsittelyyn. Palautteen perusteella koodistoluonnos voidaan myös tarvittaessa palauttaa koodiston omistajalle uudelleen valmisteltavaksi. JHS Koodistopalvelun johtoryhmä käsittelee luonnoksen ja päättää sen julkaisemisesta. Mikäli koodisto todetaan julkaisukelpoiseksi, toimitetaan päätös koodiston omistajalle ja JHS Koodistopalvelun asiantuntijaryhmälle julkaisutoimenpiteitä varten. Julkaisusta tiedotetaan sidosryhmille. Julkaisemisen jälkeen koodiston omistaja käynnistää koodiston jatkuvan ylläpidon ja muutoshallintamenettelyt. JHS Koodistopalvelun johtoryhmä voi päättää myös, että koodistoluonnos palautetaan koodiston omistajalle uudelleen valmisteltavaksi. 10/19
Kuva 7. JHS Koodistopalvelun prosessit: Koodiston hyväksyminen ja julkaiseminen 4.2.1.6 Koodiston ylläpito Koodiston ylläpito on jatkuvaa toimintaa, josta vastaa koodiston omistaja. Koodiston omistajan tulee käsitellä säännöllisesti koodistoa koskevat kehittämistarpeet ja tehdä tarvittavat päivitykset koodiston sisällön ajantasaisuuden ja käyttökelpoisuuden varmistamiseksi. Aloitteen tekijä (organisaatio, yksityishenkilö, koodistopalvelun sidosryhmä) laatii ehdotuksen koodistoon tarvittavasta päivityksestä. Koodiston omistaja käsittelee säännöllisesti vastaanottamansa ehdotukset ja arvioi koodiston päivitystarpeen. Mikäli päivitys todetaan tarpeelliseksi, koodiston omistaja käynnistää koodiston päivityksen valmistelun asiantuntijatyöryhmän tuella. Koodiston omistaja toimittaa valmistelun tuloksena syntyvän päivitetyn koodistoluonnoksen (uuden version) JHS Koodistopalvelun asiantuntijaryhmän käsiteltäväksi. JHS Koodistopalvelun asiantuntijaryhmä tarkistaa koodistoluonnoksen teknisen laadun ja arvioi tarvitaanko koodiston muutokselle JHS Koodistopalvelun johtoryhmän käsittely. Tekniset korjaukset ja pienet muutokset voidaan asiantuntijaryhmän toimesta hyväksyä suoraan julkaistavaksi. Isommat sisältömuutokset vaativat johtoryhmän käsittelyn. JHS Koodistopalvelun asiantuntijaryhmä toimittaa tarvittaessa koodistoluonnoksen JHS Koodistopalvelun johtoryhmän hyväksymiskäsittelyyn. Julkaisupäätös toimitetaan koodiston omistajalle toimenpiteitä varten. Koodistoluonnos voidaan myös tarvittaessa palauttaa koodiston omistajalle uudelleen valmisteltavaksi. Koodiston poistaminen käytöstä toteutetaan julkaisemalla koodistosta uusi versio, jonka voimassaoloaika asetetaan päättyneeksi. Koodiston omistaja vastaa koodiston muutoksista tiedottamisesta sidosryhmille. 11/19
Kuva 8. JHS Koodistopalvelun prosessit: Koodiston ylläpito 4.2.2 Koodistojen käyttö ja käytön tuki Julkaistut koodistot ja luokitukset ovat saatavilla JHS Koodistopalvelussa. Jokaisella koodistolla on käyttöehdot, joiden mukainen käyttö on sallittua. Koodiston käyttö saattaa olla lakien ja asetusten nojalla pakollista koko julkishallinnossa tai jollakin tietyllä toimialalla. JHS Koodistopalvelun tavoitteena on mahdollistaa koodistojen maksuton ja vapaa käyttöoikeus kaikille käyttäjäryhmille. Koodiston käyttäjän on perehdyttävä käyttöehtoihin ja suunniteltava koodiston tekninen käyttö tarjolla olevien vaihtoehtojen perusteella (esim. on-line- tai eräajopohjainen käyttöyhteys JHS Koodistopalveluun). JHS Koodistopalvelun asiantuntijaryhmä antaa käyttäjätukea koodistopalvelun teknisissä kysymyksissä ja koodiston omistaja koodistokohtaisissa (sisältö)asioissa. JHS Koodistopalvelun tiedotus- ja viestintäpalvelun kautta tiedotetaan sidosryhmille käytettävissä olevista koodistoista. Tiedotus tapahtuu mm. koodistopalvelun verkkosivuilla ja uutiskirjein (rekisteröityneille käyttäjille). Koodiston omistajat tiedottavat kohdennetusti koodistosta ja siinä tapahtuvista muutoksista sidosryhmille. 12/19
JHS Koodistopalvelun käyttäjätuki avustaa koodistojen käyttöönotossa ja käytössä. JHS Koodistopalvelun omistajan toimesta tiedotetaan palvelun kehittymisestä, uusista saatavilla olevista koodistoista ja niiden versioista, sekä esim. mahdollisista palvelukatkoista. JHS Koodistopalvelun tekninen käyttöyhteys voi perustua selainkäyttöiseen yhteyteen (online-selailukäyttö) tai tietojen eräsiirtoihin käyttäjien tietojärjestelmiin. Koodistot on oltava mahdollista kopioida (replikoida) käyttäjän omaan tietojärjestelmään useissa eri esitysmuodoissa (JHS XML -mukainen skeema, Genericode, XML Schema enumeration, RDF, Excel CSV). Kun koodeja käytetään tietojärjestelmissä, on suositeltavaa liittää mukaan koodiston yksilöivä tunnus, jotta voidaan varmasti päätellä mistä koodistosta on kysymys. Erityisen tärkeää tämä on silloin, kun koodattuja tietoja siirretään tietojärjestelmien ja organisaatioiden välillä. JHS Koodistopalvelun teknistä toteutusta ja vaatimuksia on kuvattu liitteissä 2 ja 4. Koodiston käytöstä on laadittu korkean tason prosessikuvaus. Kuva 9. JHS Koodistopalvelun prosessit: Koodiston käyttö ja käytön tuki 5 Opastavat tiedot Tätä suositusta ylläpitää Julkisen hallinnon tietohallinnon neuvottelukunta JUHTA, puh (09) 16001, sähköposti: jhs-sihteeri@jhs-suositukset.fi JHS-järjestelmän verkkosivut: http://www.jhs-suositukset.fi/ 13/19
6 Liitteet Liite 1: JHS Koodistopalvelun käyttötapaukset Liite 2: JHS Koodistopalvelun tekninen toteutusmalli Liite 3: JHS Koodistopalvelun metatiedot Liite 4: JHS Koodistopalvelun vaatimusmäärittely (excel-dokumentti) 14/19
LIITE 1: JHS Koodistopalvelun käyttötapaukset JHS Koodistopalvelun prosessikuvauksista on johdettu seuraavat käyttötapaukset, jotka antavat yleiskuvauksen palvelulta vaadittavasta toiminnallisuudesta. JHS Koodistopalvelun vaatimusmäärittelyssä on kuvattu palvelun toiminnalliset vaatimukset (suosituksen liite 4). 15/19
Kuva. JHS Koodistopalvelun käyttötapaukset 16/19
LIITE 2: JHS Koodistopalvelun tekninen toteutusmalli JHS Koodistopalvelu on sovellus, joka toteuttaa seuraavat perustoiminnallisuudet: Koodistojen hallintaprosessien tuki (koodistojen muodostaminen, ylläpito, käytön tuki). Koodistojen jakelu julkishallinnon organisaatioille ja sidosryhmille valituissa formaateissa. JHS Koodistopalvelu on osa julkisen hallinnon tietoarkkitehtuuria ja osa julkishallinnon metatietopalvelua. JHS Koodistopalvelun tekniikka mahdollistaa kaikkien julkishallinnossa käytössä olevien luokitusten keskitetyn säilyttämisen ja ylläpidon. Lisäksi se tukee yksilöivien koodistojen säilyttämistä ja ylläpitoa. Julkaisukoodien (ISBN ja ISSN) sekä tarkan tason geokoodien (esimerkiksi koordinaatiston perustuvat geokoodit) hallinta on jätetty JHS Koodistopalvelun ulkopuolelle. Koodistopalvelu sisältää linkit muihin metatietopalvelun osiin. Se viittaa esimerkiksi jhsmeta.fi- ja yso.fi -palveluissa oleviin käsitteisiin. Myös jhsmeta.fi-palvelusta voidaan viitata JHS Koodistopalvelussa oleviin koodistoihin XML-elementtien arvojoukkojen rajaamiseksi. JHS Koodistopalvelu on osa julkishallinnon yhteentoimivuusportaalia. Koodistojen tietosisällöissä, muun muassa metatietomallissa, on runsaasti viittauksia koodien ja koodistojen välillä sekä linkkejä palvelun ulkopuolella määriteltyihin käsitteisiin. Tämän takia semanttisen webin teknologioiden hyödyntäminen koodistopalvelun teknisessä toteutuksessa vaikuttaa varteenotettavalta. Koodistopalvelussa olevat koodistot muodostavat käytännössä ontologian, joten koodistopalvelun toteuttaminen ontologioiden kehitys- ja ylläpitojärjestelmien pohjalta on huomionarvoinen toteutusvaihtoehto. Suosituksen liitteessä 4 on koodistopalvelun vaatimusluettelo, joka on laadittu JHS 173 ICT-palvelujen kehittäminen: Vaatimusmäärittely -suosituksen mukaisesti. Liitteessä on esitetty myös koodisto- ja koodikohtaiset metatiedot, käyttäjäroolit, muutoshistoriaan tallennettavat tiedot sekä koodistojen ja koodien käsittelyn tilat. Järjestelmä voidaan karkeasti jakaa kuvassa esitettyihin kokonaisuuksiin. Jaottelu on tehty MVC (Model- View-Controller) -mallin mukaisesti. 17/19
Kuva 1. JHS Koodistopalvelun looginen jäsennys Koodistojen versiointisäännöt Seuraavat toimenpiteet aiheuttavat koodiston version päivityksen: koodiston yksilöivän tunnuksen (URI) muuttaminen. koodiston nimen muuttaminen. koodistossa olevan koodin yksilöivän tunnuksen (URI) muuttaminen. koodistossa olevan koodin koodiarvon muuttaminen. koodin poistaminen koodistosta (koodin voimassaolon päättäminen ei tarkoita koodin poistamista). Muut metatietojen muutokset aiheuttavat ns. minor-version päivityksen. Minor-versio ilmaistaan viimeisen metatietojen päivityksen ajankohdan avulla. Myös uusien koodien lisääminen koodistoon sekä kirjoitusvirheiden korjaaminen johtavat uuteen minor-versioon. 18/19
LIITE 3: JHS Koodistopalvelun metatiedot JHS Koodistopalveluun tallennettavan koodiston tulee noudattaa yhtenäistä metatietojoukkoa koodistolle ja sen sisältämille koodeille. Metatiedot on kuvattu tarkemmin liitteessä 4. Koodiston metatiedot JHS Koodistopalvelussa Koodistokohtainen metatieto Määritelmä yksilöivä tunnus koodiston URI-tunnus nimi koodistoa kuvaava lyhyt, selväkielinen nimi kuvaus koodiston sanallinen kuvailu versio koodiston versionumero viimeinen päivitys koodiston metatietojen viimeisen päivityksen ajankohta voimassaolon alkamisaika ajankohta, jolloin koodisto voidaan ottaa käyttöön voimassaolon päättymisaika ajankohta, jolloin koodiston käyttö tulisi lopettaa käyttöohje koodiston käyttöä tai koodien muodostamista kuvaava ohje käsite koodistoa vastaavan käsitteen URI-tunnus (esim. viittaus jhsmeta.fi- tai yso.fi - palvelun käsiteartikkeliin) kohdealue julkisen hallinnon toiminnallisen kokonaisuuden osa, johon koodisto kuuluu kohdealueen osa-alue julkisen hallinnon toiminnallisen kokonaisuuden osan tarkennus toimintaympäristö konteksti, jossa koodistoa käytetään (kohdealuetta tai sen osaa tarkentava) tarkentaa koodistoa linkki toiseen koodistoon, jota tämä koodisto tarkentaa tila koodiston käsittelyn vaihe (luonnos, ehdotus, palautekierroksella, hyväksynnässä, hyväksytty) huomioitava koodisto linkki toiseen koodistoon, jonka semanttinen merkitys on tämän koodiston merkityksen kannalta huomionarvoinen koodiston lähde koodiston alkuperän kuvaus sitovuustaso koodiston käytön sitovuus omistaja koodiston omistava taho (organisaatio) lukittu kytkin, joka kertoo, voiko koodistoa muokata muu kuin pääkäyttäjä Koodin metatiedot JHS Koodistopalvelussa Koodikohtainen metatieto yksilöivä tunnus koodiarvo nimi kuvaus lyhyt nimi tai lyhenne viimeinen päivitys voimassaolon alkamisaika voimassaolon päättymisaika käyttöohje käsite koodiston yksilöivä tunnus hierarkian taso sisältää merkityksen ei sisällä merkitystä huomioitava koodi sisältää koodiston tila Määritelmä koodin URI-tunnus tunnus, joka yksilöi koodin koodiston sisällä koodia kuvaava selväkielinen nimi koodin sanallinen kuvailu koodia kuvaava lyhyt selväkielinen nimi tai kirjainyhdistelmä koodin metatietojen viimeisen päivityksen ajankohta ajankohta, jolloin koodi voidaan ottaa käyttöön ajankohta, jolloin koodin käyttö tulisi lopettaa koodin käyttöä kuvaava ohje koodistoa vastaavan käsitteen URI-tunnus (esim. viittaus jhsmeta.fi tai yso.fi palvelun käsiteartikkeliin) koodin sisältävän koodiston URI-tunnus sen tason numero, jossa koodi sijaitsee hierarkkisessa koodistossa luokkaan kuuluvien objektien ominaispiirre tai nimi (erityisesti luokittelevissa koodistoissa) luokkaan kuulumattomien objektien ominaispiirteet tai nimet sekä linkki oikeaan luokkaan nimi (erityisesti luokittelevissa koodistoissa) linkki toiseen koodiin, jonka semanttinen merkitys on tämän koodin merkityksen kannalta huomionarvoinen, koodien suhdetta selittävä teksti koodisto, joka sijaitsee hierarkkisessa koodistossa tämän koodin alla koodin käsittelyn vaihe (luonnos, ehdotus, palautekierroksella, hyväksynnässä, hyväksytty) 19/19