SIL SOAP API 4.2. Tjänstegränssnittsbeskrivning

Transkript

1 SIL SOAP API 4.2 Tjänstegränssnittsbeskrivning

2 Revisionshistorik Version Författare Kommentar 1.0 ( ) Paul Cohen Första utgåva. 1.1 ( ) Paul Cohen Rättat mindre fel i innehållsförteckningen. 1.2 ( ) Paul Cohen Tagit bort otydlig mening i avsnitt 2.2 Anpassningar till VARA 3 samt två förtydliganden i avsnitt 1.8 Datakällor i Sil. 1.3 ( ) Paul Cohen Uppdaterat avsnitt om hur ATC-koder och texter indexeras i de nya söktjänsterna. 1.4 () Paul Cohen Förtydligat information om läkemedelsformer och doseringsenheter. Korrigerat beskrivning av synonymerna läkemedelsartikel och förpackning. Mindre förtydligade av kod för FASS amningsgrupp och graviditetskategori. Sid 2/180

3 Innehåll 1. Inledning Avgränsningar Om detta dokument Lite grand om terminologi Programsystemet Sil Server med Sil SOAP API Teknisk lösning Allmänt om integration med Sil SOAP API Drift av Sil Server och uppdatering av Sil-databas Datakällor i Sil Demomiljö Definitioner Viktiga förändringar i Sil SOAP API Sammanfattning av förändringar Anpassningar till VARA Kompletterande substansinformation Kompletterande information om läkemedelsinstruktioner Kompletterande interaktionsinformation Objektmodell för läkemedelsinformation Produkttypsgrupper Söktjänster för information om läkemedelsprodukter, artiklar och substanser Om implementationen En läkemedelsprodukt utan parallellimporter: Aspirin En läkemedelsprodukt med parallellimporter: Stilnoct Substanser som börjar med tecknen Ace Sökning efter läkemedelsprodukter med söksträngen alvedon 500mg Tjänster Inledning Organisation och layout av beskrivningarna Felhantering ATC-koder getatcsbyatccode getatcsbytextsv getatcsbydrugid getatcnarrowersbyatccode getatcwiderbyatccode getatcsbyatccodeandlevelinterval Sid 3/180

4 4.4.7 getatcsbytextsvandlevelinterval getatcsbylevel getatcsbyatccodelist getdrugatccodesbydrugidlist getatccodedrugsbyatccodelist Atc DrugAtcCode AtcCodeDrug Parallellimporterade läkemedel getdrugsbyatccode getdrugsbydistributeddrugtradename getdrugbydrugid getdrugsbydrugidlist getdrugsbysubstancegroupid getdrugsbypharmaceuticalformgroupid getdrugsbystrengthgroupid getdrugidsbynplidlist Drug Läkemedelsprodukter getdistributeddrugsbydistributeddrugtradename getdistributeddrugbynplid getdistributeddrugsbynplidlist getdistributeddrugsbydrugid getdistributeddrugsbydrugidlist getdistributeddrughistoricalnamesbynplid getnplidsbydistributeddrughistoricalname getinterchangeabledistributeddrugsbynplid getdistributeddrugsbynplsubstanceid getdistributeddrugsbysubstancename getunauthoriseddistributeddrugsbysubstancename getunauthoriseddistributeddrugsbynplsubstanceid searchdistributeddrugs searchunauthoriseddistributeddrugs DistributedDrug Link DistributedDrugMatch Läkemedelsartiklar getdrugarticlesbydistributeddrugtradename getdrugarticlesbydrugid getdrugarticlesbydrugidlist getdrugarticlesbynplid Sid 4/180

5 4.7.5 getdrugarticlesbynplidlist getdrugarticlebynplpackid getdrugarticlesbynplpackidlist gethistoricalarticlenosbynplpackid getnplpackidsbydateadded gettlvexchangesbynplpackidlist searchdrugarticles searchunauthoriseddrugarticles DrugArticle DrugArticleMatch TlvExchange ExchangePeriod Läkemedelsförvaring getstoragesbynplpackid getstoragesbynplpackidlist Storage Läkemedelsformer och doseringsenheter getdrugforms getdrugformbydrugformcode DrugForm Dosage Rimlighetskontroll av dosering getdoserangesbynplid getdoserangesbynplsubstanceid GetDoseWeightRanges iswithindoserangefornplid iswithindoserangefornplsubstanceid iswithindoseweightrange DoseRange DoseWeightRange Läkemedelsinstruktioner getdruginstructionhealthcareunits getdruginstructions getdruginstructionsbydruginstructionid getdruginstructionsbyhealthcareunit getdruginstructionsbynplid gethealthcareunitbyid DrugInstruction HealthCareUnit Administreringssätt getdrugadministrationmethods Sid 5/180

6 getdrugadministrationroutes getdrugadministrationsites getdrugadministrationsbycodes getdrugadministrationsbyterms DrugAdministration Term FASS-texter getfassdocsbydrugid getfassdocbynplid FassDoc Interaktioner getdruginteractionsbydrugidagainstall getdruginteractionsbydrugidagainstlist getdruginteractionsbydrugidagainstlistsevclassification getdruginteractionswithindrugidlist getdruginteractionswithindrugidlistsevclassification getinteractionsbydrugidagainstall (deprikerad) getinteractionsbydrugidagainstlist (deprikerad) getinteractionsbydrugidagainstlistsevclassification (deprikerad) getinteractionswithindrugidlist (deprikerad) getinteractionswithindrugidlistsevclassification (deprikerad) getshortinteractionsbyinteractionidlist getcompleteinteractionbyinteractionid DrugInteraction ShortInteraction InteractionSection CompleteInteraction InteractingPart Reference Biverkningar getsideeffectsbynplidlist getsideeffectfrequencies getsideeffectsocs SideEffects SideEffect Graviditets- och amningsvarningar getwarningclassificationsbycode getsilpregnancylactationwarningsbynplidlist getjanusinfolactationdocsbynplidlist getjanusinfopregnancydocsbynplidlist getfasslactationdocsbynplidlist Sid 6/180

7 getfasspregnancydocsbynplidlist SILPregnancyLactationWarning SourceWarning WarningClassification JanusInfoLactationDoc JanusInfoPregnancyDoc JanusInfoReference JanusInfoLink FassPregnancyDoc FassLactationDoc Rekommenderade läkemedel getvalidregions getlisttypes getrecommendedlistinfosbyregionid gettherapygroups getindicationpaths getindicationpath getrecommendationsbynplpackidlist getrecommendationsbytherapygroupindicationname Region ListType TherapyGroup IndicationPath Indication RecommendedListInfo Recommendation IdentifierValue ShortIndication Utbytbarhet getsubstancegroups getsubstancegroupbysubstancegroupid getpharmaceuticalformgroups getpharmaceuticalformgroupbypharmaceuticalformgroupid getstrengthgroups getstrengthgroupbystrengthgroupid SubstanceGroup PharmaceuticalFormGroup StrengthGroup Ingredienser och substanser getsubstancesbynplsubstanceidlist getsubstancesbysubstancename Sid 7/180

8 getdistributeddrugcontentsbynplidlist getdistributeddrugcontentsbynplidlistfiltered searchsubstances Substance DistributedDrugContent Ingredient SubstanceName SubstanceCode SubstanceMatch Kortnotationer getshortencdosagetranslation Ordinationsorsaker getreasonforprescriptionbycode getreasonsforprescriptionbytext getreasonsforprescriptionbynplid getreasonsforprescriptionbycategorycode getreasonforprescriptioncategoriesbycode getreasonforprescriptioncategoriesbytext ReasonForPrescription ReasonForPrescriptionCategory TreatmentIntent Utsättningsorsaker gettreatmentwithdrawalreasons gettreatmentwithdrawalreasonbyid TreatmentWithdrawalReason Läkemedelsföretag getdistributeddrugorganizationsbynplidlist getdrugarticleorganizationsbynplpackidlist DistributedDrugOrganizations DrugArticleOrganizations RoleOrganization Organization Handelsvaror (icke-läkemedel) getnondrugarticlesbyarticlename getnondrugarticlesbyproductgroupcode getnondrugarticlesbyarticlenolist getnondruggroupbycode getnondruggroupparentsbycode getnondruggroups getnondruggroupsbycode getnondruggroupsbycodelist Sid 8/180

9 getnondruggroupsbytextsv NonDrugArticle NonDrugGroup Tjänster för läkemedelsidentifierare getnplpackidsbyarticlenolist getnplidsbysemanolist getdrugidsbysemanolist getsemanosbynplidlist getsemanosbydrugidlist IdPair Tjänster för samlad läkemedelsinformation (supertjänster) getsuperdrugsbydistributeddrugtradename getsuperdrugsbydrugidlist getsuperdrugsbynplidlist getsuperdrugsbyatccodelist getsuperdrugsbyatctextsv getunauthorisedsuperdrugsbydistributeddrugtradename getunauthorisedsuperdrugsbyatccodelist getunauthorisedsuperdrugsbyatctextsv getsuperdrugarticlesbynplpackidlist SuperDrug SuperDrugArticle Referensdatatjänster getdrugclassifications getdrugclassificationbycode getcontrolclasses getcontrolclassbycode getrouteofadministrations getrouteofadministrationbycode getprescribers getprescriberbycode getproducttypes getproducttypebycode getprescriptions getprescriptionbycode getstrengthnumericunits getstrengthnumericunitbycode getorganizationroles getorganizationrolebycode getcountries getcountrybycode Sid 9/180

10 getdosdisplifeunits getdosdisplifeunitbycode getpackagetypeinners getpackagetypeinnerbycode getpackconditions getpackconditionbycode getstoragetemps getstoragetempbycode getsalesrestrictions getsalesrestrictionbycode getpacksizenumericunits getpacksizenumericunitbycode getshelflifeunits getshelflifeunitbycode getstorageconditions getstorageconditionbycode getingredientroles getingredientrolebycode getquantityunits getquantityunitbycode getalternativequantityunits getalternativequantityunitbycode getcomprefquantities getcomprefquantitybycode getsilproducttypegroups getrxrepeatablebycode getrxrepeatables getdispensingrestrictionbycode getdispensingrestrictions DrugClassification ControlClass RouteOfAdministration Prescriber ProductType Prescription StrengthNumericUnit OrganizationRole Country DosdispLifeUnit PackageTypeInner PackCondition Sid 10/180

11 StorageTemp SalesRestriction PackSizeNumericUnit ShelfLifeUnit StorageCondition IngredientRole QuantityUnit AlternativeQuantityUnit CompRefQuantity RxRepeatable DispensingRestriction Versionsinformation getdataversions getapiversion DataVersion ApiVersion Sid 11/180

12 1. Inledning Detta dokument beskriver Sil SOAP API 4.2. Sil SOAP API är ett read-only API för åtkomst till information om alla läkemedelsprodukter och förpackningar i Sverige samt om handelsvaror (icke-läkemedel) inom förmånen, d.v.s. som omfattas av TLV:s subventioner enligt deras nämnd för läkemedelsförmåner. Utöver detta har även API:et andra läkemedelsrelaterade tjänster som rör substanser, interaktioner, amnings- och graviditetsvarningar, biverkningar, ordinationsorsaker, utsättningsorsaker, administreringssätt, kortnotationer, rimlighetskontroller för doseringar samt åtkomst till FASS-texter och produktblad för rikslicenser. Dokumentet vänder sig till systemutvecklare som vill integrera Sil i journalsystem, andra expert- och beslutsstödsystem för vården eller i system för redaktion av kunskapsdatabaser för läkemedel. Det förutsätts att läsaren förstår vad ett API är, vad ett SOAP API är och hur man programmerar mot API:er. För en mer komplett och verksamhetsorienterad beskrivning av nytta och möjligheter med tjänster och informationen i Sil hänvisas läsaren till de olika integrationshandledningar för olika grupper av tjänster som Sil tillhandahåller. Den senaste versionen av detta dokument och integrationshandledningarna finns att hämta på Sil:s hemsida Avgränsningar Detta dokument beskriver inte hur man installerar eller sköter drift av en Sil Server med Sil SOAP API och tillhörande Sil-databas. För information om det, se dokumentet Installation och drift av Sil Server 4.2. Se Sil:s hemsida för senaste version av det dokumentet. 1.2 Om detta dokument Sil SOAP API är ett omfattande API och det är en utmaning dels att dokumentera det på ett sådant sätt att det är lätt att förstå och hitta i dokumentationen och dels att dokumentera ändringar i en ny release så att man snabbt kan få en överblick av vad som är nytt. Detta dokument är indelat i kapitel baserat på en gruppering av API-tjänsterna och typer (populärt och tidigare kallat objekt) utifrån den information de berör. Den övergripande beskrivningen av förändringarna i Sil SOAP API 4.2 gentemot 4.1 beskrivs i kapitlet 2 Viktiga förändringar i Sil SOAP API 4.2. Vi tar gärna emot kommentarer och synpunkter på hur vi kan förtydliga och förbättra dokumentationen för systemutvecklare och andra som läser denna dokumentation. Frågor och synpunkter kan skickas till sil. 1 Se: il / Sid 12/180

13 1.3 Lite grand om terminologi I tjänstegränssnittsbeskrivningen av Sil SOAP API har under många år termen SOAP-objekt använts, lite slarvigt, både för att referera till de databärande typerna i WSDL-filen för SOAP API:et och till konkreta instanser av dessa typer. I denna utgåva av dokumentet har vi valt att göra en distinktion och förtydliga användningen av dessa termer. Termen typ avser nu en namngiven databärande datatyp i WSDL-filen för SOAP API:et. T.ex. DistributedDrug som representerar en läkemedelsprodukt. Termen objekt används för att referera till en konkret instans av en sådan typ. T.ex. ett DistributedDrug-objekt med NPL-id och handelsnamn Aspirin. 1.4 Programsystemet Sil Server med Sil SOAP API Sil SOAP API innehåller 191 read-only-tjänster (som returnerar 95 typer av objekt) som ger åtkomst till information om läkemedel. Sil SOAP API använder internt en databas som kallas för Sil-databasen. Hela programsystemet som består av Sil SOAP API tillsammans med Sildatabasen kallas för Sil Server med Sil SOAP API. En ny version av Sil Server med Sil SOAP API releasas varje år, oftast i Q3. Det är alltid två versioner av Sil SOAP API som stöds parallellt. Med stöds menas att Sil-databaser produceras och att support ges för två versioner. Sil:s förvaltningsgrupp på Inera producerar och publicerar en ny Sil databas, för båda versioner av aktuella Sil SOAP API:er, varje vecka (på onsdagar) och publicerar dem på Sil:s SFTPserver. FASS-texter och annan FASS-information uppdateras i den publicerade databasen på SFTP-servern alla vardagar utom röda dagar. 1.5 Teknisk lösning Sil SOAP API är implementerat i Java med Metro (JAX-WS RI) och Tomcat samt med Microsoft SQL server som databassystem för Sil-databasen. 1.6 Allmänt om integration med Sil SOAP API För att integrera ett journal- eller vårdsystem med Sil SOAP API krävs dels att man programmerar sitt system så att det utför de anrop man vill mot Sil SOAP API och dels att man har tillgång till en installation av en Sil Server med Sil SOAP API och aktuell Sil-databas som systemet kan anropa när det körs. För att integrera med Sil SOAP API krävs att man använder WSDL-filen för Sil SOAP API. Man kan antingen använda WSDL-filen och generera SOAP-klientstubbar för den utvecklingsmiljö och det programmeringsspråk som man utvecklar med eller programmera manuellt mot den. WSDL-filen för Sil SOAP API 4.2 kommer man åt på den URL där man gjort sin installation av Sil Servern med Sil SOAP API. Om man inte har en egen installation av Sil Server kan man använda wsdl-filen som man kommer åt på demoservern för Sil SOAP API (se kapitel 1.9 Demomiljö). Sid 13/180

14 All integration med Sil Server med Sil SOAP API ska ske via SOAP API:et. Man får inte använda Sil-databasen direkt eller via Microsoft SQL server från sitt system. För att få tillgång till programvaran Sil Server med Sil SOAP API och tillgång till Sil:s SFTPserver måste man ha Sil integrations- och/eller driftavtal med Inera. 1.7 Drift av Sil Server och uppdatering av Sil-databas Ansvaret för att ett journal- eller vårdsystem har tillgång till, och anropar, rätt version av en Sil Server med Sil SOAP API och en aktuell och uppdaterad databas, ligger på den som ansvarar för drift av respektive journal- och vårdsystem. Oftast är det landstingens IT-driftorganisationer som ansvarar för detta. Inera tillhandahåller alltså inga Sil Servrar i drift utöver ett par demoservrar som kan användas för att lära sig om Sil SOAP API eller för prototyputveckling. Dessa demoservrar får och ska inte användas för skarp drift eller systemtest inför leverans. I framtiden kan Inera komma att tillhandahålla nationella Sil-servrar i skarp drift. Aktuella och uppdaterade Sil-databaser kan laddas ner från Sil:s SFTP-server och uppdatering sker genom att göra ett kortare driftstopp (på ca 1 minut) på Sil Servern och då skriva över Sildatabasen med en ny version av hela Sil-databasen. En driftorganisation kan installera och konfigurera en driftmiljö med flera Sil Servrar för lastbalansering och för att kunna uppdatera Sildatabaserna på dessa utan att anropande system upplever någon nertid på Sil Servrarna. För att alltid ha aktuell Sil information krävs alltså att driftansvariga för lokala Sil Servrar ser till att ladda ner och uppdatera sin lokala Sil Server med en ny Sil-databas varje natt. Sid 14/180

15 1.8 Datakällor i Sil Informationen om läkemedel i Sil-databasen kommer från ett antal olika källor och importeras till Sil:s interna produktionssystem varje vecka. Efter att informationen validerats och granskats skapas sedan en ny Sil-databas som publiceras på Sil:s SFTP-server. Källorna som används i Sil 4.2 är: a) VARA från ehälsomyndigheten. VARA används som grundkälla för information om läkemedelsprodukter och artiklar. Informationen i VARA om läkemedelsprodukter och artiklar samt handelsvaror inom förmånen kommer i sin tur från ehälsomyndigheten, Läkemedelsverket, TLV samt läkemedelsföretagen. b) NSL från Läkemedelsverket. Denna informationen är den som returneras i tjänsterna för substanser. c) SFINX från SLL/JanusInfo. Denna informationen är den som returneras i tjänsterna för interaktioner. d) FASS från LIF. e) Amning & graviditetsvarningar från LIF/FASS. Denna informationen är, tillsammans med den från Amning & Fosterskador från SLL/JanusInfo, den som returneras i tjänsterna för graviditets- och amningsvarningar. Det är alltså två källor som används i de tjänsterna. f) Amning & Fosterskador från SLL/JanusInfo. Denna informationen är, tillsammans med den från Amning & graviditetsvarningar från LIF/FASS, den som returneras i tjänsterna för graviditets- och amningsvarningar. Det är alltså två källor som används i de tjänsterna. g) Kortnotationer och Doseringsregistret från Sil. Detta register underhålls av Sil och baseras på beredningsformer i VARA. h) Utsättningsorsaksregistret från Sil. Detta register underhålls av Sil och uppdateras i enlighet med önskemål från referensgruppen för Läkemedel. i) Administreringskällan från Sil. Denna källa underhålls av Sil och togs ursprungligen fram för att stödja API-tjänster som har med eped att göra. Den uppdateras efter behov för administreringsvägar i eped:s källa med rimlighetetskontrollinformation. j) Regionala rekommendationslistor med rekommenderade läkemedel. Denna källa underhålls av Läkemedelsområdeskommittéerna (LOK) i varje region/landsting. k) Nationell lista Undvik till äldre. Denna lista underhålls av Sil och baseras på Socialstyrelsens lista Olämpliga läkemedel för äldre. l) Nationell lista Läkemedel under utökad övervakning. Denna lista underhålls av Sil baserat på den lista som EMA underhåller. Denna lista kommer att ersättas av information i VARA 3. m) Läkemedelsinstruktioner från eped. Denna information är den som returneras i tjänsterna för läkemedelsinstruktioner. Sid 15/180

16 n) Rimlighetskontrollregistret från eped. Denna information är den som returneras i tjänsterna för rimlighetskontroll av dosering. o) BIKT (Biverkningsöversikt) från SIDI i samarbete med Sil. Denna källa baseras på extrahering av biverkningstabeller från produktresuméer från Läkemedelsverket och EMA (Europeiska Läkemedelsmyndigheten). p) Nationell Källa för Ordinationsorsaker. Innehåller även behandlingsändamål. Innehållet förvaltas av Socialstyrelsen, men systemet för underhåll och publicering av tillhandahålls av ehälsomyndigheten, q) APL produktblad för rikslicenser från APL. En källa kommer att tillkomma i Sil 4.2 i slutet av 2016 eller början av 2017: a) DHPC från Läkemedelsverket. Dessa kallas också för dear doctor letters. Det finns redan i releasen av Sil SOAP API 4.2 stöd för länkar till dessa i API:et men information från källan, för distribution via länkar i Sil SOAP API, kommer först i slutet av 2016 eller början av Demomiljö För att kunna testa sin integration mot Sil API måste man ha åtkomst till en installation av Sil Servern med Sil SOAP API och en Sil-databas. För initial prototyputveckling och test kan man använda en demoserver med Sil SOAP API 4.2 som är åtkomlig på Internet: För att kunna göra kontrollerade tester och systemtester med Sil SOAP API och sitt journalsystem eller beslutsstödsystem ska man använda en egen kontrollerad installation av Sil Servern med en Sil-databas. Den bör då ha ett väldefinierat innehåll för de tester man vill göra. För åtkomst till Sil:s demoserver måste man skicka in en ansökan till Inera om åtkomst till servern, där man deklarerar ansvarig kontaktperson, syfte med åtkomst samt från vilken eller vilka IP-adresser man vill anropa demoservern. Se Sil:s hemsida för mer information och för en ansökningsblankett. Sid 16/180

17 1.10 Definitioner Term Amningsgrupp (LIF/FASS) Förklaring LIF/FASS klassificering av ett läkemedels dokumenterade effekt på dibarn under amningsperioden. Följande amningsgrupper finns: I: Passerar ej över i modersmjölk. II: Passerar över i modersmjölk men risk för påverkan på barnet synes osannolik med terapeutiska doser. III: Passerar över i modersmjölk i sådana mängder att risk för påverkan på barnet föreligger även med terapeutiska doser. IVa: Uppgift saknas om passage över i modersmjölk. IVb: Uppgift om passage över i modersmjölk är otillräcklig för att bedöma risken för barnet. För mer information om dessa se: Amningsriskklass (SLL/JanusInfo) SLL/JanusInfo klassificering av ett läkemedels dokumenterade effekt på barn under amnings perioden. Följande riskklasser finns: 1: Förenligt med amning. 2: Särskilda överväganden och/eller med förbehåll. 3: Amning avrådes. För mer information om dessa se: Anti-rekommendation En lista med rekommenderade läkemedelsartiklar kan innehålla antirekommendationer i betydelsen att de uttrycker en rekommendation att inte förskriva läkemedelsartikeln (under vissa villkor). Anti-rekommendationer kombineras vanligtvis med en hänvisningsrekommendation till en alternativ nivå 7 ATC-kod. Anti-rekommendationer kallas också noll-rekommendationer. ATC-kod EMA eumano FASS-text Graviditetskategori (LIF/FASS) Klassifikationssystem för läkemedel som baseras på deras anatomiska, terapeutiska och kemiska egenskaper. Sil innehåller endast de ATC-koder för vilka det finns minst en registrerad läkemedelsprodukt hos Läkemedelsverket. European Medicines Agency. Europeiska Läkemedelsverket. En läkemedelsprodukts europeiska godkännandenummer. Fastställs av EMA. Beskrivning av läkemedelsprodukter som ges ut av LIF. FASS-texten baseras på den läkemedelsproduktens produktresumé (SPC) som är registrerad hos Läkemedelsverket. LIF/FASS klassificering av ett läkemedels dokumenterade effekt på graviditet vid klinisk användning på människor i rekommenderade terapeutiska doser. Följande graviditetskategorier finns: A, B, B:1, B:2, B:3, C, D. För mer information om dessa se: Graviditetsriskklass (SLL/JanusInfo) SLL/JanusInfo klassificering av ett läkemedels dokumenterade effekt på graviditet vid klinisk användning på människor i rekommenderade terapeutiska do- Sid 17/180

18 Term Handelsnamn Handelsvara Icke-läkemedel Läkemedelsartikel Läkemedelsförpackning Läkemedelsform Läkemedelsprodukt Parallellimporterat läkemedel Rikslicens semano Förklaring ser. Följande graviditetsriskklasser finns: 1: Läkemedlet kan användas under graviditet utan ökad risk för fostret. 2: Det finns viktig information att ta del av om det här läkemedlet under graviditet. 3: Läkemedlet kan eller misstänks kunna medföra betydande risker för fostret vid användning under graviditet. För mer information om dessa se: Ett läkemedels försäljningsnamn (produktnamn). Handelsnamn kan både vara registrerade varumärkesnamn ( ) eller ej registrerade varumärkesnamn ( ). I Sil avser termen handelsvara en förskrivningsbar artikel inom förmånen som kan expedieras av apotek men som inte innehåller läkemedel. I Sil är termerna handelsvara och icke-läkemedel synonymer. : Zetuvit E", 25 styck, sterilt absorbationsförband. I Sil SOAP API representeras de av dataobjektet NonDrugArticle. I Sil är termerna läkemedelsartikel och "läkemedelsförpackning" synonymer och avser en hos Läkemedelsverket registrerad läkemedelsartikel med unikt NPL-packid. Den hör till ett och endast ett distribuerat läkemedel. I Sil SOAP API representeras det av dataobjektet DrugArticle. Utformning av bruksfärdigt läkemedel. Läkemedelsformer för invärtes bruk är t.ex. tabletter, dragéer, kapslar och mixturer; för utvärtes bruk t.ex. salvor, krämer, liniment och puder. Beredningsform är en synonym. I Sil avser termen "läkemedelsprodukt" (DistributedDrug) en hos Läkemedelsverket registrerad läkemedelsprodukt med unikt NPL-id. En läkemedelsprodukt har en unik kombination av handelsnamn, läkemedelsform, styrka och ansvarigt företag. I Sil avser termen "parallellimporterat läkemedel" den gemensamma information som ska gälla för alla läkemedelsprodukter som är parallellimporter till en given läkemedelsprodukt. Parallellimporterade läkemedelsprodukter har typiskt samma unika kombination av handelsnamn, läkemedelsform och styrka men olika ansvariga företag. Ibland kan dock även handelsnamnet skilja sig inom en grupp av parallellimporterade läkemedelsprodukter. Den gemensamma informationen om Parallellimporterade läkemedelsprodukter representeras i Sil SOAP API av dataobjektet Drug och identifieras med drugid. Informellt namn på läkemedelsprodukter som är lagerberedningar som har licenstillstånd från Läkemedelsverket för försäljning och i volym som omfattar ett nationellt behov av lagerberedningen. Detta gäller lagerberedningar där tillverkningen ökat till mer än 1000 förpackningar per år. En läkemedelsprodukts svenska godkännandenummer. Fastställs av Läkemedelsverket. Sid 18/180

19 2. Viktiga förändringar i Sil SOAP API 4.2 SIL SOAP API 4.2 är tekniskt bakåtkompatibelt med SIL SOAP API 4.1. Med detta menas att ingenting som fanns i det tidigare API:et har tagits bort, utan skillnaden handlar uteslutande om saker som lagts till; 15 nya tjänster, 11 nya typer och 6 modifierade typer som fått nya 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 objekten/tjänsterna/attributen, även om man inte tänkt använda dem omedelbart. Nya systemtest rekommenderas starkt vid migrering från 4.1 till Sammanfattning av förändringar Sil SOAP API 4.2 innehåller 191 SOAP-tjänster och 95 SOAP-typer. Sil SOAP API 4.1 innehåller 176 SOAP-tjänster och 84 SOAP-typer. Dessutom har 6 SOAP-typer som finns både i 4.2 och 4.1 ändrats genom att attribut har tillkommit i dem i 4.2. De förändringar som skett omfattar följande: a) Den nya källan Nationell Källa för Ordinationsorsaker har tillkommit och nya tjänster och datatyper för denna information har lagts till i API:et. Källan underhålls av Socialstyrelsen och tillgängliggörs tekniskt av ehälsomyndigheten. Se inledningen av kapitel 4.21 Ordinationsorsaker för en beskrivning av denna källa och de tillhörande tjänsterna. b) Stöd för länkar till webbresurser om läkemedelsprodukter, artiklar och substanser har till kommit i form av attributet links. Initialt finns länkar till APL produktresuméer (en ny källa från APL) för läkemedelsprodukter som är rikslicenser samt stöd för länkar till DHPC-dokument (dear doctor letters) från Läkemedelsverket. Denna information kommer att bli tillgänglig i slutet av Se avsnitt Link i kapitel 4.6 Läkemedelsprodukter. c) Nya söktjänster för läkemedelsprodukter, artiklar och substanser har lagts till i API:et. Dessa möjliggör Google-liknande sökningar i användargränssnitt. Se avsnitten searchdistributeddrugs, searchunauthoriseddistributeddrugs, searchdrugarticles, searchunauthoriseddrugarticles och searchsubstances. d) Anpassningar till förändringar i källan VARA. Under hösten 2016 kommer ehälsomyndigheten att göra förändringar i struktur och innehåll i källan VARA 2 som är grundregistret för läkemedelsprodukter och artiklar i Sil. Förändringarna kommer att tillgängliggöras som en ny version av källan, VARA 3. Detta innebär att Sil har tvingats göra vissa anpassningar i Sil SOAP API så att man ska hantera övergången mellan VARA 2 och VARA 3 på ett bra sätt. Se avsnitt 2.2 Anpassningar till VARA 3 för mer information. e) NSL (Nationellt Substansregister för Läkemedelsprodukter) från Läkemedelsverket är nu huvudkällan för all information om substanser. Tidigare användes viss information från VARA och viss information från NSL. Se avsnitt 2.3 Kompletterande substansinformation. Sid 19/180

20 f) Informationen om läkemedelsinstruktioner från källan eped har kompletterats med ytterligare information. Se avsnitt 2.4 Kompletterande information om läkemedelsinstruktioner. g) Interaktionsinformationen från Sfinx har kompletterats med information om läkemedelsform. Se avsnitt 2.5 Kompletterande interaktionsinformation. 2.2 Anpassningar till VARA 3 ehälsomyndigheten kommer att ta VARA 3 i produktion i november Produktion av VARA 2 kommer att fortsätta under en tvåårsperiod. Då Sil SOAP API 4.2 releasas, kommer Sil att fortsätta basera veckoproduktion av Sil 4.1 och Sil 4.2 på VARA 2. Vid ett senare tillfälle kommer Sil att ändra sin veckoproduktion till att baseras VARA 3. Datum för detta är ännu inte fastställt men troligtvis kommer det att ske i Q Då VARA 3 innehåller viss information som inte VARA 2 innehåller, kommer vissa nya attribut i Sil SOAP API 4.2 inte ha värden förrän Sil:s veckoproduktion har gått över till VARA 3. Förändringarna i VARA 3 gentemot VARA 2 är: a) Läkemedelsprodukter har nu ett attribut additionalmonitoringflag som anger om läkemedlet är under utökad övervakning. Detta ersätter den tidigare källan i Sil Nationell lista läkemedel under utökad övervakning som tillgängliggjordes i Sil SOAP API via en rekommendationslista för läkemedel under utökad övervakning. Nu ska man använda det nya attributet i stället och källan Nationell lista läkemedel under utökad övervakning kommer att tas bort i nästa version av Sil SOAP API (2017). I Sil 4.2 underhålls källan Nationell lista läkemedel under utökad övervakning men utan kommentarer för varje läkemedel. Detta attribut kommer att ha uppdaterade värden även när Sil:s produktion baseras på VARA 2. Värdet baseras på den nämnda källan fram tills dess att Sil:s produktion går över till VARA 3. b) VARA 3 hanterar information om särskilda läkemedel och iterering i två separata attribut controlleddrugflag respektive rxrepeatablecode i typen DistributedDrug istället för som tidigare gemensamt i ett attribut drugclassificationcode i typen Drug. Det gemensamma attributet kommer att fortsätta uppdateras men man ska anpassa sina system att istället använda de två nya attributen då det gemensamma attributet kommer att tas bort i nästa release av Sil SOAP API (2017). Attributen controlleddrugflag och rxrepeatablecode kommer att ha uppdaterade värden även när Sil:s produktion baseras på VARA 2. Värdena baseras på värdet av drugclassificationcode i VARA 2 fram tills dess att Sil:s produktion går över till VARA 3. Nyheterna som baseras på ny information i VARA 3 är: a) Europeiskt godkännandenummer (eumano) finns nu angivet för både läkemedelsprodukter och artiklar i form av attributet eumano. b) Läkemedelsprodukter har nu ett attribut antidotflag som anger om de är klassificerade som antidot enligt GIC (Giftinformationscentralen). Sid 20/180

21 c) Läkemedelsprodukter har nu ett attribut dispensingrestrictioncode som anger om de har restriktioner för utelämnande. d) Läkemedelsprodukter har nu ett attribut nationallicenseflag som anger om de är en godkänd rikslicens. Detta attribut kommer att ha uppdaterade värden även när Sil:s produktion baseras på VARA 2. Värdet baseras på om läkemedelsprodukten har en länk till ett APL-produktblad fram tills dess att Sil:s produktion går över till VARA 3. e) Läkemedelsartiklar har nu två nya attribut; dosdisponlyflag och hospitaluseonlyflag som anger om artikeln endast får användas för dosdispensering och endast för sjukhusbruk. f) Läkemedelsartiklar och handelsvaror inom förmånen har nu information om apotekens inköpspris (aip) samt från- och tilldatum (aupfromdate och auptodate) för när artiklar och handelsvaror ingår i förmånen (enligt TLV). 2.3 Kompletterande substansinformation I Sil SOAP API 4.2 tillgängliggörs mer information från NSL (Nationellt Substansregister för Läkemedel) än tidigare. Detta innebär att man nu får tillgång till alternativa namn på svenska men också på engelska samt tillgång till diverse olika koder som finns associerade med varje substans som bl.a. ATC-koder. Läkemedelsverket har också kompletterat NSL med information om narkotikaklass för varje substans. Denna information finns nu också tillgänglig för varje substans i Sil SOAP API. Substanstjänsterna kan användas på flera olika sätt i journal- och beslutsstödsystem. Generellt erbjuder de möjlighet att implementera stöd för ett generiskt förhållningssätt vid ordination av läkemedel. Konkret innebär det att man bl.a. kan erbjuda stöd för sökning efter läkemedelsprodukter utifrån aktiv substans, men man kan också vid val av en läkemedelsprodukt kan visa namn på ingående aktiva substanser på ett bra sätt. Då Sil SOAP API också används som grundsystem i olika redaktionssystem för evidensbaserade kunskapskällor inom läkemedelsområdet, möjliggör substanstjänsterna att dessa redaktionssystem kan arbeta med substanser som utgångspunkt. I sådana system är det värdefullt att ha tillgång till ATC-koder och CAS-nummer för substanser. 2.4 Kompletterande information om läkemedelsinstruktioner Sil SOAP API innehåller sedan 4.1 information om läkemedelsinstruktioner från eped. På sikt kan läkemedelsinstruktioner från andra källor tillkomma. Dataobjekten med information om läkemedelsinstruktioner har i 4.2 kompletterats med sju attribut (hasreformulated, hasadditions, strengthnumeric, strengthnumericunit, strengthtext, drugformcode, drugformtextsv) som beskriver de läkemedel som ska administreras enligt läkemedelsinstruktionen. Dessa attribut har att göra med om läkemedlet har annan styrka och läkemedelsform än det som finns i de läkemedelsprodukter som läkemedlet baseras på, eller om det tillkommer några nya substanser som inte finns i de läkemedelsprodukterna. Sid 21/180

22 Det är viktigt att uppmärksamma ordinatören eller personen som iordningställer eller administrerar läkemedlet på om det läkemedlet man väljer i varusortimentet för ordination, iordningställandet eller administrering skiljer sig från det läkemedlet man utgår ifrån i läkemedelsinstruktionen. Skillnaderna kan vara att läkemedlet från varusortimentet har en annan styrka eller form än den man baserar sin ordination på eller att det innehåller flera substanser än utgångsläkemedlet. I Sil SOAP API 4.2 får man sammanfattnings nu följande information om en läkemedelsinstruktion: a) Läkemedlet i läkemedelsinstruktionen har annan styrka eller läkemedelsform än de läkemedelsprodukter det baseras på. b) Läkemedlet innehåller andra substanser än de läkemedelsprodukter det baseras på. Denna information är viktig att presentera till ordinatören vid ordination samt till personer som iordningställer eller administrerar läkemedlet. 2.5 Kompletterande interaktionsinformation Sil SOAP API har länge haft information om läkemedelsinteraktioner från interaktionsdatabasen Sfinx. Läkemedelsinteraktioner är beroende av sättet hur läkemedlet administreras. Till exempel är det ofta ingen interaktion mellan två substanser när ett läkemedel tillförs topikalt (via huden). I interaktionskällan Sfinx har man alltid tagit hänsyn till administrering av läkemedlet men den informationen har inte tillgängliggjorts i Sil SOAP API. Man har bara tagit hänsyn till administrering och läkemedelsform när informationen om interaktioner las in i Sfinx, men själva informationen visades aldrig. I Sil SOAP API 4.2 finns nu för varje interaktion mellan två substanser också information om vilken administrering (administration1 och administration2) som avses för varje substans. Vidare finns information om vilka ingående substanser som interagerar (name1 och name2). Den nya informationen kan användas för att tydliggöra vilka substanser som kan ge upphov till en viss interaktion och att den interaktionen uppstår när produkterna administreras på ett visst sätt. Sid 22/180

23 3. Objektmodell för läkemedelsinformation Sil SOAP API tillhandahåller tjänster för att komma åt information om förskrivningsbara läkemedel och handelsvaror (icke-läkemedelsvaror) inom förmånen. Denna information är tillhandahålls via ett antal tjänster och informationsobjekt som var och en representerar olika förskrivnings- och läkemedelsrelaterade begrepp. För läkemedelsinformation finns tre viktiga objekt; Drug (parallellimporterade läkemedel), DistributedDrug (läkemedelsprodukt) och DrugArticle (läkemedelsartikel). Ett DistributedDrug-objekt representerar en hos Läkemedelsverket registrerad läkemedelsprodukt med unikt NPL-id. Ett DistributedDrug-objekt identifieras med NPL-id och har en unik kombination av handelsnamn, läkemedelsform, styrka och ansvarigt företag. Ett Drug-objekt representerar en grupp parallellimporterade läkemedel. Drug-objekt innehåller den gemensamma information som ska gälla för alla läkemedelsprodukter som är parallellimporter till någon läkemedelsprodukt. Det finns således alltid ett Drug-objekt även för sådana läkemedelsprodukter som saknar faktiska parallellimporter. Nedan ges en översiktlig bild av relationen mellan de grundläggande läkemedelsobjekten Drug, DistributedDrug och DrugArticle samt dess tillhörande, huvudsakliga identifierare. Alla läkemedelsprodukter som ingår i en grupp parallellimporter har vanligtvis samma unika kombination av handelsnamn, läkemedelsform och styrka men olika ansvariga företag. Ibland kan dock handelsnamnet skilja sig inom en grupp av parallellimporterade läkemedelsprodukter. I detta fall har Drug-objektet ett handelsnamn som består av handelsnamnet på originalläkemedelsprodukten följt av tecknet '*'. Drug-objekt innehåller vidare gemensam läkemedelsinformation som gäller för alla läkemedelsprodukterna inom en grupp av parallellimporter. Ett DrugArticle-objekt representerar en hos Läkemedelsverket registrerad läkemedelsartikel med unikt NPL-packid. Den hör till ett och endast ett distribuerat läkemedel. En läkemedelsartikel innehåller oftast en förpackning men den kan innehålla fler förpackningar med olika innehåll, Ett exempel är infusionsvätskor som måste blandas innan de administreras. Sid 23/180

24 3.1 Produkttypsgrupper I Sil finns en gruppering av läkemedelsprodukttyper. Denna gruppering styr vilken information som returneras av en del tjänster i Sil SOAP API. Produkttypsgrupperna är idag: APPROVED. Avser godkända läkemedelsprodukter. Omfattar produkttyperna MEP, ALL, VBL, RAP, NLM, VUM och NIN. NON_APPROVED. Avser ej godkända läkemedelsprodukter. Omfattar produkttyperna APL och LIC. TRADITIONAL. Avser traditionella läkemedelsprodukter. Omfattar produkttypen TVB. Mer information om denna klassificering av läkemedel finns att hitta på Läkemedelsverkets hemsida. Skriften Receptföreskrifter tolkningar och kommentarer 2 från Apotekarsocieteten har också en bra övergripande beskrivning av alla olika typer av läkemedel. 3.2 Söktjänster för information om läkemedelsprodukter, artiklar och substanser Sil SOAP API erbjuder två olika sorters tjänster för att hämta läkemedelsinformation om produkter, artiklar och substanser. De traditionella tjänsterna har namn som börjat med get och möjliggör att man kan hämta information om informationsobjekt med ett givet id (NPL-id, NPL-packid, NPL-substansid och ATC-kod) eller som har ett namn som matchar en viss sträng. I 4.2 har API:et utökats med en annan typ av tjänster för åtkomst till läkemedelsinformation i form av rena söktjänster. Dessa baseras på att flera olika attribut på informationsobjekten indexeras så att informationsobjekten blir sökbara mer på det sätt man är van vid i Google-sökningar. Dessa tjänster kan användas för att erbjuda fritextsökningsliknande stöd i användargränssnitt Om implementationen Sil SOAP API använder Lucene 3 för att implementera informationssökningen i Sil-databasen som dessa tjänster erbjuder. Sökningen baseras på att alla DistributedDrug- och DrugArticle-objekt förindexeras på ett antal attributvärden. Man kan, med hjälp av dessa söktjänster, erbjuda enkla sökfält där man kan ange söksträngar som Alvedon 500mg eller Paracetamol tablett och snabbt kan visa användaren samtliga läkemedelsprodukter som matchar de söksträngarna. Indexerade attribut DistributedDrug-objekt indexeras på följande attributvärden: a) Handelsnamn b) NPL-id c) Beredningsform (tablett, etc.) d) Styrketext 2 Se URL: 3 Apache Lucene är ett open-source licenserat mjukvarubibliotek för informationssökning (information retrieval) som är skrivet i Java. Det har stöd för en mängd informationsökningstekniker för fulltextindexering och används ofta i, och tillsammans med, olika dokumentbaserade system och databassystem. URL: Sid 24/180

25 e) Substansnamn för alla ingredienser f) NPL-substansid för alla ingredienser g) ATC-kod och ATC-text för läkemedelsproduktens ATC-kod DrugArticle-objekt indexeras på samma attribut som ovan och dessutom även på följande attributvärden: a) NPL-packid b) Förpackningstext c) Förpackningsstorlek d) Varunummer Substance-objekt indexeras på följande attributvärden: a) Substansnamn b) NPL-substansid c) Substansnamn på engelska d) Samtliga substanskoder och alternativa substansnamn. Indexeringsteknik och sökstöd Det förutsätts att läsaren har en grundläggande förståelse för informationssökning och etablerad terminologi inom det området. Förutom att indexeringen görs med hjälp av ovan nämnda attribut har en mängd andra beslut tagits avseende implementation av indexeringen och sökning. Innan indexering görs sker både tokenisering och stemming. Tokeniseringen delar upp indexerbara termer och gör en viss bearbetning för att hantera specialtecken. En svensk snowball stemmer används. Den normaliserar böjningar på ord (tabletter == tablet), men bara om ursprungsordet är >= 5 tecken. Ett filter tillämpas för att göra alla tecken till gemener används, så att ingen skillnad på gemener och versaler görs. För sökning gäller: a) Om en sökterm är >= 3 tecken tillämpas en implicit prefixsökning på de termerna. Det innebär t.ex. att para tolkas som para* och tab tolkas som tab*. b) Om en sökterm är >= 6 tecken och söktermen inte innehåller några siffror i sig tillämpas en implicit fuzzy-sökning med en edit distance på 1. Det sker ingen fuzzy-sökning på identitetsattribut och koder som t.ex. varunummer, ATC-koder etc. c) Om en söksträng innehåller två eller fler termer tillämpas implicit sökoperatorn AND. d) Om en söksträng är tom så matchas inget. e) Sökresultat sorteras alfabetiskt på objektets name -attribut. Sökresultat Sökresultaten returneras i alfabetisk ordning och ingen rangordning av sökträffarna sker. Sid 25/180

26 3.3 I följande exempel presenteras hur man kan söka efter Drug-objekt (parallellimporter) och DistributedDrug- objekt (läkemedelsprodukter) och hur informationen som returneras ser ut beroende på om det finns parallellimporter eller inte. Syftet med exemplen är att visa på hur man kan söka efter information och hur Drug-objekt förhåller sig till DistributedDrug-objekt för ett par olika fall. I exemplen nedan används programmeringsspråket Python och exemplen har gjorts som interaktiva sessioner med Pythons standardinterpretator 4. För att snabbt komma igång med Sil SOAP-API kan man använda Sil:s demoserver 5 och Python-modulen suds 6. Med Python och suds kan man interaktivt ansluta sig till Sil:s demoserver med Sil SOAP API så här: >>> import suds >>> url = " >>> sil = suds.client.client(url) För att se tillgängliga tjänster och datatyper i Sil SOAP-API skriv: >>> print sil För att anropa en specifik tjänst som t.ex. getdistributeddrugsbydistributeddrugtradename kan man skriva: >>> ddrugs = sil.service.getdistributeddrugsbydistributeddrugtradename("aspirin", True, -1) Resultatet av anropet är nu tillgängligt i variabeln ddrugs. För att presentera resultat av anrop i exemplen nedan används Pythons standardfunktion print En läkemedelsprodukt utan parallellimporter: Aspirin I detta exempel söker vi efter information om "Aspirin". Det finns endast en läkemedelsprodukt med handelsnamnet "Aspirin" och det finns inga parallellimporter för den läkemedelsprodukten. Således ska det finnas ett DistributedDrug-objekt och ett Drug-Objekt med information om "Aspirin". Sökning efter läkemedelsprodukten "Aspirin" kan göras med följande tjänst för DistributedDrugobjekt: >>> ddrugs = sil.service.getdistributeddrugsbydistributeddrugtradename("aspirin", True, -1) Den andra parametern med värdet True anger att vi enbart vill ha tillgängliga läkemedels- produkter och den tredje parametern med värdet -1 anger att vi att vi inte vill begränsa vår sökning 4 Exemplen har körts med Python Se il /Inforandestod-Sil/Anslutning-/ för information om hur man kommer åt Sil demoservrar. 6 Se för information om suds. Sid 26/180

27 till någon specifik rekommenderad läkemedelslista. Antalet returnerade DistributedDrug-objekt fås genom att skriva: >>> len(ddrugs) 1 Således returnerades bara en läkemedelsprodukt med handelsnamnet "Aspirin", vilket ju var förväntat. Vi kan se på information om denna enda läkemedelsprodukt genom att skriva: >>> print ddrugs[0] (DistributedDrug){ approvaldate = " " containslactosflag = "N" containslatexflag = "N" dosdispflag = "N" dosdisplife = 0 dosdisplifeunit = "Månader" drugformcode = "TABLET" drugformtextsv = "Tablett" drugid = " " exportedfromcountrycode = "-" hasantirecommendedarticle = False hasrecommendedarticle = True interchangeableflag = "N" localrepresentative = None marketedflag = "Y" marketedfromdate = None marketingauthholder = "Bayer AB" nplid = " " parallelimportdeviation = None parimporiginalid = " " productnoteind = None salesstoppedflag = "N" sillactationcode = "M" silpregnancycode = "H" strengthnumeric = strengthnumericunit = "mg" strengthtext = "500 mg" tradename = "Aspirin " withdrawaldate = None eumano = None antidoteflag = "N" rxrepeatablecode = "-" controlleddrugflag = "N" nationallicenseflag = "N" additionalmonitoringflag = "N" dispensingrestrictioncode = "-" atccode = "N02BA01" } Sid 27/180