REST API client-ohjelmakirjasto potilastietojärjestelmään

Abstract

Opinnäytetyön toimeksiantajana oli Vitec Softwaren Tampereen yksikkö, joka kehittää Acute-potilastietojärjestelmää. Opinnäytetyön tarkoituksena oli löytää keino paketoida Acuten REST-rajapinnan toiminnallisuudet ohjelmakirjastoksi ulkopuolisten kehittäjien käyttöön. Opinnäytetyön tarkoituksena oli tämän lisäksi suunnitella ohjelmakirjaston ylläpito- ja julkaisuprosessi.

Opinnäytetyön tavoitteena oli rakentaa työkalu, joka helpottaa mahdollisimman paljon kolmansien osapuolien kehitystyötä Acuten rajapinnan kanssa. Projektin tuotoksella oli tarkoitus alentaa kynnystä kolmansille osapuolille palveluiden tuottamiseen. Koska uusien ohjelmistokokonaisuuksien ylläpito vaatii usein lisäresursseja, tutkimuksessa painotettiin työkalun automatisointia ylläpidon ja julkaisun kannalta.

Tutkimuksen alussa toimeksiantajan kanssa käytiin määrittelypalavereita, joilla kartoitettiin tarvittavan työkalun vaatimukset. Näistä vaatimuksista syntyi lista, jonka avulla aloitettiin kehityksen suunnittelu. Suunnittelu lähti käyntiin selvittämällä olemassaolevia ratkaisuja REST-rajapintojen käyttämiseen ja miettimällä miten näitä voitaisiin hyödyntää kehitysprosessissa. Suunnitelman valmistuttua se esiteltiin toimeksiantajalle, jonka hyväksymisen jälkeen kehitystyö aloitettiin. Kehitystyön aikana kiinnitettiin huomiota määrittelyissä toivottuihin vaatimuksiin, kuten ylläpidon automatisointiin. Viimeisenä vaiheena projektissa oli suunnitelman kirjoittaminen ohjelmakirjaston julkaisuprosessista.

Opinnäytetyön tuotoksena syntyi automatisoitu prosessi, joka mahdollisti lähdekoodista generoituvan ohjelmakirjaston luonnin. Prosessi perustuu OpenAPI-spesifikaation teknologiaan, josta erillisellä työkalulla voidaan luoda ohjelmakirjastoja. Tutkimuksesta syntyi myös suunnitelma ohjelmakirjaston automatisoidusta julkaisuprosessista. Tutkimuksen tuotos vastasi toimeksiantajan asettamia vaatimuksia työkalun helposta ylläpidosta sekä julkaisusta. Toimeksiantajalle lisäarvona oli myös mahdollisuus käyttää opinäytetyön tuloksia sisäisissä koulutuksissa.

This thesis was commissioned by Vitec Software’s unit located in Tampere. The unit in Tampere provides the patient information system Acute for a vast number of different healthcare organizations. The purpose of this thesis was to find a way to wrap Acute’s REST API to a software library, which would further attract third party organisations to develop services around Acute’s ecosystem. The emphasis on the requirements of the library was in ease of library’s upkeep and deployment process. In addition to the librarys development project, the thesis also researches the process of deploying and publishing the library to the public. Each process was hoped to be as automated as it could be. The methods for the project varied from specification meetings to the use of automated tools for consuming REST API’s

As a product of this thesis an automated process of generating a software library from Acute’s REST API was created. The process utilises OpenAPI-specification technology, which enables the automated generation from source code with minimal effort in upkeeping. The research also produced a plan for automated process for deploying and publishing the library. In addition to achieving the commissioned goal, additional value is achived by using this thesis as a learning material in internal training.