Yhteiset koodistot sovellusten käyttöön: Koodistorajapinnat

Esitys aiheesta: "Yhteiset koodistot sovellusten käyttöön: Koodistorajapinnat"— Esityksen transkriptio:

1 Yhteiset koodistot sovellusten käyttöön: Koodistorajapinnat
Juha Mykkänen, PlugIT, Kuopion yliopisto, HIS-yksikkö Työpaja 2, PlugIT-puolivuotisseminaari, Kuopio,

2 Esityksen sisältö Koodistorajapinnat: taustaa ja tarpeet
Määrittelyn nykytilanne Kansallisen koodistopalvelimen määritysten ja TQS-standardin hyödyntäminen Tekniikkariippumattomat määritykset: yleiskuva ja esimerkit Tarkentaminen käytettäväksi valituilla tekniikoilla Jatkotyö, kommentointi, pilotointi (Nykymääritysten avoimet kysymykset)

3 Koodistorajapinnat: taustaa
PlugIT-projektin ydinrajapinnat: määritellään sovellusten rajapintoja (API), joilla useat erillissovellukset voivat käyttää samoja ydinpalveluita (eri ydinjärjestelmistä eri paikoissa) tavoitteena integroinnin + käyttöönoton helpottuminen ydinsovellusten tarjoamat palvelut, erillissovellusten, th. käyttäjien ja tietohallinnon tarpeet koodistot ja organisaatio yksi varhain tunnistetuista integrointitarpeista erillissovellusten kannalta kehityskohteena monissa keskusteluissa, nykytila- ja kehittämistarvekyselyssä Kansallinen koodistopalvelin palvelimelle ensimmäisenä tulevat koodistot valittu koodistojen siirtoon XML- ja SOAP-määritykset tehty toteutus käynnissä, toinen vaihe suunnitteilla määritellyt tietosisällöt (XML) tarjoavat hyvän pohjan tarkemmille sovelluspalveluille (tiedonsiirron lisäksi) koodistojen hyödyntäjät: sos-ter-organisaatiot, Stakes, Kuntaliitto, tilastokeskus, tutkimuslaitokset, ohjelmistotoimittajat, tietotekniikan käyttöpalveluiden tuottajat koodistorajapintoja tarjoamalla yhteiset koodistot helposti erillissovelluksiin?

4 Nykytilanne Saatavilla määritys: Koodistorajapinnat: integrointivaatimukset ja tekniikkariippumattomat liittymämäärittelyt, versio 0.6 (luonnos) Määrittelee joukon API-rajapintoja, jotka koodistotarjoaja (ydinsovellus, alueellinen palvelu) tarjoaa koodistohyödyntäjälle (erillissovellus, portaali, web- tai työasemasovellus) hyödyntää Kansallinen koodistopalvelin-tietosisältömäärityksiä, hyödyntää TQS (Terminology Query Services) –standardia, PlugIT-taustaselvityksiä ja kerättyjä vaatimuksia rajapinnat määritelty tekniikkariippumattomalla tasolla toteutettavissa esim. web-palveluina, http + XML-tekniikalla, dll- tai Java-kirjastoina… tehdyt perusratkaisut: synkroninen pyyntö/vastaus, jaetut palvelut (ei kopioida kokonaisia koodistoja hyödyntäjälle)

5 Hyödynnetyt määritykset: kansallinen koodistopalvelin + TQS
tietosisällön (XML-määritykset) hyödyntäminen monipuolinen ja joustava tietosisältö, monet keskeiset nimikkeistöt, koodistot ja luokitukset kansallisten hankkeiden yhteistyö (Terveysprojekti, Open CDA, PlugIT..) TQS (Terminology Query Service) joukko terminologiajärjestelmien tarjoamia palveluita rajapintoina, mm. käsitteen hakeminen koodilla, koodien hakeminen tarkan tai osittaisen käsitteen avulla, haut avainsanoilla, tarkimman mahdollisen käsitettä vastaavan koodin vaiheittain haku, koodien ja käsitteiden listaukset, kentän validointi, valintalistat (koodistojen mediaatio, kontekstipohjaiset koodien esitysmuodot jne.) selvitys: ”TQS (Terminology Query Service) –standardin koodistoihin liittyvät vaatimukset ja rajapinnat” TQS ja kansallinen terveysprojekti: samoja vaatimuksia.. valmiita malleja koodistopalveluille, vältetään ”pyörän uudelleen keksiminen” ei järkevää toteuttaa tekniikkatasolla standardin mukaisesti, TQS:n hyödyntämän CORBAn tuonti suomalaisiin th. sovelluksiin aiheuttaisi liian paljon työtä -> hyödynnetään tekniikkariippumattomalla tasolla TQS:ssä määriteltyjä palveluita (mallitaso)

6 (integroinnin määrittelymenetelmä)

7 Nykytilanne Kehitystarpeista.. ja standardeista johdettu vaatimukset
.. ja tekniikka- riippumattomat määrittelyt

8 Nykyiset rajapintamäärittelyt
perusrajaukset ja –ratkaisut eri koodistojen hyödyntäminen samoilla rajapinnoilla, toteutettavuus eri tuotteisiin ja ympäristöihin palvelupohjainen integrointi, yhteisten palveluiden jakaminen (ei tietokantaintegraatiota, ei kokonaisten koodistojen kopiointia) synkroninen pyyntö/vastaus, välitön vuorovaikutus sovellusten välillä useita tasoja, joista voidaan tuotteessa toteuttaa (tai vaatia) kaikki tai vain jotkut: perustaso (minimi)– koodit ja selitteet, perushaut ja listaukset, tuettujen koodistojen ja palveluiden selville saanti, koodistoversiot monikieliset koodistot vapaa tietosisältö – minkä tahansa koodiston sisältöelementtien hyödyntäminen edistyneet haut – haku koko sisällöstä, avainsanat luokitushierarkian käsittely tasoja voi vielä poistaa/yhdistellä, uusissa versioissa tarvittaessa lisätasoja (esim.koodistojen väliset suhteet palvelulla, kontekstin mukainen esitysmuoto, uudet vaatimukset..)

9 Operaatioluettelo Perustaso Monikieliset Vapaa tietosisältö
codeservice: get_supported_codesets codeservice: get_supported_services codeset: get_concepts_by_text codeset: match_concepts_by_string codeset: list_concepts codeset: is_valid_concept code: get_preferred_text Monikieliset codeset: list_languages code: get_lang_text get_concepts_by_text_lang match_concepts_by_string_lang list_concepts_lang Vapaa tietosisältö codeset: list_concepts_and_values code: get_values code: get_value codeset: get_elements Edistyneet haut codeset: match_concepts_by_substring codeset: match_concepts_by_keywords Hierarkkisten koodistojen käsittely get_concepts_by_text_hier match_concepts_by_string_hier match_concepts_by_substring_hier match_concepts_by_keywords_hier list_concepts_hier list_concepts_and_values_hier codeset: hier_depth code: hier_parent Vapaaehtoiset operaatiot codeservice: get_info codeset: get_codeset_info

10 Esimerkki Operaatio codeset: match_concepts_by_string Käyttö-tarkoitus
Koodien hakeminen osittaisen selitteen avulla (vaatimus K2.6) Parametrit (in) text:ST – hakuarvo, how_many:Int – palautettavien maksimimäärä Paluuarvot (out) codes SET (code:ST, value:ST) - Tietojoukko, joka koostuu elementeistä, joissa on koodiarvo sekä selite. Kuvaus Palvelu palauttaa ne koodit, joiden selite alkaa hakuarvolla, hakuarvon pienet ja isot kirjaimet vastaavat toisiaan Poikkeuk-set Paluuarvo on tyhjä joukko, jos hakuarvoa ei löydy minkään selitteen alusta. Jos tuloksia on enemmän kuin on kuvattu maksimimäärä, palvelu palauttaa virhekoodin ja –ilmoitustekstin. Pakollisuus Pakollinen kaikissa toteutuksissa Malli TQS: CodingSchemeVersion: match_concepts_by_string Lisätietoja TQS:ssä palautetaan tulosten lisäksi osuman ”laatua” kuvaava arvo. Suurin sallittu maksimimäärä jätetään toteutuskohtaisesti määriteltäväksi. Tämä on huomioitu ”edistyneet haut”-tason määrityksissä.

11 Jatko jo nykyinen määritys käytettävissä esim. tarjouspyyntöjä varten
voidaan vaatia kuvattujen rajapintojen tarjoamista tai käyttöä, mutta vaatii tarkennuksia (+ muutokset, korjaukset) tekninen määritys (jatko) tarjoaa tarkemman mallin nykymääritysten kommentointi eri osapuolten kannalta - hyväksyminen erillis- ja ydinsovellusten tekijät, th. organisaatiot, aluetietojärjestelmät tekniikoiden valinta ja määritysten tarkennus valituilla tekniikoilla ensin yhdet tekniikkavalinnat, tarvittaessa jatkossa muita vasta tekninen määrittely on ”integraation toteutusmalli”, saman teknisen määrittelyn pohjalta toteutetut toimivat yhdessä toteutus: pilotointi tai referenssitoteutuksen tuottaminen pilotti: palvelun tarjoajat, palvelun hyödyntäjät, ratkaisun tilaaja referenssitoteutus: esimerkki palvelun toteutuksesta ja käytöstä monistettavalla tekniikalla määrittelyjen kattavuuden lisääminen? edistyneet terminologiapalvelut mediaatio, koodiston sisäiset + ulkoiset vastaavuudet, kontekstiriippuvat esitysmuodot, systemisaatio?

12 Nykytilanne Kehitystarpeista.. ja standardeista johdettu vaatimukset
.. ja tekniikka- riippumattomat määrittelyt

13 Seuraavaksi: Erillis-, ydin- ja aluejärjestelmien vaatimukset
Nykymääritysten tarkennus / korjaukset kommenttien perusteella Valituilla tekniikoilla määritysten tarkennus Toteutus

14 Valituilla tekniikoilla tarkentaminen:
tekniikkariippumattomista teknisiä määrityksiä (yksi tai useita) (harmaat osat)

15 Teknisiä esimerkkejä Olio-ohjelmointikielellä: http ja XML: pyyntö
var Service:ICodeService; ICDCodeSet:ICodeSet; ICDCode:ICode; .. ICDCodeSet:=Service.Get_CodeSet(’ ’); ICDCode:=ICDCodeSet.Get_Code(’B33.2’); Edit1.Text := ICDCode.get_preferred_text; //‘Viruksen aiheuttama sydäntulehdus’ http ja XML: pyyntö vastaus <?xml version='1.0' encoding='iso '?> <code lang=”fi” value=”Viruksen aiheuttama sydäntulehdus”/>

16 Nykymääritykset Nykydokumentin kommentointi ja hyväksyminen:
osapuolten kommentointi (nykyversio tai seminaarin jälkeen korjaukset -> 5.11) johtoryhmälle esitys, hyväksyminen tai jatkotyöstö

17 Pilotointi Tilaajat Koodisto- tarjoaja- sovellukset pilotointiosapuolia (palvelun tarjoajat, hyödyntäjät, tilaajat) teknisen määrittelyn pohjalta liittymät sovelluksiin mahd. myös referenssitoteutus mahdollisuus hyödyntää muiden Ydin-kohteiden tekniikkamalleja teknisen määrittelyn hyväksyminen uudet versiot (muut tekniikat, lisätoiminnallisuus) Koodisto- hyödyntäjä- sovellukset Pilotti- toteutus ja käyttöön- otto Nykymääritysten tarkennus + tekninen määritys

18 Materiaalia Koodisto-rajapinnat, Integrointivaatimukset ja tekniikkariippumattomat liittymämäärittelyt, luonnos versio 0.6 Standardiselvitys: TQS (Terminology Query Service) –standardin koodistoihin liittyvät vaatimukset ja rajapinnat Standardilista-sivulla linkkejä ja luetteloa koodistoista Kansallisen koodistopalvelimen määritysdokumentit Integraation määrittely ja dokumentointi-pohjadokumentti Integrointivaatimukset-pohjadokumentti Tekniikkariippumattomat liittymämäärittelyt-pohjadokumentti Tekniset liittymämäärittelyt-pohjadokumentti PlugIT-projektin määrittelyjen hyväksyminen ja julkistaminen dokumentti

19 Määrittely v0.6 kysymykset
Sisällölliset kysymykset: vaaditaanko aina hallinnolliset tiedot palvelusta ja eri koodistoista? perustason yksinkertaisuus + keveys (vain koodi+selite), muuta mukaan (monikielisyys)? hierarkkiset luokitukset nyt omana kokonaisuutenaan HL7-kooditasojen vastaavuudet (CS, CV, CE, CD)? tuleeko pelkkiä nimikkeistöjä (ilman koodeja)? status-tieto (esim. poissa käytöstä) – miten huomioitava? lajitteluvastuu: koodistohyödyntäjällä hakuoperaatioissa (rajattu määrä tuloksia), koodistotarjoajalla listausoperaatioissa (haetaan n kpl kerralla, tiedettävä minkä tiedon mukaan lajiteltuna palautetaan)? puuttuuko olennaisia palveluita (omiksi tasoikseen seuraavassa versiossa)?