Koodistorajapinnat: Tekniset liittymämäärittelyt XML- ja http- rajapinnoille Juha Mykkänen, PlugIT, Kuopion yliopisto, HIS-yksikkö PlugIT-puolivuotisseminaari, E-työpaja, Kuopio,

2 Esityksen sisältö Lyhyt kertaus ja johdanto koodistorajapintoihin Viime puolivuotisseminaarin jälkeen… Versio 2.0 tavoitteet ja tausta Version 2.0 sisältö Tarkennukset, jatkotoimenpiteet Keskustelu

3 Yhteiset koodistot sovellusten käyttöön - kertaus PlugIT-ydinrajapinnat –keskitetyt palvelut, päällekkäisyyden vähentäminen, samat rajapinnat moniin hyödyntäjä- ja tarjoajasovelluksiin –sovellusläheiset Kansallinen koodistopalvelin –käytössä, tietosisältö laajenee –koodistojen siirtosanomat määritelty (koodistojen lataus hyödyntäviin ohjelmistoihin) vrt. PlugIT-rajapinta -> koodistojen hyödyntäminen keskitetyn palvelun avulla (ei koko koodiston latausta) Versiossa 1 määriteltiin toiminnot ja sisällöt API- rajapinnoille tekniikkariippumattomasti –jatkona tekninen tarkennus -> versio 2

4 ”Nykytilanne” ( ) Kehitystarpeista.. ja standardeista (OMG TQS, koodisto- palvelin) johdettu vaatimukset.. ja tekniikka- riippumattomat määrittelyt

5 ”Seuraavaksi” ( ) Erillis-, ydin- ja aluejärjestelmien vaatimukset Nykymääritysten tarkennus / korjaukset kommenttien perusteella Toteutus Valituilla tekniikoilla määritysten tarkennus

6 Nykytilanne ( ) Erillis-, ja ydinjärjestelmien vaatimukset Tarkennukset, lisäykset, versio 1.0 hyväksyttiin Tässä esityksessä luonnos v2.0 Toteutus käynnissä Valituilla tekniikoilla määritysten tarkennus HL7 CTS -standardi!, koodistopalvelin, PlugIT ydinrajapinnat XML, http

7 Suurimmat muutokset versioon 1.0 Valittu avoimet tekniikat rajapintamäärityksiin –http (tiedonsiirto) + XML (operaatiot ja tietosisältö) sama malli muiden PlugIT-ydinrajapintojen kanssa ”tarjolla” oli myös Web services (WSDL+SOAP) HL7 Common Terminology Services-harmonisointi –UUSI standardi HL7 International –HL7-palvelumäärittelyt (HL7 määrittelemässä palvelurajapintoja viestien lisäksi, myös CCOW) –käytetty samaa pohjaa kuin PlugIT-koodistomäärityksissä (OMG TQS, OMG IDL) –HL7 CTS Vocabulary-rajapinnan operaatioille oli (yhtä lukuunottamatta) vastineet PlugIT- v1-rajapinnassa(!) Koodistosiirtosanomat-harmonisointi (Open CDA, kans. koodistopalvelin) –koska valittiin XML, hyödynnetään samoja elementtejä soveltuvin osin –pienentää työmäärää etenkin ohjelmistossa, joka hakee koodistot kansalliselta palvelimelta ja tarjoaa koodisto-API-rajapintoja joukolle sovelluksia Operaatioiden määrän vähentäminen –eri tasojen parametreja mukaan operaatioihin (XML mahdollistaa vapaaehtoiset elementit)

8 Versioon 1.9 sisältö 1 Johdanto ja tausta 2 Tavoitteet ja päärajaukset 3 Aikaisempien määritysten tarkentaminen 4 Valitut tekniikat ja niiden käyttötavat 5 Tekniset sovellusosat, niiden vastuut ja tiedonvälitys 6 Operaatio- ja parametrimääritykset 6.1 Määrityksen palvelutasot ja niillä vaaditut piirteet 6.2 Codeservice-rajapinta 6.3 Codeset-rajapinta 6.4 Code-rajapinta 6.5 Virhetilanteet 7 Sisältömääritykset: rajapinnan liittäminen eri koodistoihin 7.1 ICD-10 sisältömääritys 8 Laajennukset ja jatkokehitys 9 Toteutuksiin kohdistuvia vaatimuksia 9.1 Toteutuskohtaisesti ratkaistavat seikat 9.2 Määrityksen mukaisuudesta varmistuminen

9 Rajapinnat ja operaatiot v1.9 CodeService-rajapinta –GetSupportedCodeSystems: perustaso –GetSupportedServices: perustaso –GetInfo:perustaso Codeset-rajapinta –LookupCodesByDesignation: minimitaso –ListCodes: minimitaso –LookupCodes: perustaso –GetSupportedCodesetServices: perustaso –IsCodeValid: perustaso –GetCodesetInfo: perustaso –ListLanguages: monikieliset koodistot –GetHierarchyDepth: hierarkkisten koodistojen syvyyden kysely –GetCodes: vapaa tietosisältö –GetSupportedAttributes: vapaa tietosisältö Code-rajapinta –GetDesignation: minimitaso –GetParent: hierarkkisten koodistojen käsittely –GetHierarchyLevel: hierarkkisten koodistojen käsittely –GetStatus: koodien paikallisuus ja tila –GetLocal: koodien paikallisuus ja tila –LookupCompleteCodedConcept: vapaa tietosisältö –LookupProperties: vapaa tietosisältö

10 Määrityksen tasot v1.9 minimitaso –vain keskitetyn koodistopalvelun välttämättömät operaatiot olemassa olevien sovellusten helpon liitettävyyden kannalta: koodiston ja koodin käyttöön saanti, koodien listaus, minimitietosisältö (koodi ja selite), selitteen saanti koodilla, koodien saanti selitteellä perustaso ”base” –minimitason lisäksi osamerkkijonolla haku selitteestä ja koodista, tuettujen palveluiden ja koodistojen selville saanti, palvelun ja koodistojen (vapaaehtoiset) hallinnolliset tiedot, monikieliset koodistot ”multilingual”, –useiden tai määriteltyjen kielten tuki selitteissä ja muussa tietosisällössä koodistohierarkian käsittely ”hierarchy” paikallisten koodien ja tilan huomiointi ”status” – –oletusarvoisesti palvelu palauttaa myös paikalliset ja poistetuiksi merkityt koodit. vapaa tietosisältö ”freeElements” –perustietojen (koodiarvo, selite) lisäksi minkä tahansa koodien sisältämien kenttien käyttö eri operaatioissa edistyneet haut ”advSearch” –haku koodiston koko sisällöstä ml. alimerkkijonot, haku avainsanoilla, hakuehtojen kohdistaminen haluttuihin kenttiin, useiden hakuehtojen käyttö

11 Esimerkki: haku ja vastaus minimitasolla Codeset LookupCodesByDesignation lavantauti Lavantauti

12 Esimerkki: haku ja vastaus (edistyneet haut, vapaa tietosisältö, monikieliset, paikallisuus ja tila, hierarkia) Codeset LookupCodeByDesignation avantaut 1 0 A00-A09 id shortname Lavantauti Pikkulavantauti...

13 Nykyrajapinta

14 Sisältömääritykset Rajapinta ”liitettävä” koodistosisältöön –mistä tulee tunniste, lyhenne, kieli jne… –sisältömääritys ”erillinen” rajapinnasta, voidaan määritellä esim. kullekin vaatimuksena alusta lähtien eri koodistojen käsittely samalla rajapinnalla Nykyversiossa ICD-10-sisältömääritys –suhde Open CDA / kans. palvelimen siirtosanomaan ja Stakesin Excel-muotoon –lisää sisältömäärityksiä mille koodistoille ensin?

15 Jatkokehitys Sisältökommentit seminaarin jälkeen –seuraavassa johtoryhmässä hyväksyttäväksi tekninen määritys Referenssitoteutus käynnissä Lisää sisältömäärityksiä Hierarkkisissa koodistoissa haun ulottaminen lehtitasolle? –nyt vain ”seuraava taso” Arvojoukkojen rajaukset? –VocabularyDomain-elementit, uusi taso? –”HUS-alueen kunnat” (rajattu kuntakoodisto) Koodiarvojen ja koodistojen suhteet? –HL7 ConceptCodeRelationship? hasSubtype, hasPart, smallerThan suhteet? –”HUS-alueen kunnat” (shp-koodiston ja kuntakoodiston välillä suhde)? –TranslateCode (sourceCodeSystem, targetCodeSystem)? Ensin kuitenkin keskitetyt ”perus”palvelut käyttöön? –samat rajapinnat (ja eri koodistot) mahdollista toteuttaa eri sovelluksiin

16 Alueellinen koodistopalvelu? Organisaation koodistopalvelu? Ydinjärjestelmä?