Tjänstegränssnittsbeskrivning

Transkript

1 SIL SOAP API 5.0 Tjänstegränssnittsbeskrivning

2 Revisionshistorik Version Författare Kommentar 1.1 () Tina Stagnelid Uppdaterat med information gällande tillägg av Fasslänkar. Dessa blir tillgängliga i Sil 5.0 i och med releasen av Sil ( ) Erik Heneryd Första utgåva. Se avsnitt Fass-länkar NYTT i Sil 5.0 i och med releasen av Sil 5.1 samt avsnitt 8.1 Webbresurser under rubriken Fass-texter. Sid 2/182

3 Välkommen! Detta är den tekniska dokumentationen för Sil SOAP API 5.0. Det är ett omfattande API, men vi har försökt beskriva det på ett så lättfattligt och överskådligt sätt som möjligt. Målet är dubbelt; dels att dokumentet ska gå att använda som en guide för helt nya läsare, men även ge veteraner som redan har en integration snabba svar om vad som är nytt eller att snabbt kunna slå upp referensdokumentation för specifika tjänster och typer. Dokumentet är strukturerat på följande sätt: Kapitel 1: Praktiska frågor runt API:et och dokumentationen. vis vilken information (källor) API:et innehåller, teknisk lösning, hur man går till väga för att integrera, osv. Kapitel 2: Övergripande beskrivning av förändringar i den här versionen jämfört med föregående. Kapitel 3: Kort om objektmodellen och basala koncept tillsammans med generella konventioner i API:et; vanliga inparametrar osv. Kapitel 4: Formalia: om hur tjänster och typer är beskrivna i referensdelen Kapitel 5-9: Referensdokumentation för samtliga tjänster och typer i API:et, grupperat efter vilken information de berör. Indelningen på den högsta nivån (basinformation, kategorisering, praktikaliteter, kunskap och beslutsstöd samt övrigt) strävar efter att skapa en bättre överblick av API:et. Kapitel 10 (bilaga): på hur man kan använda API:et, på en konkret nivå. Kapitel 11 (bilaga): Förändringsöversikt med samtliga signaturmässiga förändringar i senaste versionen jämför med den föregående. Vilka tjänster/typer/inparametrar/attribut har tillkommit/försvunnit eller förändrats? Sid 3/182

4 Innehåll 1 Inledning Avgränsningar Kontakt Programsystemet Sil Server med Sil SOAP API Allmänt om integration med Sil SOAP API Drift av Sil Server och uppdatering av Sil-databas Demomiljö Datakällor i Sil Definitioner Viktiga förändringar i Sil SOAP API Sammanfattning av förändringar Ny funktionalitet Fass-länkar NYTT i Sil 5.0 i och med releasen av Sil Taggade biverkningar Synonymkällan Utbytbarhet inom förmån Säkerhetsinformation till hälso- och sjukvården DHPC Engelska beskrivningar för ATC-koder Uppstädning Godkända och icke godkända läkemedel ATC-koderna finns numera på produktnivån Sorteringsordning Administrering Rimlighetskontroll Interaktioner Borttagen information i VARA Läkemedel under utökad övervakning Decimaltal Substanser Namngivning Källor, källägare och ett id som bytt namn Upprepningar Övrigt Generellt Objektmodell Produkttyper Filtrera på produkttypsgrupp Utbytbarhet...36 Sid 4/182

5 3.3.1 Medicinsk utbytbarhet Läkemedelsförmån Förpackningsstorlek Utbytbarhet Tillgänglighet Rekommenderade läkemedel givet region Lexikon Wildcardsökningar Sorteringsordning Indexerade fritextsökningar Om implementationen Indexeringsteknik och sökstöd Felhantering Beskrivning av tjänster och typer Tjänster Typer Lexikon Referens: Basinformation Parallellimporterade läkemedel getdrugsbydistributeddrugtradename getdrugbydrugid getdrugsbydrugidlist getdrugsbysubstancegroupid getdrugsbypharmaceuticalformgroupid getdrugsbystrengthgroupid getdrugidsbynplidlist Drug ControlClass Prescriber Prescription ProductType StrengthNumericUnit Läkemedelsprodukter getdistributeddrugsbydistributeddrugtradename getdistributeddrugsbydrugid getdistributeddrugsbydrugidlist getdistributeddrugbynplid getdistributeddrugsbynplidlist getdistributeddrugsbysubstanceid getdistributeddrugsbysubstancename getdistributeddrugsbyatccode getinterchangeabledistributeddrugsbynplid...57 Sid 5/182

6 getdistributeddrughistoricalnamesbynplid getnplidsbydistributeddrughistoricalname searchdistributeddrugs DistributedDrug DistributedDrugMatch Country DosdispLifeUnit RxRepeatable DispensingRestriction Läkemedelsartiklar getdrugarticlesbydistributeddrugtradename getdrugarticlesbydrugid getdrugarticlesbydrugidlist getdrugarticlesbynplid getdrugarticlesbynplidlist getdrugarticlebynplpackid getdrugarticlesbynplpackidlist getnplpackidsbydateadded searchdrugarticles DrugArticle DrugArticleMatch PackageTypeInner SalesRestriction PackSizeNumericUnit Samlad läkemedelsinformation (supertjänster/typer) getsuperdrugsbydistributeddrugtradename getsuperdrugsbydrugidlist getsuperdrugsbynplidlist getsuperdrugsbyatccodelist getsuperdrugsbyatctextsv getsuperdrugarticlesbynplpackidlist SuperDrug SuperDrugArticle Läkemedelsinnehåll getdistributeddrugcontentsbynplidlist getsubstancesbysubstancename getsubstancesbysubstanceidlist searchsubstances DistributedDrugContent Ingredient Substance SubstanceName...82 Sid 6/182

7 5.5.9 SubstanceCode SubstanceMatch IngredientRole QuantityUnit AlternativeQuantityUnit CompRefQuantity Referens: Kategorisering ATC-koder getatcsbyatccode getatcsbyatccodelist getatcsbytextsv getatcsbytextsvandlevelinterval getatcnarrowersbyatccode getatcwiderbyatccode getatcsbylevel getatcsbyatccodeandlevelinterval Atc Utbytbarhet getinterchangeabletlvexchangesbynplpackid gettlvexchangesbynplpackidlist getstrengthgroups getstrengthgroupbyid getpharmaceuticalformgroups getpharmaceuticalformgroupbyid getsubstancegroups getsubstancegroupbyid TlvExchange ExchangePeriod StrengthGroup PharmaceuticalFormGroup SubstanceGroup Rekommenderade läkemedel getregions getlisttypes getrecommendedlistsbyregionid gettherapygroups getindicationpaths getindicationpath getrecommendationsbynplpackidlist getrecommendationsbytherapygroupindicationname Region ListType...99 Sid 7/182

8 RecommendedList TherapyGroup IndicationPath Indication Recommendation IdentifierValue ShortIndication Läkemedelsidentifierare gethistoricalarticlenosbynplpackid getnplpackidsbyarticlenolist getsemanosbydrugidlist getdrugidsbysemanolist getsemanosbynplidlist getnplidsbysemanolist IdPair Läkemedelsföretag getdistributeddrugorganizationsbynplidlist getdrugarticleorganizationsbynplpackidlist DistributedDrugOrganizations DrugArticleOrganizations RoleOrganization Organization OrganizationRole Referens: Praktikaliteter Ordinationsorsaker getreasonsforprescriptionbytext getreasonsforprescriptionbynplid getreasonforprescriptionbycode getreasonsforprescriptionbycategorycode getreasonforprescriptioncategoriesbytext getreasonforprescriptioncategoriesbycode ReasonForPrescription ReasonForPrescriptionCategory TreatmentIntent Utsättningsorsaker gettreatmentwithdrawalreasons gettreatmentwithdrawalreasonbyid TreatmentWithdrawalReason Läkemedelsformer och doseringsenheter getdrugforms getdrugformbycode DrugForm Sid 8/182

9 7.3.4 Dosage Kortnotationer getshortencdosagetranslation Rimlighetskontroll av dosering getdoserangesbynplid getdoserangesbysubstanceid iswithindoserangefornplid iswithindoserangeforsubstanceid getdoseweightranges iswithindoseweightrange DoseRange DoseWeightRange Läkemedelsinstruktioner getdruginstructionhealthcareunits gethealthcareunitbyid getdruginstructionsbyhealthcareunit getdruginstructionsbynplid getdruginstructionsbydruginstructionid getdruginstructions HealthCareUnit DrugInstruction Administreringssätt getdrugadministrationroutes getdrugadministrationmethods getdrugadministrationsites getdrugadministrationsbycodes getdrugadministrationsbyterms Term DrugAdministration Läkemedelsförvaring getstoragesbynplpackid getstoragesbynplpackidlist Storage PackCondition ShelfLifeUnit StorageTemp StorageCondition Referens: Kunskap och beslutsstöd Webbresurser Link FASS-texter getfassdocsbydrugid Sid 9/182

10 8.2.2 getfassdocbynplid FassDoc Interaktioner getdruginteractionsbydrugidagainstall getdruginteractionsbydrugidagainstlist getdruginteractionsbydrugidagainstlistsevclassification getdruginteractionswithindrugidlist getdruginteractionswithindrugidlistsevclassification getshortinteractionsbyinteractionidlist getcompleteinteractionbyinteractionid DrugInteraction ShortInteraction CompleteInteraction InteractionSection InteractingPart Reference Biverkningar getsideeffectsbynplidlist getsideeffectfrequencies getsideeffectsocs SideEffects SideEffect Graviditets- och amningsvarningar getsilpregnancylactationwarningsbynplidlist getwarningclassificationsbycode getjanusmedpregnancydocsbynplidlist getfasspregnancydocsbynplidlist getjanusmedlactationdocsbynplidlist getfasslactationdocsbynplidlist SilPregnancyLactationWarning SourceWarning WarningClassification JanusmedPregnancyDoc JanusmedLactationDoc JanusmedReference JanusmedLink FassPregnancyDoc FassLactationDoc Referens: Övrigt Synonymer getsynonymsto getterminologies Sid 10/182

11 9.2 Handelsvaror (icke-läkemedel) getnondrugarticlesbyarticlename getnondrugarticlesbyarticlenolist getnondrugarticlesbyproductgroupcode getnondruggroupsbytextsv getnondruggroupbycode getnondruggroupsbycode getnondruggroupsbycodelist getnondruggroupparentsbycode getnondruggroups NonDrugGroup NonDrugArticle Versionsinformation getdataversions getapiversion DataVersion ApiVersion Bilaga: 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" Bilaga: Förändringsöversikt Nya tjänster Borttagna tjänster Förändrade tjänster Nya typer Borttagna typer Förändrade typer Sid 11/182

12 1 Inledning Detta dokument beskriver Sil SOAP API 5.0 från ett tekniskt perspektiv. Sil SOAP API är ett read-only API för åtkomst till information om alla läkemedelsprodukter och förpackningar i Sverige. Utöver denna basinformation innehåller det även ett stort antal andra läkemedelsrelaterade tjänster som rör allt från substanser, interaktioner och biverkningar till administreringssätt, utbytbarhet och läkemedelsrelaterade handelsvaror. 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. Den senaste versionen av detta dokument finns, tillsammans med övriga relaterade dokument, alltid på Sils dokumentationssida 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 detta, se Sil installationsmanual 5.0. För en verksamhetsorienterad beskrivning av nytta och möjligheter med tjänster och informationen i Sil hänvisas läsaren till de olika integrationshandledningar Sil tillhandahåller. Dessa dokument, uppdelade efter olika områden typ källor, är med sina krav och rekommendationer för integrerande system nödvändiga för att använda Sil SOAP API i praktiken. Det här dokumentet beskriver inte heller Sil i närmare detalj (vilka vi är, hur vi arbetar, informationsflöden, andra Sil-system och tjänster osv) eller de praktiska detaljerna hur man skriver avtal och får access till Sil SOAP API osv. För detta hänvisas till Sils fördjupningssida på Ineras sajt Sid 12/182

13 1.2 Kontakt 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.3 Programsystemet Sil Server med Sil SOAP API Sil SOAP API innehåller 173 read-only-tjänster (som returnerar 91 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 Sil-databasen 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 Sildatabaser 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 SFTP-server. FASS-texter och annan FASS-information uppdateras i den publicerade databasen på SFTP-servern alla vardagar utom röda dagar och halvdagar. 1.4 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 5.0 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 avsnitt 1.6 Demomiljö). 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. Sid 13/182

14 För att få tillgång till programvaran Sil Server med Sil SOAP API och tillgång till Sil:s SFTP-server måste man ha Sil integrations- och/eller driftavtal med Inera. 1.5 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 Sil-databasen 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 Sil-databaserna 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. 1.6 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 5.0 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. Sid 14/182

15 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. 1.7 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 SFTPserver. Källorna som används i Sil 5.0 är: 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. NSL från Läkemedelsverket. Denna information är den som returneras i tjänsterna för substanser. DHPC från Läkemedelsverket. Direct Healthcare Professional Communication - dessa kallas också för dear doctor letters och är ett sätt för Läkemedelsverket och läkemedelsföretagen att nå ut med ny, viktig säkerhetsinformation om läkemedel. De distribueras i Sil som länkar från läkemedelsprodukter. Janusmed Interaktioner 3 från SLL/JanusInfo. Denna information är den som returneras i tjänsterna för interaktioner. FASS (Farmaceutiska Specialiteter i Sverige) från LIF. Sil tillhandahåller Läkemedelsindustriföreningens FASS-texter samt länkar till Fass.se. (Fass länkarna finns tillgängliga i Sil 5.0 från och med releasen av Sil 5.1.) Amning & graviditetsvarningar från LIF/FASS. Denna information är, tillsammans med den från Janusmed Amning & Janusmed Fosterpåverkan 4 från SLL/JanusInfo, den som returneras i tjänsterna för 3 Denna källa bytte namn från SFINX (Swedish Finnish Interaction X-referencing) 1 januari Dessa källor bytte namn från Läkemedel och amning ändras till Janusmed amning och från Läkemedel och fosterpåverkan till Janusmed fosterpåverkan 1 januari Sid 15/182

16 graviditets- och amningsvarningar. Det är alltså två källor som används i de tjänsterna. Janusmed Amning & Janusmed Fosterpåverkan från SLL/JanusInfo. Denna information ä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. Kortnotationer och Doseringsregistret från Sil. Dessa register underhålls av Sil och baseras på beredningsformer i VARA. Utsättningsorsaker från Sil. Detta register underhålls av Sil och uppdateras i enlighet med önskemål från referensgruppen för Läkemedel. Administreringskällan från Sil. Denna källa underhålls av Sil och togs ursprungligen fram för att stödja APItjänster som har med eped att göra. Den uppdateras efter behov för administreringsvägar i eped:s källa med rimlighetskontrollinformation. Synonymkällan (för biverkningar) från Sil. En ny källa som innehåller synonym-mappningar mellan olika medicinska termer, avsedda att användas för att söka i biverkningstexter och Fass Regionala rekommendationslistor med rekommenderade läkemedel. Denna källa underhålls av Läkemedelsområdeskommittéerna (LOK) i varje region/landsting. Nationell lista Undvik till äldre. Denna lista underhålls av Sil och baseras på Socialstyrelsens lista Olämpliga läkemedel för äldre. Läkemedelsinstruktioner från eped. Denna information är den som returneras i tjänsterna för läkemedelsinstruktioner. Rimlighetskontrollregistret från eped. Denna information är den som returneras i tjänsterna för rimlighetskontroll av dosering. 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). Sid 16/182

17 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, AIDA från APL AB. Innehåller produktresuméer för extemporeläkemedel beviljade rikslicenser. Produktresuméerna är granskade och accepterade av Läkemedelsverket. 1.8 Definitioner En icke uttömmande lista med de viktigaste begreppen/termerna. 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: articleid=18338 Amningsriskklass (SLL/JanusInfo) SLL/JanusInfo klassificering av ett läkemedels dokumenterade effekt på barn under amningsperioden. 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: Sid 17/182

18 Term Antirekommendation ATC-kod FASS-text Farmaceutisk produkt Graviditetskategori (LIF/FASS) Graviditetsriskklass (SLL/JanusInfo) Förklaring 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 kan inkludera en hänvisning till en alternativ ATC-kod (nivå 7) eller läkemedelsprodukt. Anti-rekommendationer kallas också nollrekommendationer. En kod i ATC-systemet som är ett klassifikationssystem för läkemedel som baseras på deras anatomiska, terapeutiska och kemiska egenskaper. Sil innehåller endast de ATC-koder som finns angivna för läkemedelsprodukter i VARA eller som finns angivna för substanser i NSL. ATC-systemet är egentligen avsett att användas för uppföljning och forskning om användning av läkemedel. URL: Beskrivning av läkemedelsprodukter som ges ut av LIF. FASStexten baseras på den läkemedelsproduktens produktresumé (SPC) som är registrerad hos Läkemedelsverket. En farmaceutisk produkt är ett läkemedels konkreta form; exempelvis en typ av tablett, ett sorts pulver eller en viss lösning. En läkemedelsprodukt innehåller en eller ibland flera farmaceutiska produkter. 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: articleid=18338 SLL/JanusInfo klassificering av ett läkemedels dokumenterade effekt på graviditet vid klinisk användning på människor i rekommenderade terapeutiska doser. 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. Sid 18/182

19 Term Förklaring 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: Handelsnamn Handelsvara Ingrediens Beståndsdel 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. : Zetuvit E", 25 styck, sterilt absorptionsförband. I Sil SOAP API representeras de av dataobjektet NonDrugArticle. I en farmaceutisk produkt ingår en eller flera ingredienser (synonym: beståndsdel). En ingrediens är en viss mängd av en substans med en viss roll i läkemedlet. Läkemedel med fler än en aktiv ingrediens kallas kombinationsläkemedel. Parallellimporterat läkemedel Läkemedelsform Läkemedelsartikel 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 Parallell-importerade läkemedelsprodukter representeras i Sil SOAP API av dataobjektet Drug och identifieras med drugid. 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 är termerna läkemedelsartikel och Sid 19/182

20 Term Läkemedelsförpackn ing Läkemedelsprodukt NPL NSL semano VARA Förklaring "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. 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. Nationellt produktregister för läkemedel (NPL) är ett register som innehåller kvalitetssäkrad information från olika aktörer om samtliga i Sverige godkända läkemedel. Avregistrerade läkemedel, extemporeläkemedel, rikslicenser och beviljade licensläkemedel finns också med i NPL. NPL tillhandahålls av Läkemedelsverket. URL: Nationellt substansregister för läkemedel (NSL) innehåller kvalitetssäkrad information om aktiva substanser och ett urval av hjälpämnen som förekommer i svenska läkemedel, licensläkemedel och lagerberedningar. NSL är en nationell källa för rekommenderade svenska namn på läkemedelssubstanser. Substansregistret innehåller även information om engelskt namn, andra synonymnamn, narkotikaklassning, externa koder och substansernas inbördes relation. NSL tillhandahålls i form av två xml-filer. NSL tillhandahålls av Läkemedelsverket. URL: En läkemedelsprodukts svenska godkännandenummer. Fastställs av Läkemedelsverket. VARA är ett nationellt produkt- och artikelregister som tillhandahålls av ehälsomyndigheten. VARA utgör grundregister för informationen som är åtkomlig via Sil SOAP API. I registret finns läkemedel samt de förbrukningsartiklar och livsmedel som ingår i högkostnadsskyddet. Syftet med VARA är att förse vård och apotek med uppdaterad och kvalitetssäkrad information för förskrivning och expedition av recept. VARA baseras i sin tur på NPL. URL: Sid 20/182

21 2 Viktiga förändringar i Sil SOAP API 5.0 Sil SOAP API 5.0 är inte tekniskt bakåtkompatibel med föregående version. Sil SOAP API är en levande plattform som förändras från år till år. Saker förändras och förbättras. Med tiden bygger man upp ett lager av saker som inte längre tjänar sitt ursprungliga syfte, eller alls används. För att minska komplexiteten och i det långa loppet reducera underhållskostnaden har vi nu städat upp och rensat bort dylikt. Det betyder, för det första, att ett antal gamla tjänster och typer tagits bort. Dessa har redan i tidigare versioner dokumenterats som deprikerade och/eller oanvända; att de i framtiden kommer försvinna och ej bör användas samt vad man bör använda istället. För det andra har vi tagit tillfället i akt att göra en generell städning i API:et. Allt från ändrade attributtyper (för att vara konsekvent och/eller föregripa problematik med för dålig precision) via namngivning (felstavningar och/eller anpassningar till en förändrad verklighet) till vissa strukturella förändringar (t ex förenkla hanterandet av godkända och icke godkända läkemedel, hur parallellimporter och ATC-koder förhåller sig). Det kan tyckas som många ändringar, men de flesta är små och borde inte innebära något större anpassningsjobb. 2.1 Sammanfattning av förändringar Förändringarna i siffror: Sil SOAP API 5.0 innehåller 173 SOAP-tjänster och 91 SOAP-typer. Sil SOAP API 4.2 innehöll 191 SOAP-tjänster och 95 SOAP-typer. 4 tjänster är helt nya, 22 borttagna och 26 signaturmässigt förändrade (nya/borttagna inparametrar och dylikt). Inga nya typer, 4 borttagna och 29 signaturmässigt förändrade (nya/borttagna attribut och dylikt) För en strukturell översikt av dessa förändringar, se avsnitt 11 Bilaga: Förändringsöversikt. Sid 21/182

22 2.2 Ny funktionalitet Fass-länkar NYTT i Sil 5.0 i och med releasen av Sil 5.1 I Sil finns det länkar till webbresurser med vidare information om en läkemedelsprodukt, artikel eller substans. I och med releasen av Sil 5.1 kommer det, för både Sil 5.1 och Sil 5.0, distribueras länkar till Fass för läkemedelsprodukter. Dessa länkar går till Fass-texter på Fass egen webbplats. Läs mer i avsnitt 8.1 Webbresurser under avsnittet rörande Fass-texter Taggade biverkningar Sil kommer i och med 5.0 kunna tillhandahålla mer fullödig information om biverkningar. Precis som tidigare hämtas datat i Sils biverkningskälla från tabellen/erna i stycket 4.8 i Läkemedelsverkets produktresuméer, men från och med Sil 5.0 kan även SPC:er med fler än en tabell hanteras och biverkningarna taggas då efter vilken tabell de ingår i. 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. Läs mer om taggade biverkningar i avsnitt 8.4 Biverkningar Synonymkällan En ny källa för synonyma termer för biverkningar. Läs mer om synonymkällan i avsnitt 9.1 Synonymer Utbytbarhet inom förmån Nu finns information om Tandvårds- och läkemedelsförmånsverkets (TLV) gruppering av förpackningsstorlekar i Sil. Därmed har vi komplett information angående ett läkemedels utbytbarhet inom förmån sedan tidigare innehåller Sil information om medicinsk utbytbarhet och vilka läkemedel som ingår i läkemedelsförmånen, vilket är de andra kriterierna. Förpackningsstorleksgrupp det nya tillskottet i Sil är TLVs gruppering av ett medicinskt utbytbart läkemedel i grupper av motsvarande förpackningsstorlek (100 tabletter är utbytbart mot 105 tabletter, men inte mot 106). I Sil finns nu förpackningsstorleken som attributet packagesizegroup på typen ExchangePeriod. Sid 22/182

23 Den nya tjänsten getinterchangeabletlvexchangesbynplpackid tar hänsyn till allt detta (medicinsk utbytbarhet, läkemedelsförmån och förpackningsstorlek) och gör det lätt att efter konstens alla regler hitta utbytbara artiklar. Den sedan tidigare befintliga tjänsten gettlvexchangesbynplpackidlist har fått ett nytt attribut: date. Det filtrerar de returnerade TlvExchange-objektens exchangeperiodsattribut så bara perioder relevanta för datumet finns med. Artiklarna kan ha fler utbytbarhetsperioder än vad som då returneras. Kanske snarare en uppstädning, men från 5.0 så kräver tjänsterna för att hämta parallellimporter givet ett lvgrupps-id (dvs getdrugsbysubstancegroupid, getdrugsbypharmaceuticalgroupid eller getdrugsbystrengthgroupid) inte längre att interchangeableflag är Y eller P. Man kan numera alltså även söka efter grupper som inte är utbytbara. Läs mer om utbytbarhet i avsnitt 3.3 Utbytbarhet Säkerhetsinformation till hälso- och sjukvården DHPC DHPC (Direct Healthcare Professional Communication) är ett sätt för Läkemedelsverket och läkemedelsföretagen att nå ut till hälso- och sjukvårdspersonal med ny, viktig säkerhetsinformation om läkemedel. 5 Sil tillgängliggör DHPC genom länkar från läkemedelsprodukter (kopplingen är alltid på produktnivå). Rent formellt blir det ingen API-förändring, utan den vanliga mekanismen för länkar till webbresurser används: DistributedDrug-typen har ett linksattribut en lista med Link-objekt. I fallet DHPC är länktypen "DHPC". Läs mer om DHPC i avsnitt 8.1 Webbresurser Engelska beskrivningar för ATC-koder Typen Atc har fått ett nytt attribut texten som är en beskrivande text på engelska för ATC-koden. Informationen hämtas från Läkemedelsverkets nationella substansregister för läkemedel (NSL). Läs mer om ATC-koder i avsnitt 6.1 ATC-koder. 5 För mer om DHPC, se Läkemedelsverkets sida: Sid 23/182

24 2.3 Uppstädning Godkända och icke godkända läkemedel I Sil ordnas läkemedelsprodukttyper i grupper som syftar till att kunna urskilja vilka läkemedel som är godkända av Läkemedelsverket eller ej. En gruppering avser godkända produkter (APPROVED) och en icke godkända (NON_APPROVED). Utöver detta finns en tredje gruppering med traditionella läkemedelsprodukter (TRADITIONAL) som ej heller är godkända. Tidigare har det funnits separata, men i det närmaste identiska tjänster för att hämta godkända (namngivna ungefär getfoobybar) respektive icke godkända läkemedel (namngivna ungefär getunauthorizedfoobybar). Dessa är nu sammanslagna till gemensamma tjänster där man istället via en inparameter, silproducttypegroup, anger vilken grupp man är intresserad av. Vidare har tjänsten getsilproducttypegroups tagits bort. Den var i praktiken meningslös då det krävs förhandskunskap om de olika grupperna för att t ex kunna särskilja dem i sökvyer. Dessa tjänster får silproducttypegroup som inparameter: getdrugarticlesbydistributeddrugtradename getdistributeddrugsbyatccode getdistributeddrugsbydistributeddrugtradename getdistributeddrugsbysubstanceid getdistributeddrugsbysubstancename getdrugsbydistributeddrugtradename getdrugsbyatccode getsuperdrugsbydistributeddrugtradename getsuperdrugsbyatccodelist getsuperdrugsbyatctextsv searchdistributeddrugs searchdrugarticles Följande tjänster försvinner: Sid 24/182

25 getunauthoriseddistributeddrugsbynplsubstanceid getunauthoriseddistributeddrugsbysubstancename getunauthorisedsuperdrugsbydistributeddrugtradename getunauthorisedsuperdrugsbyatccodelist getunauthorisedsuperdrugsbyatctextsv searchunauthoriseddistributeddrugs searchunauthoriseddrugarticles Läs mer om produktgruppstyper i avsnitt 3.2 Produkttyper ATC-koderna finns numera på produktnivån I Sil SOAP API 4.2 lades ATC-kod in som ett attribut på läkemedelsprodukten (DistributedDrug) vilket är det logiska stället och även den nivån den underliggande källan (VARA) anger ATC. I tidigare Sil-versioner var man tvungen att gå via diverse tjänster på parallellimportsnivå (Drug) för att få kopplingen mellan en läkemedelsprodukt och ATCkod, med en rätt komplicerad logik bakom kulisserna. I Sil SOAP API 5.0 gör vi oss av med kopplingen på parallellimportsnivå. Använd atccode-attributet på DistributedDrug istället. SuperDrug och SuperDrugArticle behåller sina atcs-listor (som kommer kunna ha flera Atc-objekt). Förändringar: Typerna AtcCodeDrug och DrugAtcCode försvinner. Tjänsterna getatcsbydrugid, getdrugatccodesbydrugidlist, getatccodedrugsbyatccodelist och getdrugsbyatccode försvinner. Läs mer om ATC-koder i avsnitt 6.1 ATC-koder Sorteringsordning I Sil SOAP API 5.0 förändrar vi vår policy angående ordningen i listor av objekt. Speciellt gäller detta listor med läkemedelsprodukter, läkemedelsartiklar och parallellimporterade läkemedel, där ordningen ibland varit dokumenterad och ibland inte. Hädanefter kommer sorteringsordning rent generellt vara odefinierad och Sil råder integrerande system att inte bero på returnerad ordning av objektlistor utan alltid själva sortera beroende på vad informationen ska användas till. Sid 25/182

26 Läs mer om sorteringsordning i avsnitt 3.8 Sorteringsordning Administrering Med Sil SOAP API 4.1 fick Sil en ny källa för administreringssätt. Innan detta hade det gjorts diverse ansatser att införa administrering i API:et, vilket lämnat diverse spår. Typer och attribut som inte haft någon data och dokumenterats som för framtida bruk. Dessa städar vi nu undan. På Dosage-typen försvinner attributen routeofadministration och patientadministration. Typen RouteOfAdministration försvinner tillsammans med relaterade tjänsterna getrouteofadministrations och getrouteofadministrationbycode. På Drug-typen försvinner attributet routeofadministrationcodes. Administreringssätt enligt vad som beskrivs i tjänstegränssnittsbeskrivningen för Sil SOAP API 4.2 avsnitt 4.12 och i Administreringskällans integrationshandledning 6, finns kvar och Sil kommer framgent arbeta för att utöka informationsinnehållet i tjänsterna. Läs mer om administreringssätt i avsnitt 7.7 Administreringssätt Rimlighetskontroll Tjänsterna iswithindoserangefornplid och iswithindoserangeforsubstanceid (gammalt namn iswithindoserangefornplsubstanceid) har blivit säkrare i och med att man numera måste specificera dosens/dygnsdosens enhet med nya inparametrarna doseunit och dailydoseunit. Test görs mot enheten i rimlighetsdatat och om de inte överensstämmer returneras koden "INCOMPATIBLE_UNIT". Dessa två tjänster har även fått ändrad returkod rimlig dygnsdos. Tidigare returnerades "DOSE_OK" inte bara för en rimlig enskild dos, utan även för en rimlig dygnsdos. I tydlighetens namn returneras numera "DAILY_DOSE_OK". Läs mer om rimlighetskontroll i avsnitt 7.5 Rimlighetskontroll av dosering Interaktioner I Sil SOAP API 4.1 tillkom information om interaktioner mot läkemedel som saknar NPL/drugid. Det gjordes genom införandet av en ny tjänst getdruginteractionsbydrugidagainstall, som kunde returnera sådana läkemedel, men som 6 Sid 26/182

27 annars fungerade precis som den nu borttagna getinteractionsbydrugidagainstall. Se tjänstebeskrivningen för Sil SOAP 4.2, avsnitt 4.14 Interaktioner för mer info. Vid det tillfället döptes de andra getinteractionsbyfoo-tjänsterna om till det mer intuitiva getdruginteractionsbyfoo. Gamla namnen fanns kvar i 4.1 och 4.2, men har nu tagits bort. Typen DrugInteraction har gjorts om något i 5.0. Attributet drugids (en lista med drugid:n för de två interagerande läkemedlen) har tagits bort och ersätts med två attribut, drugid1 och drugid2. Detta då andra attribut på typen (name1 och name2, administration1 och administration2) redan följde den konventionen. Sedan Sil SOAP API 4.1 finns interaktioner mot ett läkemedel som saknar NPL/drugid, vilket då representerades av att drugids endast hade ett element, men efter denna ändring nu representeras av att drugid1 eller drugid2 är null. På typen DrugInteraction ändras attributet docclassifications typ från integer till string. Innehållet är numeriskt, men det ska enligt Janusmed representeras som en sträng. Läs mer om interaktioner i avsnitt 8.3 Interaktioner Borttagen information i VARA Sil har under 2017 migrerat till att använda version 3 av ehälsomyndighetens produktoch artikelregister VARA. I Sil SOAP API 5.0 har vi städat bort typer och attribut som baseras på deprikerad/borttagen information i VARA. Typen DrugClassification försvinner tillsammans med relaterade tjänsterna getdrugclassifications och getdrugclassificationsbycode. På Drug-typen försvinner attributet drugclassificationcode. Ersätt genom att använda de sedan tidigare befintliga attributen controlleddrugflag och rxrepeatablecode på typen DistributedDrug. På typen DistributedDrug försvinner attributet marketedfromdate och analogt: på typen DrugArticle försvinner attributet marketedfromdate. På typen DrugArticle försvinner attributet packagenoteind Läkemedel under utökad övervakning På europeisk nivå finns en lista med läkemedel som står under utökad övervakning och övervakas särskilt noggrant av myndigheterna. Det är EMA som underhåller listan och Sil har historiskt tillhandahållit den i form av en lista för rekommenderade läkemedel: Nationell lista läkemedel under utökad övervakning. Sid 27/182

28 Denna lista distribueras numera av ehälsomyndigheten via VARA3 och exponeras i Sil som attributet additionalmonitoringflag på DistributedDrug. I Sil 5.0 försvinner den historiska listan Nationell lista läkemedel under utökad övervakning. Vi ser det dock inte som möjligt att ta bort den från Sil 4.2 så där kommer den underhållas och finnas kvar tills den versionen tas ur drift Decimaltal Ett antal numeriska värden som idag är av typen float byts till typen decimal. Vilket är mer rätt, då ett decimaltal inte kan representeras exakt som en float, utan bara som ett närmevärde. Felet blir inte särskilt stort, men skulle potentiellt kunna ha betydelse. Påverkade attribut: På typen Drug: strengthnumeric. På typen DistributedDrug: strengthnumeric. På typen DrugArticle: aup, dddperpackage och packsizenumeric. På typen Ingredient: quantity. På typen: NonDrugArticle: aup och sizenum. På typen ExchangePeriod: aipperunit och aupperunit (dessa hade tidigare typen string) Substanser På typen Substance försvinner deprikerade attributet casno. Detta värde (CAS-nummer), finns sedan version 4.2 istället i attributet codes, som SubstanceCode där attributet system är CAS. Tjänsten getdistributeddrugcontentsbynplidlistfiltered försvinner. Funktionaliteten ersätts genom att den sedan tidigare befintliga getdistributeddrugcontentsbynplidlist förändras och får två nya inparametrar dels parentsubstancesonly från den tidigare nämnda tjänsten, men även nya rolecodes för att filtrera på roll) Läs mer om substanser i avsnitt 5.5 Läkemedelsinnehåll. Sid 28/182

29 2.4 Namngivning Eftersom denna version av API:et inte är bakåtkompatibel med tidigare version har vi nu passat på att göra ett antal mindre ändringar man annars inte kan göra pga. bakåtkompatibilitet Källor, källägare och ett id som bytt namn 1:a september 2008 bytte Läkemedelsförmånsnämnden (LFN) namn till Tandvårds- och läkemedelsförmånsverket (TLV): På typen DrugArticle har attributet packagenotelfn döpts om till limitedreimbursement. Stockholms Läns Landsting, 1:a januari 2017: SFINX (Swedish Finnish Interaction X- referencing) bytte namn till Janusmed Interaktioner. JanusInfo läkemedel och amning bytte namn till Janusmed amning och Läkemedel och fosterpåverkan bytte namn till Janusmed fosterpåverkan. Typen JanusInfoLactationDoc har döpts om till JanusmedLactationDoc. Relaterade tjänsten getjanusinfolactationdocsbynplidlist har döpts om till getjanusmedlactationdocsbynplidlist. Typen JanusInfoPregnancyDoc har döpts om till JanusmedPregnancyDoc. Relaterade tjänsten getjanusinfopregnancydocsbynplidlist har döpts om till getjanusmedpregnancydocsbynplidlist. Typen JanusInfoLink har döpts om till JanusmedLink. Typen JanusInfoReference har döpts om till JanusmedReference. Källnamnet janusinfo som dyker upp som värde på SourceWarning-objekt (attributet type) och som potentiell type-inparameter till tjänsten getwarningclassificationsbycode har döpts om till janusmed. Inera AB, 3:e februari 2015: Svensk Informationsdatabas för Läkemedel (förkortat SIL) bytte namn till Svenska informationstjänster för läkemedel (förkortat Sil). Typen SILProductTypeGroups har döpts om till SilProductTypeGroups. Relaterade tjänsten getsilproducttypegroups har tagits bort (se ovan om produktgruppstyper). Sid 29/182

30 Typen SILPregnancyLactationWarning har döpts om till SilPregnancyLactationWarning. Relaterade tjänsten getsilpregnancylactationwarningbynplidlist har döpts om till getsilpregnancylactationwarningbynplidlist. Läkemedelsverket byter i.o.m. NSL 1.1 namn på sitt id för substanser till SeNSLid (även kallat SENSLIDSENSL). Det är exakt samma id som tidigare, bara namnet förändras: Attributet nplsubstanceid har döpts om till substanceid på typerna DoseRange, Ingredient, Substance samt SubstanceMatch. Tjänsterna getdistributeddrugsbynplsubstanceid, getdoserangesbynplsubstanceid, getsubstancesbynplsubstanceidlist, getdistributeddrugsbynplsubstanceid och iswithindoserangefornplsubstanceid har döpts om till motsvarande utan Npl. Deras inparameter nplsubstanceid/nplsubstanceids har döpts om till substanceid/substanceids. Inparametern nplsubstancename för tjänsten getsubstancesbysubstancename har döpts om till substancename Upprepningar Vi har tagit bort de onödiga upprepningar där attribut har namn med ett förled som är samma som typen den sitter på. Detsamma med tjänstnamn. På typen DrugForm har drugformcode döpts om till code och drugformtextsv har döpts om till textsv. Relaterat har tjänsten getdrugformbydrugformcode döpts om till getdrugformbycode. På typen Indication har indicationcomment döpts om till comment, indicationdescription till description, indicationlinks till links, indicationname till name och indicationlevel till level. På typen IndicationPath har recommendedlistname döpts om till listname. På typen ShortIndication har indicationlevel döpts om till level och indicationname till name. På typen TherapyGroup har attributet therapygroup döpts om till name, therapygroupcomment till comment, therapygroupdescription till description, therapygrouplinks till links och recommendedlistname döpts om till listname. Sid 30/182

31 På typen SubstanceGroup har substancegroupid döpts om till id och relaterade tjänsten getsubstancegroupbysubstancegroupid till getsubstancegroupbyid. På typen PharmaceuticalFormGroup har pharmaceuticalformgroupid döpts om till id och relaterade tjänsten getpharmaceuticalformgroupbypharmaceuticalformgroupid till getpharmaceuticalformgroupbyid. På typen StrengthGroup har strengthgroupid döpts om till id och relaterade tjänsten getstrengthgroupbystrengthgroupid till getstrengthgroupbyid. På typen DataVersion har dataversionid döpts om till id, dessutom har dataversiontype döpts om till description (det var mer av en beskrivning av källan i fråga än en typ ) Övrigt Andra små ändringar i namngivningen: På typen JanusmedLactationDoc (gammalt namn JanusInfoLacationDoc) har attributet litteraturesearchdate stavningsrättats till literaturesearchdate var inte fel i dokumentationen, bara i API:et! Attributet publishdate har döpts om till lastupdateddate. Tjänsten getvalidregions har döpts om till getregions alla regioner är ju giltiga! Typen RecommendedListInfo har döpts om till RecommendedList och relaterade tjänsten getrecommendedlistinfosbyregionid till getrecommendedlistsbyregionid. På typen ApiVersion har build döpts om till micro närmare verkligheten och lättare att förstå. På typen Atc har lev döpts om till level. Sid 31/182

32 3 Generellt 3.1 Objektmodell 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 tillhandahålls via ett antal tjänster och informationstyper som var och en representerar olika förskrivnings- och läkemedelsrelaterade begrepp. För läkemedelsinformation är de tre viktigaste typerna Drug (parallellimporterade läkemedel), DistributedDrug (läkemedelsprodukt) och DrugArticle (läkemedelsartikel). Nedan ges en översiktlig bild av relationen mellan dessa grundläggande typer och deras tillhörande identifierare (drugid, nplid och nplpackid). Sid 32/182