VAATIMUSMÄÄRITTELY Terveydenhuollon kansallisen tietojärjestelmäarkkitehtuurin määrittelyprojekti VAATIMUSMÄÄRITTELY --- Versio 1.0 ---
VAATIMUSMÄÄRITTELY i SISÄLLYSLUETTELO 1 JOHDANTO... 1 1.1 Dokumentin tarkoitus... 1 1.2 Määrittelyn kattavuus ja rajaukset... 1 1.3 Lähtökohdat ja riippuvuudet... 1 2 TIETOJÄRJESTELMÄN YLEISKUVAUS... 3 2.1 Tietojärjestelmän tarkoitus... 3 2.2 Tietojärjestelmän sisältö... 4 2.3 Tietojärjestelmän tekninen arkkitehtuuri... 5 3 SIDOSRYHMÄKUVAUS... 7 3.1.1 Yleiskuvaus... 7 3.1.1.1 Tietoja hyödyntävät organisaatiot... 7 3.1.1.2 Tietoja hallinnoivat organisaatiot... 7 4 TOIMINTA- JA TYÖPROSESSIEN KUVAUS... 8 4.1 Ydinprosessit... 8 4.1.1 Koodistopalvelun ylläpitoon ja tietojen selaukseen liittyvät ydinprosessit8 4.1.2 Koodistojen ja toimipaikkarekisterien jakeluun liittyvät ydinprosessit... 8 4.1.3 Koodistojen ja toimipaikkarekisterien suorakäyttöön liittyvät ydinprosessit... 8 4.2 Käyttäjäkuvaukset ja käyttötarinat... 9 4.2.1 Koodiston tietosisältö on julkaistu koodistopalvelussa koodistosta kiinnostunut henkilö haluaa selailla sen tietosisältöä... 9 4.2.2 Koodistopalveluun lisätään uusi koodisto vastuuhenkilö lisää tiedot koodistopalveluun... 9 4.2.3 Koodiston tietosisältö muuttuu vastuuhenkilö päivittää tiedot koodistopalveluun... 9 4.2.4 Uusi koodisto on lisätty koodistopalveluun toimintayksikön vastuuhenkilö päivittää koodiston koodistopalvelusta paikallisiin järjestelmiin... 10 4.2.5 Olemassa oleva koodisto on päivitetty koodistopalveluun automaattipäivitys / toimintayksikön vastuuhenkilö päivittää koodiston muuttuneen sisällön koodistopalvelusta paikallisiin järjestelmiin... 11 4.2.6 Terveydenhuollon toimintayksikön organisaatiorakenne muuttuu toimintayksikön vastuuhenkilö päivittää uuden organisaatiorakenteen kansalliseen koodistopalveluun... 12 4.2.7 Terveydenhuollon toimintayksikön organisaatiorakenne on päivitetty kansalliseen koodistopalveluun automaattipäivitys / toimintayksikön vastuuhenkilö päivittää muuttuneen organisaatiorakenteen koodistopalvelusta paikallisiin järjestelmiin... 12 4.2.8 Järjestelmä on liitetty suorakäytöllä koodistopalveluun järjestelmä pyytää koodistopalvelulta yksittäisen koodiarvon / toimipaikan tietoja. 13 5 TOIMINNALLISUUDEN KUVAUS... 14 5.1 Käyttötapauskaaviot... 14 5.1.1 Koodistojen ja toimipaikkojen päivitys kansalliseen koodistopalveluun 14 5.1.2 Koodistojen ja toimipaikkojen haku kansallisesta koodistopalvelusta.. 15 5.1.3 Koodiarvon tai toimipaikan tietojen suorakäyttö koodistopalvelusta... 16
VAATIMUSMÄÄRITTELY ii 5.2 Käyttötapauskuvaukset... 16 5.2.1 Koodistojen ja toimipaikkojen päivitys kansalliseen koodistopalveluun 16 5.2.2 Koodistojen ja toimipaikkojen haku kansallisesta koodistopalvelusta.. 17 6 VAATIMUSTEN KUVAAMINEN... 18 6.1 Yleiset vaatimukset... 18 6.2 Toiminnalliset vaatimukset... 18 6.3 Arkkitehtuurivaatimukset... 22 6.4 Käytettävyysvaatimukset... 23 6.5 Tietoturvavaatimukset... 23 7 TIETOSISÄLLÖN KUVAUS... 24 7.1 Koodistojen / nimikkeistöjen / luokitusten tunnistetiedot... 24 7.2 Koodistojen / nimikkeistöjen / luokitusten perustiedot... 24 7.3 Koodistojen / nimikkeistöjen / luokitusten lisätiedot... 25 7.4 Palveluyksikön tunnistetiedot... 25 7.5 Palveluyksikön perustiedot... 25 7.6 Palveluyksikön lisätiedot... 26 8 VIITTAUKSET... 28
VAATIMUSMÄÄRITTELY 1 (28) 1 JOHDANTO 1.1 Dokumentin tarkoitus Sosiaali- ja terveysministeriö (STM) on tuottanut terveydenhuollon valtakunnallisen tietojärjestelmäarkkitehtuurin määritysdokumentaation. Kansallisen koodistopalvelun rajapinnan tekninen määritys on osa tätä määrittelydokumentaatiota. 1.2 Määrittelyn kattavuus ja rajaukset Tässä dokumentissa kuvataan lyhyesti kansallinen koodistopalvelu osana KANTA arkkitehtuuria koodistopalvelun näkökulmasta, koodistopalvelun tietosisältö, Web käyttöliittymän ja tiedostosiirtojen kautta tapahtuva koodistojen ylläpito. Tässä vaatimusmäärityksessä keskitytään kuvaamaan koodistopalvelun rooli osana kansallista kokonaisarkkitehtuuria olemassaolevan kansallisen määrityksen ja siihen tehdyn koodistopalvelutoteutuksen pohjalta sekä vaatimukset palvelun kehittämiselle kokonaisarkkitehtuurin tarpeita palvelevalle tasolle. Määrityksessä rajaudutaan käyttötapauksiin, joissa: Terveydenhuollon toimintayksikön pääkäyttäjä on parametrisoinut tietojärjestelmänsä päivittämään muuttuneet koodistot/toimipaikkarekisterit kansalliselta koodistopalvelulta. Tietojärjestelmä hyödyntää päivityksessä kansallisen koodistopalvelun palvelurajapintoja. Terveydenhuollon toimintayksikön tietojärjestelmän/koodistopalvelun pääkäyttäjä päivittää koodistot/toimipaikat kansallisesta palvelusta palvelurajapintoja hyödyntäen tietojärjestelmään toteutetun toiminnallisuuden puitteissa. Toinen kansallinen palvelu kysyy tai validoi koodiarvoa/-arvoja tai toimipaikkatietoja kansalliselta koodistopalvelulta. Tässä on kyseessä koodistopalvelun suorakäyttö. Suorakäyttörajapinnat ovat ainoastaan KANTA palveluun kuuluvien osajärjestelmien käytössä. Määritys esittää lisäksi mahdollisuutena koodiston ylläpidon hajautetut käyttötapaukset. Alueellisen/paikallisen koodistopalvelun vastuuhenkilö toimittaa päivitystä varten alueellisesti/paikallisesti ylläpidetyt koodistot/toimipaikat kansalliselle palvelulle 1.3 Lähtökohdat ja riippuvuudet Kansallisen koodistopalvelun sisällöstä vastaa STAKES. Koodistopalvelun teknisestä toteutuksesta vastaa Kela. Koodistojen ylläpito tullaan todennäköisesti toteuttamaan tapahtuvaksi suoraan kansalliseen koodistopalveluun Web käyttöliittymän tai toimitettavan tiedostomuotoisen latausaineiston pohjalta. Koodistojen ylläpidon oikeudet tulee määrittää koodistokohtaisesti hallinnollisen prosessin mukaisesti.
VAATIMUSMÄÄRITTELY 2 (28) Olemassa oleva koodistopalvelun toteutus antaa mahdollisuuden kansallisen palvelun päivittämiselle alueellisista/paikallista koodistopalveluista tai tietojärjestelmistä käsin. Paikallisten järjestelmien hyödyntämistä kansallisen palvelun päivityksessä ei kuitenkaan nähdä logistisesti järkevänä. Mahdollisuudet on kuitenkin kuvattu tässä määrityksessä. Mahdollisuudet on esitetty tekstillä kursiivilla. Määritys pohjautuu olemassa olevaan kansalliseen määritykseen ja siihen toteutetun koodistopalvelun dokumentaatioon. Ks. Viittaukset. Määritys sisältää olettamuksen, että koodistopalveluun kansallisesti määritellyt rajapinnat tarjoavat toiminnallisesti riittävän palvelutason sekä tietosisällön että toiminnallisuuden näkökulmasta. Suorakäyttörajapinnat avataan tässä määrityksessä vain esimerkinomaisesti.
VAATIMUSMÄÄRITTELY 3 (28) 2 TIETOJÄRJESTELMÄN YLEISKUVAUS 2.1 Tietojärjestelmän tarkoitus Kansallisen koodistopalvelun tehtävänä on tarjota Tietovarasto kansallisesti yhtenäisten sosiaali- ja terveydenhuollon digitaalisissa toimintajärjestelmissä hyödynnettävien termistöjen, nimikkeistöjen, luokitusten ym. koodistojen keskitettyyn hallinnointiin Liittymät em. koodistojen ylläpitoon Liittymät em. koodistojen jakelemiseksi sosiaali- ja terveydenhuollon digitaalisten toimintajärjestelmien käyttöön Potilastietojärjestelmillä tarkoitetaan myöhemmin tässä luvussa terveydenhuollon toimintayksiköissä käytössä olevia koodistopalvelua hyödyntäviä tietojärjestelmiä. Kansallinen koodistopalvelu tarjoaa yhden keskitetyn järjestelmän kautta rakenteisen tiedon kirjaamisessa yhteisesti käytettäväksi sovitut koodistot ja terveydenhuollon organisaatioiden toimipaikkatiedot potilastietojärjestelmille. Palvelun ylläpito tapahtuu joko suoraan koodistopalvelun Web käyttöliittymän kautta tai toimittamalla palvelun sisällölliselle ylläpitäjälle (Stakes) ladattavat koodistot ja toimipaikkatiedot sovitunmuotoisina tiedostoina. Määritys esittää mahdollisuutena kansalliseen koodistopalveluun nähden ulkopuolisesta järjestelmästä palvelurajapintoja hyväksikäyttämällä tapahtuvan päivityksen. Mahdollisuus on esitetty kuvassa katkoviivoituksella.
VAATIMUSMÄÄRITTELY 4 (28) Koodistopalvelun pääasiallinen hyödyntämistapa on ladata koodistot ja toimipaikat potilastietojärjestelmän suorakäyttöä varten terveydenhuollon toimintayksikön tietojärjestelmien omiin tietovarastoihin tai omaan paikalliseen koodistopalveluun. Koodistopalvelu tarjoaa koodistot ja toimipaikkatiedot suorakäyttörajapinnan kautta muille KANTA palvelussa mukana oleville palveluille. KANTA palvelun sisäiset järjestelmät voivat suorakäyttää koodistopalvelua palvelurajapintojen kautta tai replikoida koodistot omiin tietovarastoihinsa vastaavalla tavalla kuin ulkoisten tietojärjestelmien oletetaan tekevän.. Suorakäyttörajapinta on mahdollista tarjota julkisen palvelurajapinnan kautta myös potilastietojärjestelmille, mutta sitä ei suorituskyky- ja käytettävyys- (availability) syistä nähdä järkevänä. Lisäksi potilastietojärjestelmistä käsin tapahtuva kansallisen koodistopalvelun sisällön suorakäyttö aiheuttaisi muutoksia nykyisiin potilastietojärjestelmätoteutuksiin ja hajauttaisi järjestelmän käyttämät koodistot kahteen erilliseen lähteeseen: paikallisiin, järjestelmän omiin koodistoihin, joita ei ole järkevää ylläpitää kansallisessa palvelussa ja kansallisessa palvelussa ylläpidettäviin koodistoihin. Paikallisten tietojärjestelmien ja kansallisen palvelun välissä voi olla paikallinen/alueellinen koodistopalvelu, jolla esim. hallinnoidaan koodistoja, joilla on yksittäistä järjestelmää laajempaa merkitystä, mutta joita ei kuitenkaan ole tarpeen hallinnoida kansallisen palvelun tasolla. Sanomaliikenteessä osapuolet tunnistetaan osapuolitunnuksilla (OID). Sanomaliikenteen osapuoli on osa jotain sosiaali- tai terveydenhuollon organisaatiota. Sanomaliikenteessä osapuolet tarjoavat erilaisia palveluita ja palveluilla on myös tunnus (OID-koodi + mahdollinen tarkennetieto). Osapuolten tarjoamat palvelut ovat lopulta jossain "fyysisessä" osoitteessa (URL). Koodistopalvelu voi toimia myös KANTA-arkkitehtuurin palveluhakemistona, jossa hallinnoidaan KANTA-palvelun ja potilastietojärjestelmien välisessä liikennöinnissä tarvittavia sosiaali- ja terveydenhuollon palveluiden osoitteita. Ko. palveluosoitteet voidaan esittää koodistopalvelussa toimipaikkojen ominaisuuksina. Koodistopalvelun käyttö palveluhakemistona edellyttää koodistopalvelulta kappaleessa 5.2. kuvattujen toiminnallisten vaatimusten täyttämistä. 2.2 Tietojärjestelmän sisältö Ajantasaiset tiedot ja tietosisällöt koodistopalvelun tuotantopalvelimen osalta ovat saatavissa osoitteesta http://kopa.stakes.fi/codeserver_tuotanto. Ajantasaiset tiedot ja tietosisällöt testipalvelimen osalta ovat saatavissa osoitteesta http://kopa.stakes.fi/codeserver. Koodistopalvelun sisältöä ja sen kehittämistarpeita on kuvattu viitteessä: Koodistopalvelu potilaskertomuksen ydintietojen kannalta, Jorma Komulainen, 4.9.2006. (ppt). On todettava, että useita koodistoja tulisi virallistaa testipalvelimelta tuotantopalvelimelle. Osa sähköisen potilaskertomuksen ydintietojen vaatimista koodistoista ei ole käytettävissä edes testipalvelimella. Uusien koodistojen vieminen tuotantopuolelle edellyttää kuitenkin hyväksymismenettelyn vahvistamista ja proses-
VAATIMUSMÄÄRITTELY 5 (28) sin kuvaamista ja rakentamista näiden koodistojen teknisen laadun varmistamiseen ja ylläpitoon. Kansallisen koodistopalvelun sisältö laajenee kansallisesti yhtenäistettyjen koodistojen joukon laajentuessa. Tällä hetkellä on tunnistettu sisällön laajentamistarpeeksi ainakin Toimipaikkarekisteri Koodistopalvelimen tietosisällön laajentaminen siten, että KANTA- palveluiden ja potilastietojärjestelmien välisen viestiliikenteen reitityksessä hallinnoitavat palveluosoitteet voidaan tallentaa toimipaikkojen ominaisuuksina. 2.3 Tietojärjestelmän tekninen arkkitehtuuri Kansallinen koodistopalvelu toteutetaan osaksi kansallista arkkitehtuuria seuraavan teknisen arkkitehtuurikuvauksen mukaisesti. Kansallisen koodistopalvelun Web -käyttöliittymä on nykymallissa määritelty julkiseksi http palveluksi. Koodistojen ylläpito edellyttää ja haku tiedostolatausta käyttäen ei edellytä kirjautumista palveluun (käyttäjätunnus/salasana). Yhteyden salaamiselle (https) ei ole perusteita, koska koodistot/toimipaikat ovat myös julkisesti selattavissa palvelulta ilman sisäänkirjausta. Kansallisen koodistopalvelun palvelurajapintojen tekninen arkkitehtuuri on noudatettava viestinvälitys osaprojektissa määriteltyä arkkitehtuuriratkaisua. Esitetystä arkkitehtuurista seuraa nykytoteutukselle seuraavia muutostarpeita:
VAATIMUSMÄÄRITTELY 6 (28) Rajapintapalvelut toteutetaan varmennettuina, synkronisina Web Service palveluina kansallisen palveluväylän taakse. Tietoliikenneadapterien väliseksi suunniteltu sanomanvälitys on kehitettävä yhteensopivaksi muun kansallisen viestinvälityksen kanssa. Sanomanvälityksessä tulee ottaa käyttöön HL7 V3 siirtokehykset. Olemassa olevat XML muotoiset sanomat voidaan lisätä siirtokehykseen standardissa määritellyllä tavalla. Ylimääräiset, olemassa olevat siirtokehykset tulee riisua pois, jotta siirrettävän datan määrä ei kasva turhaan eikä kutsuvaan päähän tarvitse rakentaa niille tukea. Suurien koodistojen (Esim. ICD-10) siirtosanomista muodostuu erittäin isoja ja raskaita palveluja. Raskaiden palveluiden suorituskyky ja koodistopalvelulle aiheuttama kuormitus tulee ottaa huomioon toteutuksen yhteydessä. Toteutuksessa tulee ottaa huomioon mahdollisuus myös rajattujen koodijoukkojen siirtoon, esim. tietyn päivän jälkeen muuttuneet koodit.
VAATIMUSMÄÄRITTELY 7 (28) 3 SIDOSRYHMÄKUVAUS 3.1.1 Yleiskuvaus 3.1.1.1 Tietoja hyödyntävät organisaatiot Koodistopalvelun hyödyntäjiä ovat sosiaali- ja terveydenhuollon toimintayksikköjen potilastietojärjestelmät ja mahdolliset alueelliset/paikalliset koodistopalvelut, jotka päivittävät koodistoja omiin tietovarastoihinsa kansalliselta koodistopalvelulta. Toisen hyödyntäjäryhmän muodostavat kokonaisarkkitehtuuriin tukeutuvat kansalliset palvelut, kuten viestinvälitys-, arkistointi- ja suostumusten hallintapalvelu. Lisäksi tietoja hyödyntävät paikallisten koodistopalvelujen vastuuhenkilöt ja terveydenhuollon sovellusten kehittäjät (Web-käyttöliittymä). 3.1.1.2 Tietoja hallinnoivat organisaatiot Koodistopalvelun sisällöstä vastaa Stakes. Koodistojen tuottajia ovat Stakes, Suomen Kuntaliitto, HL7 Finland ry ja Kustannus Oy Duodecim. Koodistojen osalta muut mahdolliset ylläpitotahot (mm. tekniset koodistot) tulee määrittää ja sopia koodistokohtaisesti erikseen. Terveydenhuollon palveluntuottajat (sairaanhoitopiirit, kunnat) vastaavat omien toimipaikkarekisteriensä ylläpidosta ja toimittamisesta kansalliseen koodistopalveluun, jossa Stakes vastaa organisaatiorekisterin ylläpidosta. KELA vastaa koodistopalvelun teknisestä toteutuksesta ja teknisestä jakelulogistiikasta.
VAATIMUSMÄÄRITTELY 8 (28) 4 TOIMINTA- JA TYÖPROSESSIEN KUVAUS 4.1 Ydinprosessit Kansallinen koodistopalvelu esittää toimipaikkarekisterit yhtenä koodiston erikoistapauksena. Toimipaikkojen käsittelyn ydinprosessit ovat täysin identtiset koodistojen käsittelyn kanssa. 4.1.1 Koodistopalvelun ylläpitoon ja tietojen selaukseen liittyvät ydinprosessit Koodistopalvelun ylläpitoon ja tietojen selaukseen liittyvät ydinprosessit ovat: Koodistojen katselun ydinprosessit Koodistosta kiinnostunut taho haluaa selailla koodiston tietosisältöä. Koodistojen ylläpidon ydinprosessit Koodiston sisällöstä ja ylläpidosta vastaava taho lisää uuden koodiston tiedot palveluun käyttöliittymän avulla. Koodiston sisällöstä ja ylläpidosta vastaava taho päivittää koodiston tiedot palveluun käyttöliittymän avulla. 4.1.2 Koodistojen ja toimipaikkarekisterien jakeluun liittyvät ydinprosessit Koodistopalvelun käyttöön liittyvät ydinprosessit ovat: Koodistojen ja toimipaikkojen jakelun ydinprosessit Koodiston hyödyntäjä hakee tiedot palvelulta Web käyttöliittymän kautta ja tallentaa ne sovitunmuotoisena tiedostoina omalle palvelimelleen. Koodistojen ja toimipaikkojen jakelun palvelurajapintojen ydinprosessit KANTA -palveluun nähden ulkoinen järjestelmä kysyy koodiston muuttuneen sisällön palvelulta KANTA -palveluun nähden ulkoinen järjestelmä kysyy koodiston koko sisällön palvelulta 4.1.3 Koodistojen ja toimipaikkarekisterien suorakäyttöön liittyvät ydinprosessit Toimipaikkojen ja koodiarvojen suorakäytön KANTA palveluun kuuluvien järjestelmien sisäiset ydinprosessit Sisäinen järjestelmä kysyy yksittäisen koodiston yksittäisen koodiarvon / toimipaikan tiedot palvelulta
VAATIMUSMÄÄRITTELY 9 (28) Sisäinen järjestelmä tarkistaa yksittäisen koodiston yksittäisen koodiarvon / toimipaikan tiedot palvelulta 4.2 Käyttäjäkuvaukset ja käyttötarinat 4.2.1 Koodiston tietosisältö on julkaistu koodistopalvelussa koodistosta kiinnostunut henkilö haluaa selailla sen tietosisältöä Koodistoa ylläpidetään kansallisessa koodistopalvelussa. Koodistosta kiinnostunut henkilö ottaa yhteyden kansallisen koodistopalvelun Web liittymään julkisen internetin kautta. Koodistot ja niiden koodiarvot on selailtavissa ilman kirjautumista. 4.2.2 Koodistopalveluun lisätään uusi koodisto vastuuhenkilö lisää tiedot koodistopalveluun Koodistopalvelun tietosisällön hallinnoija on sopinut tietyn uuden koodiston ylläpidosta vastuutahon kanssa. Koodistoa ei ole aikaisemmin ylläpidetty kansallisessa palvelussa. Koodiston lisäys annetaan toimeksiantona vastuuhenkilölle. Vastuuhenkilö generoi koodistolle OID tunnuksen oman vastuutahonsa numeroavaruudesta, varmistaa OID-tunnusten ristiriidattomuuden ja selvittää koodiston tulevan tietosisällön. Vastuuhenkilöllä on kaksi tapaa lisätä uusi koodisto kansalliselle koodistopalvelulle. 1. Vastuuhenkilö kirjautuu kansallisen koodistopalvelun Web käyttöliittymään omilla tunnuksillaan (käyttäjätunnus/salasana) ja lisää tiedot suoraan järjestelmään. 2. Koodiston sisällön vastuuhenkilö päivittää tiedot tiedostoon kansallisen palvelun tukemassa formaatissa. Vastuuhenkilö lähettää tiedot päivitettäväksi kansallista palvelua hallinnoivalle taholle (Kela). Koodiston ylläpidosta vastaava henkilö lataa muuttuneen koodiston kansalliseen koodistopalveluun käyttäen palveluun toteutettuja ominaisuuksia. 4.2.3 Koodiston tietosisältö muuttuu vastuuhenkilö päivittää tiedot koodistopalveluun Koodistopalvelun tietosisällön hallinnoija on sopinut tietyn koodiston ylläpidosta vastuutahon kanssa. Vastuutaho tunnistaa tarpeen tietosisällön muuttamiselle ja tekee päätöksen koodiston päivittämisestä. Päivittäminen annetaan toimeksiantona vastuuhenkilölle.
VAATIMUSMÄÄRITTELY 10 (28) Vastuuhenkilöllä on kolme tapaa päivittää muutokset kansalliseen koodistopalveluun. 1. Vastuuhenkilö kirjautuu kansallisen koodistopalvelun Web käyttöliittymään omilla tunnuksillaan (käyttäjätunnus/salasana) ja päivittää tiedot suoraan järjestelmään. Myös yksittäisen koodin tietojen päivittäminen Web-liittymän kautta on mahdollista. 2. Koodiston sisällön vastuuhenkilö päivittää tiedot tiedostoon kansallisen palvelun tukemassa formaatissa. Vastuuhenkilö lähettää tiedot päivitettäväksi kansallista palvelua hallinnoivalle taholle (Kela). Koodiston ylläpidosta koodistopalvelussa vastaava henkilö lataa muuttuneen koodiston kansalliseen koodistopalveluun käyttäen järjestelmään toteutettuja ominaisuuksia. 3. Vastuuhenkilö päivittää tiedot alueelliselle/paikalliselle tietojärjestelmälle ja lähettää sovelluksella tiedot päivitettäväksi kansalliselle koodistopalvelulle. Paikallinen tietojärjestelmä ottaa varmennetun yhteyden palvelurajapintojen kautta kansalliseen palveluun ja siirtää muuttuneen sisällön HL7 V3- sanomana. Kansallinen koodistopalvelu käsittelee saamansa sanoman, lataa tiedot omiin rekistereihinsä ja lähettää kuittauksen kutsuvalle järjestelmälle. 4.2.4 Uusi koodisto on lisätty koodistopalveluun toimintayksikön vastuuhenkilö päivittää koodiston koodistopalvelusta paikallisiin järjestelmiin Terveydenhuollon toimintayksikön koodistoista vastaava tekninen yhdyshenkilö saa tiedon kansalliseen koodistopalveluun lisätystä uudesta koodistosta. Koodistoista vastaava yhdyshenkilö tietää osan omista tietojärjestelmistään tarvitsevan kyseistä koodistoa. Yhdyshenkilöllä on kaksi tapaa päivittää muutokset kansalliselta koodistopalvelulta omiin tietojärjestelmiinsä. Käytettävä tapa riippuu vastaanottavan tietojärjestelmän kyvystä ladata tiedot omiin rekistereihinsä. 1. Yhdyshenkilö hakee koodiston tietosisällön suoraan omaan tietojärjestelmäänsä käyttäen järjestelmään toteutettua toiminnallisuutta päivittää tiedot kansalliselta koodistopalvelulta. Tietojärjestelmä ottaa varmennetun yhteyden kansalliseen koodistopalveluun palvelurajapintojen kautta. Koodistopalvelu muodostaa päivitettävästä koodistosta XML-sanoman ja palauttaa sen kutsuvalle tietojärjestelmälle. Kutsuva järjestelmä käsittelee saamansa sanoman ja lataa koodiston tiedot omiin rekistereihinsä. Lopuksi yhdyshenkilö parametroi koodiston päivitettäväksi jatkossa automaattisesti kansalliselta koodistopalvelulta. (Vrt. automaattiset virustietokantojen päivitykset)
VAATIMUSMÄÄRITTELY 11 (28) 2. Vastuuhenkilö kirjautuu kansallisen koodistopalvelun Web käyttöliittymään ja hakee koodiston tietosisällön omalle palvelimelleen kansallisen koodistopalvelun Web käyttöliittymää hyväksikäyttäen. Koodistopalvelu tallentaa tiedot CSV, XML, SAS tai Excel formaateissa palvelimelle. Vastuuhenkilö lataa tiedot halutusta formaatista tietojärjestelmän rekisteriin käyttäen tietojärjestelmän tarjoamia ominaisuuksia. 4.2.5 Olemassa oleva koodisto on päivitetty koodistopalveluun automaattipäivitys / toimintayksikön vastuuhenkilö päivittää koodiston muuttuneen sisällön koodistopalvelusta paikallisiin järjestelmiin Terveydenhuollon toimintayksikön koodistoista vastaava tekninen yhdyshenkilö saa tiedon muutoksista kansallisen koodistopalvelun tietyn koodiston tietosisällössä. Koodistoista vastaava yhdyshenkilö tietää osan omista tietojärjestelmistään tarvitsevan kyseistä koodistoa ja haluaa päivittää muuttuneet tiedot järjestelmiin. Yhdyshenkilöllä on kolme tapaa päivittää muutokset kansalliselta koodistopalvelulta omiin tietojärjestelmiinsä. Käytettävä tapa riippuu vastaanottavan tietojärjestelmän kyvystä ladata tiedot omiin rekistereihinsä. 1. Vastuuhenkilö on uuden koodisto lisäyksen yhteydessä parametroinut tietojärjestelmänsä tekemään automaattisesti koodiston päivitykset kansalliselta palvelulta. Tietojärjestelmä päivittää muuttuneen tietosisällön määräajoin kansalliselta koodistopalvelulta ottamalla varmennetun yhteyden palveluun palvelurajapintojen kautta. Kansallinen palvelu muodostaa päivitettävästä koodistosta HL7 V3 sanoman ja palauttaa sen kutsuvalle tietojärjestelmälle. Kutsuva järjestelmä käsittelee saamansa sanoman ja lataa koodiston tiedot omiin rekistereihinsä. 2. Vastuuhenkilö hakee koodiston muuttuneen tietosisällön suoraan omaan tietojärjestelmäänsä käyttäen järjestelmään toteutettua ominaisuutta päivittää tiedot kansalliselta koodistopalvelulta. Tietojärjestelmä ottaa varmennetun yhteyden kansalliseen koodistopalveluun palvelurajapintojen kautta. Koodistopalvelu muodostaa päivitettävästä koodistosta HL7 V3 sanoman ja palauttaa sen kutsuvalle tietojärjestelmälle. Kutsuva järjestelmä käsittelee saamansa sanoman ja lataa koodiston tiedot omiin rekistereihinsä. 3. Vastuuhenkilö kirjautuu kansallisen koodistopalvelun Web käyttöliittymään ja hakee koodiston muuttuneen tietosisällön omalle palvelimelleen kansallisen koodistopalvelun Web käyttöliittymää hyväksikäyttäen. Koodistopalvelu tallentaa tiedot CSV, XML, SAS tai Excel formaatissa palvelimelle. Vastuuhenkilö lataa tiedot halutusta formaatista tietojärjestelmän rekisteriin käyttäen tietojärjestelmän tarjoamia ominaisuuksia.
VAATIMUSMÄÄRITTELY 12 (28) 4.2.6 Terveydenhuollon toimintayksikön organisaatiorakenne muuttuu toimintayksikön vastuuhenkilö päivittää uuden organisaatiorakenteen kansalliseen koodistopalveluun Terveydenhuollon toimintayksikössä tehdään organisatorisia muutoksia, jotka vaikuttavat toimintayksikön kansalliselle koodistopalvelulle julkaistuun organisaatiorakenteeseen. Toimintayksikön toimipaikkarekisteristä vastaava henkilö saa toimeksiannon päivittää muuttuneet tiedot kansalliselle koodistopalvelulle. Vastuuhenkilöllä on kolme tapaa päivittää muutokset kansalliselle koodistopalvelulle. 1. Vastuuhenkilö kirjautuu kansallisen koodistopalvelun Web käyttöliittymään omilla tunnuksillaan (käyttäjätunnus/salasana) ja päivittää tiedot suoraan järjestelmään. 2. Vastuuhenkilö päivittää tiedot tiedostoon kansallisen koodistopalvelun tukemassa formaatissa. Vastuuhenkilö lähettää tiedot päivitettäväksi kansallista palvelua hallinnoivalle taholle (Kela). Koodiston ylläpidosta koodistopalvelussa vastaava henkilö lataa muuttuneen koodiston kansalliseen koodistopalveluun käyttäen järjestelmään toteutettuja ominaisuuksia. 3. Vastuuhenkilö päivittää tiedot alueelliselle/paikalliselle tietojärjestelmälle ja lähettää sovelluksella tiedot päivitettäväksi kansalliselle palvelulle. Paikallinen tietojärjestelmä ottaa varmennetun yhteyden palvelurajapintojen kautta kansalliseen koodistopalveluun ja siirtää muuttuneen sisällön HL7 V3 -sanomana. Kansallinen koodistopalvelu käsittelee saamansa sanoman ja lataa tiedot omiin rekistereihinsä. Toteutuksen on mahdollistettava myös käyttötapaus, jossa päivitettävät tiedot tulevat voimaan ja lakkaavat olemasta voimassa Voimassaolo alkaa ja Voimassaolo päättyy -päivämäärien mukaisina hetkinä, jotka ovat tulevaisuudessa. Käyttötapaus vahvistaisi mahdollisuuden ennakoivaan päivitykseen. 4.2.7 Terveydenhuollon toimintayksikön organisaatiorakenne on päivitetty kansalliseen koodistopalveluun automaattipäivitys / toimintayksikön vastuuhenkilö päivittää muuttuneen organisaatiorakenteen koodistopalvelusta paikallisiin järjestelmiin Tilanne 1. Terveydenhuollon toimintayksikön toimipaikkarekistereistä vastaava tekninen yhdyshenkilö on juuri päivittänyt oman toimintayksikkönsä tiedot kansalliseen palveluun ja haluaa siirtää muutokset myös muihin oman toimintayksikkönsä tietojärjestelmiin. Tilanne 2. Terveydenhuollon toimintayksikön toimipaikkarekistereistä vastaava tekninen yhdyshenkilö saa tiedon muutoksista kansallisen koodistopalvelun toimipaikkarekisterin tietosisällössä. Yhdyshenkilö tietää osan omista tietojärjestelmis-
VAATIMUSMÄÄRITTELY 13 (28) tään tarvitsevan toimipaikkatietoja ja haluaa päivittää muuttuneet tiedot järjestelmiin. Yhdyshenkilöllä on kolme tapaa päivittää muutokset kansalliselta koodistopalvelulta omiin tietojärjestelmiinsä. Käytettävä tapa riippuu vastaanottavan tietojärjestelmän kyvystä ladata tiedot omiin rekistereihinsä. 1. Vastuuhenkilö on parametroinut tietojärjestelmänsä tekemään automaattisesti toimipaikkarekisterin päivitykset kansalliselta palvelulta. Tietojärjestelmä päivittää muuttuneen tietosisällön määräajoin kansalliselta koodistopalvelulta ottamalla varmennetun yhteyden palveluun palvelurajapintojen kautta. Kansallinen palvelu muodostaa päivitettävästä toimipaikkarekisteristä HL7 V3 sanoman ja palauttaa sen kutsuvalle tietojärjestelmälle. Kutsuva järjestelmä käsittelee saamansa sanoman ja lataa koodiston tiedot omiin rekistereihinsä. 2. Vastuuhenkilö hakee toimipaikkarekisterin muuttuneen tietosisällön suoraan omaan tietojärjestelmäänsä käyttäen järjestelmään toteutettua ominaisuutta päivittää tiedot kansalliselta koodistopalvelulta. Tietojärjestelmä ottaa varmennetun yhteyden kansalliseen koodistopalveluun palvelurajapintojen kautta. Koodistopalvelu muodostaa päivitettävästä koodistosta HL7 V3 -sanoman ja palauttaa sen kutsuvalle tietojärjestelmälle. Kutsuva järjestelmä käsittelee saamansa sanoman ja lataa tiedot omiin rekistereihinsä. 3. Vastuuhenkilö kirjautuu kansallisen koodistopalvelun Web käyttöliittymään omilla tunnuksillaan (käyttäjätunnus/salasana) ja hakee toimipaikkarekisterin muuttuneen tietosisällön omalle palvelimelleen. Koodistopalvelu tallentaa tiedot CSV, XML, SAS tai Excel formaateissa palvelimelle. Vastuuhenkilö lataa tiedot halutusta formaatista tietojärjestelmän rekisteriin käyttäen tietojärjestelmän tarjoamia mahdollisuuksia. 4.2.8 Järjestelmä on liitetty suorakäytöllä koodistopalveluun järjestelmä pyytää koodistopalvelulta yksittäisen koodiarvon / toimipaikan tietoja. KANTA palvelun sisäinen tietojärjestelmä on liitetty suorakäytöllä koodistopalveluun. Tietojärjestelmän tarvitessa koodi/toimipaikkatietoja tietojen tarkistukseen se ottaa yhteyttä koodistopalveluun suorakäyttörajapintoja hyödyntäen.
VAATIMUSMÄÄRITTELY 14 (28) 5 TOIMINNALLISUUDEN KUVAUS 5.1 Käyttötapauskaaviot Tässä luvussa kuvataan vain palvelurajapintojen käyttöön liittyvät käyttötapaukset. Nämä käyttötapaukset perustuvat STAKESin omistaman koodistopalvelun olemassa oleviin käyttötapauksiin. Olemassa oleva toteutus käsittelee toimipaikkarekisteriä yhtenä koodiston erikoistapauksena. Käyttötapaukset on kuvattu manuaalisina käyttäjien käynnistäminä käyttötapauksina. Koodistopalveluiden väliset ja tietojärjestelmien kautta tapahtuvat päivitykset tulee hyödyntävissä tietojärjestelmissä toteuttaa myös automaattisina, tietyn väliajoin käynnistyvinä taustapäivityksinä. 5.1.1 Koodistojen ja toimipaikkojen päivitys kansalliseen koodistopalveluun Viestinvälitysrajapinta - Palveluväylä Tietojen ylläpitoon liittyvät rajapinnat tulee nähdä mahdollisuuksina. Ne eivät kuulu kansalliselle koodistopalvelulle ensimmäisessä vaiheessa asetettaviin vaatimuksiin. Ne voidaan toteuttaa järjestelmiin myöhemmin.
VAATIMUSMÄÄRITTELY 15 (28) 5.1.2 Koodistojen ja toimipaikkojen haku kansallisesta koodistopalvelusta
VAATIMUSMÄÄRITTELY 16 (28) 5.1.3 Koodiarvon tai toimipaikan tietojen suorakäyttö koodistopalvelusta Tietojen suorakäyttöön liittyvät olemassa olevat rajapinnat ovat natiiveja toteutuksia. Käyttötapauksia ei näiltä osin ole kuvattu. Viestinvälitysrajapinta - Palveluväylä 5.2 Käyttötapauskuvaukset 5.2.1 Koodistojen ja toimipaikkojen päivitys kansalliseen koodistopalveluun Käyttäjällä on tarve päivittää kansalliseen koodistopalveluun koodistoja tai toimipaikkoja joko paikallisesta koodistopalvelusta tai omasta tietovarastosta. Tämä tapahtuu sanomapohjaisen koodistojen ja toimipaikkojen päivitysrajapinnan välityksellä. Käyttäjä käynnistää koodiston ja toimipaikkojen päivityspalvelun, johon syötteiksi tulee haluttu koodiston/koodistojen OID-koodit tai toimipaikkojen koodiston OID-koodi. Lisäsyötteeksi käyttäjä voi antaa myös tapahtumahetken, jos käyttäjä haluaa päivittää määrätyn tapahtumahetken jälkeen voimaan tulleet koodistojen koodit/toimipaikat. Koodistojen/toimipaikkojen päivityspyynnön voi suorittaa myös ilman koodisto / päivämäärä rajauksia, jos käyttäjä haluaa päivittää kaikki koodistot/toimipaikat. Käyttäjä saa paluusanomassa tiedon päivityksen onnistumisesta.
VAATIMUSMÄÄRITTELY 17 (28) 5.2.2 Koodistojen ja toimipaikkojen haku kansallisesta koodistopalvelusta Käyttäjällä on tarve hakea kansallisesta koodistopalvelusta koodistoja tai toimipaikkoja ja päivittää niitä koodistorekisteriin tai toimipaikkarekisteriin joko paikalliseen koodistopalveluun tai omaan tietovarastoon. Tämä tapahtuu sanomapohjaisen kyselyrajapinnan välityksellä. Käyttäjä käynnistää koodiston ja toimipaikkojen hakupalvelun, johon syötteiksi tulee haluttu koodiston/koodistojen OID-koodit tai toimipaikkojen koodiston OID-koodi. Lisäsyötteeksi voi käyttäjä antaa myös tapahtumahetken, jos käyttäjä haluaa määrätyn tapahtumahetken jälkeen muuttuneet tai voimaan tulleet koodistojen koodit/toimipaikat. Koodistojen/toimipaikkojen hakupyynnön voi suorittaa myös ilman koodisto / päivämäärä rajauksia, jos käyttäjä haluaa kaikki koodistot/toimipaikat. Käyttäjä saa paluusanomassa haluttujen koodistojen koodit/toimipaikat, jotka päivitetään joko paikalliseen koodistopalveluun tai omaan tietovarastoon.
VAATIMUSMÄÄRITTELY 18 (28) 6 VAATIMUSTEN KUVAAMINEN Alla olevissa taulukossa kuvataan koodistopalvelun rajapinnalle asetettavat vaatimukset, niiden lähde, prioriteetti (1 pakollinen, 2 tarpeellinen, 3 toivottava) ja todentaminen. Sarakkeessa todentaminen lyhenne KA viittaa kokonaisarkkitehtuurin dokumenttiin. 6.1 Yleiset vaatimukset Tunnus Kuvaus Lähde Prior. Todennus BR001 Kansallisessa palvelussa ei hallinnoida muita kuin kansallisesti yhtenäistettyjä koodistoja (ja mahdollisesti KANTA - palveluiden sisäisiä teknisiä koodistoja) Koodistopalvelu 1 Kohta Tietojärjestelmän tarkoitus BR002 Koodistojen ylläpitoon tulee määrittää ennalta sovitut aikataulut ja sopia menettelytavoista uusien koodistopäivitysten hyväksymiseksi ja julkistamiseksi. Koodistopalvelu 2 - BR004 Koodistojen ylläpitomenettelyt, vastuut ja ajantasaisuus pitää saattaa tuotantokäyttöjen edellyttämälle tasolle, jotta strukturoidun tiedon oikeellisuus voidaan tietojärjestelmillä varmistaa. Koodistopalvelu 1 KA Koodistopalvelu 6.2 Toiminnalliset vaatimukset Tunnus Kuvaus Lähde Prior. Todennus FR001 Koodistopalveluun integroituvien tietojärjestelmien edellytetään käyttävän reaaliaikaisessa koodien käsittelyssä omaa, kansallisesta palvelusta replikoitua koodistotietovarastoa tai paikallista koodistopalvelua, joka hakee kansalliset sisältönsä kansalliselta koodistopalvelulta Koodistopalvelu 1 -
VAATIMUSMÄÄRITTELY 19 (28) FR002 Koodiston lataukselle terveydenhuollon toimintayksiköiden tietojärjestelmiin ja alueellisiin/paikallisiin koodistopalveluihin on perusteltua määrittää suositusfrekvenssit. Näin siksi, että liian tiheä latausväli on turhan kuorman lähde ja liian harva latausfrekvenssi voi muodostua dokumentaation laatuongelmaksi. Lähtökohtainen suositus koodiston latausfrekvenssiksi on 14 vuorokauden välein. Suositusta tulee tarkentaa käyttökokemusten myötä. Koodistopalvelu 2 - FR003 Kansalliseen arkkitehtuuriin integroitumisesta seuraa lisäksi terveydenhuollon toimintayksiköiden tietojärjestelmille vaatimuksina käyttää kaikkien kansallisesti yhtenäistettävien koodistojen tunnisteena OID-koodia kyky hallita koodistojen ja koodien versiot samalla tavalla kuin versionhallinta on toteutettu kansallisessa palvelussa kyky päivittää paikallisten koodistojen tietosisältö kansallisen koodistopalvelun tarjoamia HL7 V3 palvelurajapintoja hyödyntäen Koodistopalvelu 1 Kohdat Tietojärjestelmän tekninen arkkitehtuuri ja Toiminnalliset vaatimukset Edellä kuvatut vaatimukset kohdistuvat niihin toimintayksiköiden tietojärjestelmiin, jotka käyttävät koodistopalvelun rajapintoja. Lisäksi edellytetään, että kansallisen sovelluksen versionhallinta on riittävän hyvin määritelty ja toimiyksikön tietojärjestelmä tarvitsee versionhallintaa. FR004 Koodistopalvelun tulee tarjota toiminnallisuus ja rakenteet viestinvälityksessä tarjottavien palveluosoitteiden hallinnointiin. Koodistopalvelun nykytoteutus ei täytä tätä vaatimusta Nykyisellään koodistopalvelussa organisaatioon voi liittää kooditettuja ominaisuuksia. Viestinvälityksessä tarvittavat osoitetiedot eivät kuitenkaan ole kooditettavissa olevia arvoja vaan enemmänkin ominaisuuksia. Koodistopalvelu 1 Kohta Tietojärjestelmän tarkoitus
VAATIMUSMÄÄRITTELY 20 (28) FR005 Osoitteiden hallinta koodistopalvelussa edellyttää, että koodistopalvelua kehitetään siten, että sinne voi tallentaa myös ei kooditettuja ominaisuuksia. Vastaavat muutokset tarvitaan luonnollisesti myös palvelurajapintoihin Koodistopalvelun tulee tarjota toiminnallisuus, jolla viestinvälityksessä tarvittavien palveluosoitteiden muuta koodistopalvelun sisältöä tiukemmat suojausvaateet voidaan hallita. Koodistopalvelun nykytoteutus ei täytä tätä vaatimusta. Koodistopalvelu 1 - Käytännössä tämä voidaan toteuttaa siten, että palvelusoitteet ovat haettavissa ainoastaan KANTA-palveluista käsin suorakäyttörajapinnan kautta palveluosoitteiden selailu ja ylläpito on sallittu ainoastaan tunnistetuille käyttäjille, joille on määritetty oikeus toimipaikkarekisterin ylläpitoon FR006 Koodistopalvelun tulee tarjota mahdollisuus määrittää ylläpito-oikeudet koodistoittain. Tämä mahdollistaa ylläpidon kontrolloidun hajauttamisen tarvittaessa useammalle vastuutaholle Koodistopalvelu 1 Kohta Tietojärjestelmän tekninen arkkitehtuuri Lisätietoa koodistojen versionhallinta -vaatimuksesta OIDeja käytettäessä koodistopäivityksessä, jossa aiemmin käytössä ollut koodi muuttuu toiseksi tai poistuu käytöstä, on tarpeen: joko versioida koko koodisto tai määrittää koodille ominaisuudeksi aikaleima, jonka jälkeen se ei enää ole käytössä muuhun kuin validointiin Stakesin lausunnon mukaan OID-tunnusta ei käytetä koodistopäivityksessä koodin tunnisteena. Poikkeuksena tästä Stakesin näkemyksen mukaan organisaatiorekisterissä tullaan käyttämään OID-tunnusta ja jos koodi muuttuu toiseksi, koodi lopetetaan ja koodille osoitetaan uusi, korvaava koodi lisätieto-kentässä, mikäli tarpeen. Toteutuksessa em. aikaleiman suhde tietoihin Voimassaolo alkaa ja Voimassaolo päättyy tulee määritellä.
VAATIMUSMÄÄRITTELY 21 (28)
VAATIMUSMÄÄRITTELY 22 (28) 6.3 Arkkitehtuurivaatimukset Tunnus Kuvaus Lähde Prior. Toden nus AR001 Kansallisen koodistopalvelun tekninen arkkitehtuuri on noudatettava viestinvälitys osaprojektissa määriteltyä arkkitehtuuriratkaisua: Palvelinten väliset yhteydet varmennetaan sertifikaateilla Rajapintapalvelut toteutetaan Web Service palveluina palveluväylän taakse Web Service kutsuissa käytetään HL7 V3 siirtokehyksiä KokA 1 - AR002 KANTA palvelun sisäiset järjestelmät rakennetaan hyödyntämään kansallisen koodistopalvelun tietosisältöä suorakäyttörajapintojen kautta. Tällä vältetään tiedon turha jakaminen kahteen erilliseen rekisteriin, jotka pitäisi pitää synkronissa palvelurajapintojen avulla. Riittävä palvelutaso on turvattava fyysisillä laitteiden ja sovelluspalveluiden ryvästyksillä. Samalla on otettava huomioon julkisen palvelun ja sisäinen palvelun edellyttämät tietosuojavaatimukset. Koodistopalvelu 1 Kohdat Tietojärjestelmän tarkoitus ja Käyttötarina 4.2.8 AR003 STAKESin koodistopalvelu tarjoaa natiivin EJB/RMI rajapinnan koodiarvojen ja toimipaikkojen suorakäyttöön KANTA palvelun sisäisissä integraatioissa. Koodistopalvelu 1 KA Koodistopalvelu Natiivin rajapinnan rinnalle on kehitettävä Web Service palvelut myös KANTA palvelun sisäisiä integraatioita varten. Tämä antaa mahdollisuuden valita toteutustapariippumattomasti ratkaisut sisäisiksi palveluiksi. Palveluiden julkistamista KANTA palvelun ulkopuolelle ei suorituskyky- ja käytettävyys- (availability) syistä nähdä järkevänä, vaikka se esitetään tässä määrityksessä mahdollisuutena. Tällä hetkellä koodistopalvelin tarjoaa Datawellin API-rajapinnan. AR004 Mikäli paikallisia/alueellisia koodistopalveluita käytetään, tulee niiden rajapinnat niitä hyödyntävien potilastietojärjestelmien suuntaan toteut- Koodistopalvelu 2 -
VAATIMUSMÄÄRITTELY 23 (28) taa identtisinä kansallisen koodistopalvelun rajapintojen kanssa. 6.4 Käytettävyysvaatimukset Tunnus Kuvaus Lähde Prior. Todennus UR001 Koodistopalvelun käytettävyyden on noudatettava KANTA palveluille määriteltyjä yleisiä käytettävyysvaatimuksia. KokA 1-6.5 Tietoturvavaatimukset Tunnus Kuvaus Lähde Prior. Todennus SR003 Koodiston selailu ja tarkastelu kansallisen palvelun Web liittymältä ei edellytä käyttäjän tunnistamista lukuun ottamatta KANTApalveluiden asiakasjärjestelmien välisessä viestiliikenteessä käytettyjen palveluosoitteiden selaamista. Näiden koodistojen selaaminen ilman käyttäjätunnistusta tulee voida estää. Koodistopalvelu 1 KA Koodistopalvelu
VAATIMUSMÄÄRITTELY 24 (28) 7 TIETOSISÄLLÖN KUVAUS Koodistopalvelun tietosisältö on kuvattu dokumentissa Koodistopalvelun tiedonsiirron tekninen ohje OID:1.2.246.537.11.2006.15. Seuraavissa kappaleissa on esitetty nykyisen koodistopalvelutoteutuksen koodistojen ja palveluyksiköiden tunniste-, perus- ja lisätiedot. 7.1 Koodistojen / nimikkeistöjen / luokitusten tunnistetiedot 1. Koodiston tunniste / id, koodiston OID-tunnus täydellisenä esim. 1.2.246.537.6.1. 2. Koodin / nimikkeen / luokan arvo, koodin arvo. esim.xxxx. 3. Voimassaolo alkaa, toimipaikkakoodin voimassaolo alkaa. Nykyisin voimassaoleville koodeille viedään alkuajaksi 1.1.2004. 4. Voimassaolo päättyy, toimipaikkakoodin voimassaolo päättyy. Nykyisin voimassaoleville koodeille viedään päättymisajaksi 31.12.2030 7.2 Koodistojen / nimikkeistöjen / luokitusten perustiedot 1. Toimipaikkakoodin voimassaolo alkaa. Nykyisin voimassaoleville koodeille viedään alkuajaksi 1.1.2004. 2. Viimeinen muutospäivä, milloin tietoja on viimeksi muutettu. 3. Viimeinen muuttaja, viimeisen muuttajan käyttäjätunnus tai vastaava esim. Stakes, MO KL, KH; 4. Status, arvot: 1=aktiivinen, -1=poistettu, 0=ehdotustilainen 5. Lyhyt nimi, Osin rinnakkainen kohdalle 4, 50 merkkiä. 6. Pitkä nimi, koodiarvon pitkä nimi, jota näytään näyttämisessä. Yksilöi tarkasti koodiarvon, 255 merkkiä. 7. Lyhenne, käytetään usein näytöissä tai taulukoissa, jossa tilankäyttö on rajoitettu. Esim. SIS, KIR tai Na. Pituus 40 merkkiä. 8. Ylempi yksikkö, tässä kohdassa voidaan esittää koodistojen hierarkia eli eri tasoiset otsakkeet. 9. Hierarkiataso, tässä kohdassa esitetään koodin hierarkian taso-koodi, 0=ylätaso, 1=seuraava taso jne. 10. Määritelmä, tässä kohden voidaan antaa määritelmä ja muita lisätietoja. Käyttäjän tulisi saada nämä lisätiedot työasemalta myös helposti käyttöönsä. Määritelmä-kentän pituudeksi on varattu 32 000 merkkiä.
VAATIMUSMÄÄRITTELY 25 (28) 7.3 Koodistojen / nimikkeistöjen / luokitusten lisätiedot Lisätiedot ovat koodistokohtaisia. Seuraavassa on esitetty esimerkkejä lisätiedoista. 1. Ulkoinen linkki/linkit, käytetään viittauksiin toisessa koodistossa olevaan koodiin. 2. Ruotsinkielinen pitkä nimi, tässä kohdassa annetaan longname language=sv 3. Englanninkielinen pitkä nimi, tässä kohdassa annetaan longname language=en 4. Latinan kielinen pitkä nimi, tässä kohdassa annetaan longname language=la 5. Lehtisolmu (leafnode), tässä kohdassa annetaan lehtisolmun tunnus 6. Yksikkö (unit), Tässä kohdassa annetaan yksikkötunnus 7.4 Palveluyksikön tunnistetiedot 1. CodeId, toimipaikan OID-tunnus täydellisenä esim. 1.2.246.537.10.1714953.10.102 2. Kieli 3. Luontipäivä, toimipaikkakoodin voimassaolo alkaa. Nykyisin voimassaoleville koodeille viedään alkuajaksi 1.1.2004. 4. Voimassaolo alkaa, toimipaikkakoodin voimassaolo alkaa. Nykyisin voimassaoleville koodeille viedään alkuajaksi 1.1.2004. 5. Voimassaolo päättyy, toimipaikkakoodin voimassaolo päättyy. Nykyisin voimassaoleville koodeille viedään päättymisajaksi 31.12.2030. 6. Viimeinen muutospäivä, milloin tietoja on viimeksi muutettu 7. Viimeinen muuttaja, viimeisen muuttajan käyttäjätunnus tai vastaava 7.5 Palveluyksikön perustiedot 1. Status, arvot: 1=aktiivinen, -1=poistettu, 0=ehdotustilainen 2. Lyhyt nimi, katso kohta 4 3. Pitkä nimi, Toimipaikan pitkä nimi, jota näytetään toimipaikan ominaisuuksien näyttämisessä. Palveluntuottajalle (toimipaikkatunnus on 0) annetaan kunnan, kuntayhtymän ym. virallinen nimi.
VAATIMUSMÄÄRITTELY 26 (28) 4. Lyhenne, Palveluyksikön lyhyt nimi, jota käytetään ensisijaisesti nimen näyttämisessä web-luetteloissa. Liitteenä 2 on esimerkkejä. Osastosta käytetään lyhennettä os ja poliklinikasta pkl. Palveluyksikön nimestä ei tulisi näkyä tarvittavaa palvelua esim. Jorvi, os K4 eikä Jorvi, kir os K4. Mikäli osaston nimen yhteydessä on vakiintunut tapa käyttää palvelun nimeä (käytössä esim. opasteissa), niin sitä ei tässä yhteydessä ole syytä muuttaa. 5. Ylempi yksikkö, tässä kohdassa voidaan sisäiseen käyttöön esittää organisaatiohierarkia, mutta tätä tietoa ei ainakaan tässä vaiheessa välitetä koodistopalvelimelle 6. Hierarkiataso, tässä kohdassa voidaan sisäiseen käyttöön esittää organisaatiohierarkian taso-koodi, mutta tätä tietoa ei ainakaan tässä vaiheessa välitetä koodistopalvelimelle 7. Määritelmä, tässä kohden voidaan antaa tarjottavista palveluista lisätietoja. Lisäksi on syytä mainita palveluista erityisryhmille. Myös jos palveluita annetaan viittomalla tai muilla kielillä. Palvelujen saatavuuden esteettömyydestä voidaan mainita myös tässä kohdassa, mutta tarkemmin kooditettuna palveluyksikön lisätiedot kohdassa 23. Tämä kenttä on tarkoitus näyttää esimerkiksi palveluja poimittaessa lisätietona. 8. Ulkoinen linkki, käytetään viittauksiin toisessa koodistossa olevaan koodiin 7.6 Palveluyksikön lisätiedot 1. Kustannuspaikka, palveluntuottajan y-tunnus, joka kopioidaan jokaiselle toimipaikalle 2. Postiosoite, palveluyksikön postin osoite 3. Katuosoite, palveluyksikön käyntiosoite 4. Postinumero, palveluyksikön postinumero 5. Postitoimipaikka, palveluyksikön postitoimipaikan nimi 6. Puhelinnumero, palveluyksikön puhelinnumero 7. Telefax, palveluyksikön telefaxnumero 8. Ensisijainen palveluluokka, ensisijainen palveluluokka tarjottavasta ensisijaisesta palvelusta. Palveluluokan perustella saadaan: Tol2002-luokka, Palveluyksikön erikoisala, Palveluyksikön tyyppi (vuodeosasto, poliklinikka, röntgen, laboratorio, ) 9. Muut palveluluokat, palveluyksikön toissijaiset palvelut (toistuva kenttä) Kentät erotetaan toisistaan pilkulla (,). 10. Paltu (Topi toimipaikkarekisterin palveluntuottaja), Stakes Hilmo:n palveluntuottajakoodi eli Toimintayksikkökoodit 2004
VAATIMUSMÄÄRITTELY 27 (28) 11. Paltutar (Topi toimipaikkarekisterin palveluntuottajan tarkennin), Stakes Hilmo:n palveluntuottajakoodin tarkennin eli Toimintayksikkökoodit 2004 12. Kunta, palveluyksikön sijaintikunta. Löytyy esim. Stakes Hilmo Sosiaali- ja terveydenhuollon hoitoilmoitus 2004 13. Palveluyksikön tyyppi, 1. palveluntuottaja (palveluyksikkötunnus=0) (välitetään koodistopalvelimelle), 2. hallintoalue (esim. HUS) (ei välitetä toistaiseksi koodistopalvelimelle), 3. sairaala, pääterveysasema (välitetään koodistopalvelimelle), 4. hoitolinja tai klinikka (välitetään koodistopalvelimelle), 5. palveluyksikkö (välitetään koodistopalvelimelle), 6. hallinnollinen palveluyksikkö (ei välitetä toistaiseksi koodistopalvelimelle), 7. organisaation sisäinen hierarkia (katso kohdat 4 ja 5) (ei välitetä koodisto-palvelimelle), 8. muu 14. Yhteisötyyppi, Yhteisötyyppi on YTJ:n mukainen yritysmuoto. Kaikki palveluntuottajan toimi-paikat saavat saman yritysmuodon; Y01 kunta, Y02 kuntayhtymä, Y03 kunnallinen liikelaitos, Y04 kuntayhtymän liikelaitos, Y05 osakeyhtiö, Y06 avoin yhtiö, Y07 kommandiittiyhtiö, Y08 yksityinen elinkeinonharjoittaja, Y09 aatteellinen yhdistys, Y10 valtio ja sen laitokset, Y99 muu 15. Sähköposti, palveluyksikön sähköpostiosoite 16. Palveluyksikön rakennustunnus, palveluyksikön rakennustunnus on opasteissa käytetty rakennustunnus 17. Palveluyksikön kerros, palveluyksikön (kanslian) kerros 18. Web-sivut kansalaiselle, kansalaisille tarkoitetun Web-sivujen osoite 19. Web-sivut ammattilaiselle, ammattilaisille tarkoitetun Web-sivujen osoite 20. WSDL (UDDI) määritysten Web-osoite, IP-osoite 21. Tämä palveluyksikkö jatkaa Palveluyksikön (OID-tunnus) toimintaa, kun palveluyksikkö jatkaa toisen lakkautetun palveluyksikön toimintaa esimerkiksi omistajavaihdoksen tai yritysmuodon muuttuessa, jolloin y-tunnus muuttuu. Tässä ilmoitetaan edellisen Palveluyksikön OID-tunnus. 22. Palveluyksikkö(OID-tunnus) jatkaa tämän Palveluyksikön toimintaa, kun palveluyksikkö jatkaa toisen lakkautetun palveluyksikön toimintaa esimerkiksi omistajavaihdoksen tai yritysmuodon muuttuessa, jolloin y-tunnus muuttuu. Tässä ilmoitetaan lakkautetulle toimipaikalle jatkavan palveluyksikön OID-tunnus. 23. Palveluyksikön esteettömyys, Palveluyksikön esteettömyydestä käytetään koodistoa. Kentät erotetaan toisistaan pilkulla (,).
VAATIMUSMÄÄRITTELY 28 (28) 8 VIITTAUKSET Asiakirjan nimi ja versio Koodistopalvelun tiedonsiirron tekninen ohje OID:1.2.246.537.11.2006.15 Koodistopalvelu potilaskertomuksen ydintietojen kannalta, Jorma Komulainen, 4.9.2006. (ppt) Lisätiedot (käyttötarkoitus) STAKES (laatinut Antero Ensio) STAKESin tilaama selvitys, esillä Pokanentyöryhmän kokouksessa 6.9.2006