Sil SOAP API 5.1 Prerelease Nyheter och förändringar gentemot Sil SOAP API 5.0
Innehållsförteckning 1.Inledning... 3 1.1Allmänt... 3 1.2Omfattning... 3 2.Bakåtkompatibilitet... 3 3.Ansökan om tillgång till demoserver... 4 4.Driftmiljö... 4 5.Ny funktionalitet... 5 5.1Övergång till VARA4 - Nytt attribut: everificationflag i typen DrugArticle... 5 5.2Fass-länkar... 6 5.3Ny tjänst: searchnondrugarticles... 7 5.4Synonymkällan för biverkningar: Tillägg av wildcardsökning... 8 5.5Ordningsföljden på biverkningstabellerna... 9 5.6Ny tjänst: getdateaddedbynplpackidlist... 9 5.6.1Ny typ: NplPackIdAddedToSil... 10 Sid 2/10
1. Inledning 1.1 Allmänt Detta dokument beskriver nyheter och förändringar i Sil SOAP API 5.1 gentemot 5.0 som det ser ut vid denna prerelease. Det förutsätts att läsaren är bekant med hur Sil SOAP API fungerar och har läst dokumentationen för Sil SOAP API 5.0; "Tjänstegränssnittsbeskrivning - Sil SOAP API 5.0". 1 Detta dokument beskriver Sil SOAP API 5.1 som det ser ut vid detta dokuments upprättande och är inte en slutgiltig beskrivning av API:et. Det beskriver nyheter och förändringar i den kommande releasen av API:et, som det ser ut just nu. Detta görs för att systemutvecklare och andra intresserade ska få en så konkret och tydlig bild som möjligt om vad de kan förvänta sig i den slutliga releasen av Sil SOAP API 5.1. Dvs det kan alltså komma att uppstå förändringar i den slutliga releasen jämfört med denna prerelease. 1.2 Omfattning Denna prerelease omfattar detta dokument samt en hos Inera publikt åtkomlig demoserver. Varken serverprogramvara eller tillhörande SQL-databas för lokala installationer kommer tillgängliggöras. 2. Bakåtkompatibilitet Sil SOAP API 5.1 är tekniskt bakåtkompatibel med föregående version. Med detta menas att ingenting som fanns i den tidigare versionen av Sil SOAP API har tagits bort, utan skillnaden handlar uteslutande om saker som lagts till; 2 nya tjänster, 1 ny typ och 1 modifierad typ som fått ett nytt attribut. Det kan trots detta, speciellt om man använder teknik som inte hanterar WSDL:er dynamiskt, behövas en mindre översyn för att lägga till de nya typerna/tjänsterna/attributen, även om man inte tänkt använda dem omedelbart. Nya systemtest rekommenderas vid migrering från 5.0 till 5.1. 1 https:///sil-dokument Sid 3/10
3. Ansökan om tillgång till demoserver I samband med denna prerelease tillgängliggörs en demoserver med Sil SOAP API 5.1 som är åtkomlig via Internet: https://sil51.demo.silinfo.se/ För åtkomst till Sil:s demoservrar krävs att man har avtal och har fyllt i en formell ansökan om åtkomst till demoservrarna. För de som redan har avtal och godkända ansökningar om åtkomst till demoservrar med Sil SOAP API, krävs ingen ytterligare ansökan. För information om avtalen och hur man ansöker om åtkomst till demoservrar se: https:///sil-fordjupning OBS! Den demoserver som tillgängliggörs för prereleasen är liksom övriga Sil demoservrar inte avsedd för skarp drift. Prereleasen är en så kallad alfarelease, vilket betyder att den inte är ordentligt testad samt inte helt featurekomplett. Det finns inga som helst garantier vad gäller stabilitet eller funktionalitet. Detta gäller även informationsinnehåll. 4. Driftmiljö Driftmiljön är densamma som tidigare, men versionerna (minor) på vissa av komponenterna har uppdaterats: Microsoft Windows Server 2016 Microsoft Windows SQL Server 2012 SP2 Java 8.0 Update 162 (Server JRE) Apache Tomcat 8.5.29 Sid 4/10
5. Ny funktionalitet 5.1 Övergång till VARA4 - Nytt attribut: everificationflag i typen DrugArticle Berör samtliga tjänster som returnerar typen DrugArticle. Typen DrugArticle utökas med att innehålla attributet everificationflag som anger om förpackningen ska ha säkerhetsdetaljer eller inte enligt Artikel 54a(1) direktiv 2001/83/EU. Information om säkerhetsdetaljer Det europeiska direktivet om förfalskade läkemedel föreskriver obligatoriska, harmoniserade europeiska säkerhetsdetaljer på alla receptbelagda läkemedelsförpackningar (med vissa riskbaserade undantag). Dessa säkerhetsdetaljer ska bestå av ett för varje enskild förpackning unikt identitetsbegrepp kombinerat med säkerhetsförsegling. Informationen om säkerhetsdetaljerna ska lagras i en databas och verifiering av varje förpackning ska göras i samband med dispensering till kund/patient. Målet är att förhindra förfalskade läkemedel att nå patienterna via den legala distributionskedjan. (Text hämtad ur ehälsomyndighetens dokument gällande Beskrivning av förändringar i VARA exportfil 4 (i release 17.1). Attribut everificationflag: string Returtyp DrugArticle eller DrugArticle[ ] Anger om förpackningen ska ha säkerhetsdetaljer eller inte enligt Artikel 54a(1) direktiv 2001/83/EU. Möjliga värden är Y (ja) och N (nej). Berör samtliga tjänster som returnerar ett objekt av typen DrugArticle eller en lista av object av typen DrugArticle[ ]. Exempel Anropet: getdrugarticlesbydrugid("19590602000075", False, -1) ger följande svar (vid detta dokuments upprättande) ett DrugArticle-objekt: [(DrugArticle){ articleno = 046748 aup = 0 aip = 0 aupfromdate = auptodate = barcode = 07046260467484 dddperpackage = 33.33 distributedtradename = Nozinan Sid 5/10
drugid = 19590602000075 interchangeableflag = N isantirecommended = True isrecommended = False isreimbursed = False marketedflag = N nplid = 19590602000075 nplpackid = 19590602100034 otcflag = N packsizemultiplier1 = 0 packsizemultiplier2 = 0 packsizenumeric = 100 packsizenumericunit = tablett(er) packsizetext = 100 tablett(er) limitedreimbursement = packagetext = Burk, 100 tabletter packagetypeinnercode = JAR prescribercodes[] = [ 1, 3 ] salesrestrictioncodes[] = [ - ] withdrawaldate = 2016-06-07 links[] = None (Link) eumano = dosdisponlyflag = N hospitaluseonlyflag = N everificationflag = N }] 5.2 Fass-länkar I Sil finns det länkar till webbresurser med vidare information om en läkemedelsprodukt, artikel eller substans. Det representeras genom attributet links med typen Link[ ] i de tre typerna DistributedDrug, DrugArticle och Substance. I Sil 5.1 (och eventuellt även i Sil 5.0 i och med huvudreleasen i Q3) kommer det också distribueras länkar till Fass för läkemedelsprodukter. Dessa länkar går till Fass-texter på Fass egen webbplats. DistributedDrug-typens links-attribut (av typen Link[]) kommer nu även innehålla Fass-länkar. Sid 6/10
Tex https://www.fass.se/lif/product?usertype=0&nplid=20150730000024&doctype=3 I ett antal fall kommer HTML-sidan (på Fass webbplats) inte innehålla en Fass-text, utan enbart information om varför texten inte visas. I enstaka fall kan det t.o.m. vara en länk till en sida som ger HTTP-fel 404 File not found. Sil kommer titta närmare på de fall där man får 404. Sil kommer för stunden skicka ut länkar för alla produkter, men detta kan komma att ändras. En sådan ändring är inte kopplad till en Sil SOAP API-release, utan anses vara en dataändring. När det gäller attributen name och url i Link-typen så kan även värdena för dessa ändras utan att det är kopplat till en Sil SOAP API-release. Dock kommer type att vara konstant och satt till FASS. Tidigare tjänster för att leverera Fass-texter är oförändrade i Sil 5.1. Planen är dock att i framtiden gå över till att endast leverera Fass-länkar och inte Fass-texter som det görs idag. När det gäller länkning till specifika rubriker i Fass-texter så kan det göras genom att lägga på ett # -tecken och därefter IDt för önskad Fass-rubrik till ovan nämnda Fass-länkar. Stöd för direktlänkning ska finnas för de rubriker som visas i Fass rull-lista Hitta direkt i texten exempelvis contraindication, pregnancy och breastfeeding. Tex https://www.fass.se/lif/product?user- Type=0&nplId=20150730000024&docType=3#breastfeeding 5.3 Ny tjänst: searchnondrugarticles I Sil 5.1 har en ny tjänst lagts till för indexerad fritextsökning mot handelsvaror. Tjänsten returnerar en lista med NonDrugArticleMatch-objekt som matchar sökningen på handelsvaror. Följande är indexerat: Nordiskt varunummer, leverantör eller distributör-namn, handelsvarans namn, förpackningsantal och enhet i klartext, beskrivning av förpackning, beskrivning av handelsvaran, gruppkod för handelsvaruprodukt, beskrivande svensk text av varugruppskod. Läs mer i Tjänstegränssnittsspecifikationen för Sil SOAP API 5.0 angående indexerade fritextsökningar. Inparametrar query: string flgcurrent: boolean Returtyp NonDrugArticleMatch[ ] Exempel Söksträng. Anger om svaret ska filtreras med avseende på tillgänglighet Lista med NonDrugArticleMatch-objekt. Anropet: searchnondrugarticles("medcore teststicka", True) Sid 7/10
returnerar alla sökträffar som matchar söktexten " Medcore teststicka" (2 stycken): [(NonDrugArticleMatch){ articleno = "732301" name = "MedCore Care, 10 styck, teststickor, glukos i blod avläses i MedCore Care blodglukosmätare" }, (NonDrugArticleMatch){ articleno = "732302" name = "MedCore Care, 50 styck, teststickor, glukos i blod avläses i MedCore Care blodglukosmätare" }] 5.4 Synonymkällan för biverkningar: Tillägg av wildcardsökning Tjänsten för att söka synonymer, getsynonymsto, har utökats med möjligheten att även använda wildcards vid sökning. Detta genom att ange wildcards i inparametern term. Läs mer i Tjänstegränssnittsspecifikationen för Sil SOAP API 5.0 angående wildcards. Inparametrar terminology: string term: string Returtyp string[ ] Exempel Anropet: getsynonymsto( sideeffects, ledvärk ) Namn på terminologi. För söksträngar gällande biverkningar: sideeffects. En term eller uttryck. Inparametern stödjer wildcards. Synonyma termer/uttryck. Inkluderar alltid den i inparametrarna angivna termen, så för en term som saknar synonymer returneras en lista med enbart den termen. returnerar alla synonymer till ledvärk: [ artralgi, atralgi, ledvärk, ledsmärta ]. Sökning med wildcard % getsynonymsto( sideeffects, yrs% ) returnerar synonymerna till yrsel: [ svindel, vertigo, yrsel ] Sid 8/10
5.5 Ordningsföljden på biverkningstabellerna I Sil 5.0 tillkom nyheten med taggade biverkningar och möjligheten att hantera SPC:er med fler än en tabell. Flera tabeller förekommer när man utöver generella biverkningar har data specifika för t ex vissa patientgrupper eller olika substanser inom ett läkemedel. I Sil 5.1 har vi lagt till en sorteringsordning på resultatet (ordningsföljden på biverkningstabellerna) som returneras ifrån tjänsten getsideeffectsbynplidlist. Effekten av detta blir att Sil SOAP API nu levererar ut taggade biverkningar i samma ordningsföljd som i indata från BIKT-källan vilket indirekt ger ordningsföljd för SPC tabell-layout. 5.6 Ny tjänst: getdateaddedbynplpackidlist I Sil 5.1 har en ny tjänst lagts till för att hämta information om tidpunkt för när en eller flera läkemedelsförpackningar kommit in i Sil. Tjänsten returnerar en lista med NplPackIdAddedToSil-objekt för de läkemedelsförpackningar vars NPL-packid:n är angivna i nplpackids. En NplPackIdAddedToSil -typ innehåller information om tidpunkt när en viss läkemedelsförpackning kommit in i Sil. Inparametrar nplpackids: string[ ] Returtyp NplPackIdAddedToSil[ ] Exempel Anropet: En lista med NPL-packid. En lista med NplPackIdAddedToSil-objekt. getdateaddedbynplpackidlist(["20110316100180", 20011214104754 ]) returnerar en lista med information om de tidpunkter när eftersökta läkemedelsförpackningar kommit in i Sil: [(NplPackIdAddedToSil){ nplpackid = 20011214104754 dateadded = 2005-01-01 00:00:00.000 }, (NplPackIdAddedToSil){ }] nplpackid = 20110316100180 dateadded = 2014-10-13 10:05:04.407 Sid 9/10
5.6.1 Ny typ: NplPackIdAddedToSil En NplPackIdAddedToSil-typ innehåller information om när en viss läkemedelsförpackning kom med i Sil. Attribut nplpackid: string dateadded: string Läkemedelsförpackningens NPL-packid. Tidpunkt för när läkemedelsförpackningen kom med i Sil. Sid 10/10