Specifikation 1 (115) Tjänstegränssnittsbeskrivning SIL SOAP API 3.1

Transkript

1 Specifikation 1 (115) Tjänstegränssnittsbeskrivning SIL SOAP API 3.1

2 Specifikation 2 (115) Innehållsförteckning 1. FÖRÄNDRINGSHISTORIK INTRODUKTION AVGRÄNSNINGAR DATAKÄLLOR I SIL TEKNISK LÖSNING UTVECKLINGSMILJÖ TESTMILJÖ DEFINITIONER VIKTIGA FÖRÄNDRINGAR I SIL SOAP API NYA TJÄNSTER OCH OBJEKT UTGÅNGNA TJÄNSTER OCH OBJEKT OBJEKTMODELL FÖR LÄKEMEDELSINFORMATION TJÄNSTER FÖR ATT SÖKA EFTER LÄKEMEDELSINFORMATION NÅGRA EXEMPEL En enskild läkemedelsprodukt utan parallellimporter: Aspirin En läkemedelsprodukt med parallellimporter: Stilnoct En substans som börjar med vissa tecken: Ace TJÄNSTER FELHANTERING EXEMPEL (OBS! ENDAST EXEMPEL) Exempel-objekt (OBS! endast exempel) ATC-KODER Atc-objekt DrugAtcCode-objekt AtcCodeDrug-objekt PARALLELLIMPORTERADE LÄKEMEDEL Drug-objekt LÄKEMEDELSPRODUKTER DistributedDrug-objekt LÄKEMEDELSVAROR DrugArticle-objekt TlvExchange-objekt ExchangePeriod-objekt FÖRVARING Storage-objekt LÄKEMEDELSFORMER DrugForm-objekt Dosage-objekt REFERENSDATATJÄNSTER DrugClassification-objekt ControlClass-objekt RouteOfAdministration-objekt Prescriber-objekt... 57

3 Specifikation 3 (115) ProductType-objekt Prescription-objekt StrengthNumericUnit-objekt OrganizationRole-objekt ProcStatus-objekt Country-objekt DosdispLifeUnit-objekt PackageTypeInner-objekt PackCondition-objekt StorageTemp-objekt SalesRestriction-objekt PackSizeNumericUnit-objekt ShelfLifeUnit-objekt StorageCondition-objekt IngredientRole-objekt QuantityUnit-objekt AlternativeQuantityUnit-objekt CompTotWeightVolUnit-objekt CompRefQuantity-objekt SilDeviation-objekt FASS-TEXTER FassDoc-objekt INTERAKTIONER DrugInteraction-objekt ShortInteraction-objekt InteractionSection-objekt CompleteInteraction-objekt InteractingPart-objekt Reference-objekt GRAVIDITETS- OCH AMNINGSVARNINGAR SILPregnancyLactationWarning-objekt SourceWarning-objekt WarningClassification-objekt JanusInfoLactationDoc-objekt JanusInfoReference-objekt JanusInfoPregnancyDoc-objekt JanusInfoLink-objekt PregnancyCategoryInfo-objekt UTGÅNGEN (DEPRECATED) LactationGroupInfo-objekt UTGÅNGEN (DEPRECATED) REKOMMENDERADE LÄKEMEDEL Region-objekt ListType-objekt TherapyGroup-objekt IndicationPath-objekt Indication-objekt RecommendedListInfo-objekt Recommendation-objekt IdentiferValue-objekt... 89

4 Specifikation 4 (115) ShortIndication-objekt Recommend-objekt UTGÅNGEN (DEPRECATED) Indic-objekt UTGÅNGEN (DEPRECATED) RecommendList-objekt UTGÅNGEN (DEPRECATED) ICKE LÄKEMEDELSVAROR NoneDrugArticle-objekt UTBYTBARHET SubstanceGroup-objekt StrengthGroup-objekt PharmaceuticalFormGroup-objekt INGREDIENSER OCH SUBSTANSER Substance-objekt DistributedDrugContent-objekt Ingredient-objekt KORTNOTATIONER UTSÄTTNINGSORSAKER TreatmentWithdrawalReason-objekt BIVERKNINGAR SideEffects-objekt SideEffect-objekt SÖKTJÄNSTER FÖR LÄKEMEDELSIDENTIFIERARE IdPair-objekt TJÄNSTER FÖR SAMLAD LÄKEMEDELSINFORMATION (SUPERTJÄNSTER) SuperDrug-objekt SuperDrugArticle-objekt VERSIONER DataVersion-objekt ApiVersion-objekt

5 Specifikation 5 (115) 1. Förändringshistorik Dokumentversion Kommentar ( ) Första utgåva för beta-release av SIL SOAP API ( ) Korrigerat villkor för ATC-tjänsterna. Längd på ATC-kod som inparameter var angiven till 8 tecken. Det ska vara och är nu mindre eller lika med 8 tecken ( ) Tagit bort duplicerad dokumentation för InteractionSection-objekt (kapitel 5.11) och gjort smärre förtydliganden i kapitel 5.4 och 5.5. Korrigerade två mindre fel i Pythonexemplen i kapitel 4.2. La till fältet spcupdated i SideEffects-objektet. Rättat några språkliga fel. La till förtydligande om att licensläkemedel alltid ingår i förmånen, även fast prisuppgift saknas. Rättat felaktigt returvärde i tjänsten gettlvexchangesbynplpackidlist. La in information om tjänsterna getfasslactationdocsbynplidlist och getfasspregnancydocsbynplidlist ( ) Korrigerat returvärde i tjänsterna getfasslactationdocsbynplidlist och getfasspregnancydocsbynplidlist till att vara en lista med objekt istället för ett enskilt objekt ( ) Förtydligat dokumentation om och korrigerat exempelinformation för drugclassification- och ControlClass-objekten ( ) Rättat mindre fel i exempelkoden på sidan 18; tjänsten getsubstancesbysubstancename ska bara anropas med en (1) inparameter ( ) Förtydligat dokumentation om attribut i JanusInfoLactationDoc-objekt, speciellt att fältet atccodegroup inte används idag ( ) Korrigerat dokumentation om attributet hasrecommendedarticle för DistributedDrug-objekt och Drug-objekt. Samt för attributet isrecommeded för DrugArticle-objekt. Dessa attribut har värden som beror på det regionid som angavs när respektive objekt hämtades via någon tjänst ( ) Korrigerat dokumentation om tjänsterna getsubstancegroupbysubstancegroupid, getpharmaceuticalformgroupbypharmaceuticalformgroupid och getstrengthgroupbystrengthgroupid. De hade samtliga dokumentation om ytterligare två inparametrar som inte ska finnas.

6 Specifikation 6 (115) 2. Introduktion Detta dokument beskriver SIL SOAP API 3.1. Dokumentet vänder sig till systemutvecklare som vill integrera SIL i journalsystem eller andra expert- och stödsystem i vården. 2.1 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, Version 3.1, Datakällor i SIL SIL SOAP API innehåller en mängd read-only tjänster som ger åtkomst till information om läkemedel i Sverige. SIL SOAP API använder internt en databas som populärt kallas för SIL-databasen. Informationen om läkemedel i SIL-databasen kommer i sin tur från ett antal olika källor och importeras till SIL:s centrala kvalitetssäkringsstöd en gång i veckan. Efter att informationen validerats och granskats skapas sedan en ny SIL-databas som publiceras varje vecka på SIL:s FTP-sajt. Källorna som används i SIL 3.1 är VARA (Apotekens Service AB), NSL (Läkemedelsverket) SFINX (SLL/JanusInfo), FASS (LIF) Amning & graviditetsvarningar (LIF/FASS), Amning & Fosterskador (SLL/JanusInfo), Doseringsregistret (SIL), Utsättningsorsaksregistret (SIL). Information i NSL underhålls av Läkemedelsverket, TLV samt läkemedelsföretagen. SIL har endast redaktionellt ansvar för Doseringsregistret och Utsättningsorsaksregistret. VARA används som grundkälla för information om läkemedelsprodukter och förpackningar. Vidare finns i SIL 3.1 också information om biverkningar som extraherats från Läkemedelsverkets produktresuméer. Dessa informationsextraktion är ännu inte helt kvalitetssäkrad och det är inte ännu fastställt hur den redaktionella processen för denna källa ska se ut. Det innebär att dessa tjänster inte ännu är avsedda användas i skarp produktion. De kan dock användas för att experimentera med hur beslutstödsfunktionalitet för biverkningsinformation kan utformas på ett bra sätt. 2.3 Teknisk lösning SIL tillhandahålls via ett SOAP API. API:et är implementerat med Apache Axis/Java och Tomcat. API:ets tjänstelager är implementerat i Java och använder MS SQL server som databas-backend. 2.4 Utvecklingsmiljö För att kunna utveckla mot SIL SOAP API krävs att man utgår från wdsl-filen för SIL SOAP API. Man kan antingen använda wsdl-filen och generera SOAP-klient stubbar för den utvecklingsmiljö och det programmeringspråk som man utvecklar med eller programmera manuellt mot den. wsdl-filen för SIL SOAP API 3.1 kommer man åt på den URL där man gjort sin installation av SIL-servern med SIL-API. Om man inte har en egen installation av SIL-servern kan man använda wsdl-filen som man kommer åt på testservern för SIL SOAP API (se nästa avsnitt). 2.5 Testmiljö 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 utveckling och test kan man använda en publikt tillgänglig testserver för SIL SOAP API 3.1:

7 Specifikation 7 (115) För att kunna göra kontrollerade tester och systemtester med SIL SOAP API och sitt journalsystem eller beslutsstödsystem bör man givetvis ha en egen installation av SIL-servern med en kontrollerad utgåva av SIL-databasen. 2.6 Definitioner Term Akronym API SOAP SQL Förklaring Application Programming Interface. Programmeringsgränssnitt mot ett program- eller operativsystem. En W3C standard för RPC-baserat API-protokoll. Tidigare stod SOAP för Simple Object Access Protocol. Se: Structured Query Language. Standardiserat frågespråk för kommunikation med relationsdatabaser. Definitioner amningsgrupp (LIF/FASS) amningsriskklass (SLL/JanusInfo) atc-kod biverkning 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 III: osannolik med terapeutiska doser. 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: SLL/JanusInfo klassificering av ett läkemedels dokumenterade effekt på dibarn under amnings perioden. Följande riskklasser finns: A: Sannolikt kompatibelt med amning. B: Underlag för bedömning saknas. C: Särskilda överväganden och/eller med förbehåll. D: Amning avrådes. För mer information om dessa se: Anatomiskt terapeutiskt kemiskt klassifikationssystem för läkemedel. SIL innehåller endast de ATC-koder för vilka det finns minst en registrerad läkemedelsprodukt hos Läkemedelsverket. Oönskad effekt av ett läkemedel.

8 Specifikation 8 (115) Term läkemedelsprodukt drugid eumano Fass-text graviditetskategori (LIF/FASS) graviditetsriskklass (SLL/JanusInfo) handelsnamn icke-läkemedelsvara kontrollkod parallellimporterat läkemedel Förklaring 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. SIL:s id för parallellimporterade läkemedel (Drug). Baseras på NPL-id för originalläkemedelsprodukten. Det europeiska godkännandenummret för en läkemedelsprodukt vilket fastställs av EMA. Beskrivning av läkemedelsprodukter som ges ut av LIF. För varje läkemedelsprodukt baseras texten på den produktresumé (SPC) som registrerats hos Läkemedelsverket då läkemedelsprodukten registrerades och godkändes. LIF/FASS klassificering av ett läkemedels dokumenterade effekt på graviditet vid klinisk användning på människor i rekommenderade terapeutiska doser. Följande gravidtetskategorier finns: A, B, B:1, B:2, B:3, C, D. För mer information om dessa se: SLL/JanusInfo klassificering av ett läkemedels dokumenterade effekt på graviditet vid klinisk användning på människor i rekommenderade terapeutiska doser. Följande gravidtetsriskklasser 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). I SIL avser termen "icke-läkemedelsvara" (NoneDrugArticle) en förskrivningsbar artikel inom förmånen som kan expedieras av apotek men som inte innehåller läkemedel. Exempel: Zetuvit E", 25 styck, sterilt absorbationsförband. Kod som hänvisar till Läkemedelsverkets receptföreskrifter, vilka anger de villkor som föreligger vid förskrivning för att en viss läkemedelsvara t.ex. ett narkotikaklassat läkemedel ska kunna expedieras på apoteken. I SIL avser termen "parallellimporterat läkemedel" (Drug) 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 parallelimporterade läkemedelsprodukter. Parallellimporterade läkemedel identifieras i SIL med drugid.

9 Specifikation 9 (115) Term läkemedelsform läkemedelsvara nollrekommendation semano Förklaring 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äkemedelsvara" (DrugArticle) en hos Läkemedelsverket registrerad läkemedelsförpackning med unikt NPL-packid. Den hör till ett och endast ett distribuerat läkemedel. En lista med rekommenderade läkemedelsvaror kan innehålla ickerekommendationer i betydelsen rekommenderas inte, avstås. Nollrekommendationer kombineras vanligtvis med en hänvisningsrekommendation till en alternativ nivå 7 ATC-kod. Ett läkemedels svenska godkännandenummer. Fastställs av Läkemedelsverket. Datatyper int string boolean float drugform<string> drugids<string [ ]> Anger ett heltal. Anger en textsträng. Anger ett sant eller falskt värde (true/false). Anger ett decimaltal Anger en parameter med namn drugform av datatypen string Anger en parameter med namn drugids innehållande en lista av datatypen string

10 Specifikation 10 (115) 3. Viktiga förändringar i SIL SOAP API 3.1 SIL SOAP API 3.1 är tekniskt bakåtkompatibelt med SIL SOAP API 3.0. Nyheter i SIL-API 3.1 är: Sex (6) nya tjänster för att komma åt information om amnings- och graviditetsvarningar. Detta beror bl.a. på att SIL nu ger åtkomst till två olika källor med denna information. Dels Amnings & Graviditetsvarningar från LIF/FASS och dels Varningar om Amnings- och Fosterskador från JanusInfo/SLL. Tre (3) nya substanstjänster för sökning av substansinformation. Två är för sökning av substanser baserat på nplsubstanceid eller substansnamn och en är för att hämta information om en läkemedelsprodukts substansinnehåll med möjlighet till filtrering så att enbart relevanta modersubstanser returneras. Sex (6) nya tjänster med information om rekommenderade läkemedel. Tre (3) nya tjänster med information om biverkningar. En (1) ny tjänst som ger möjlighet att hämta DrugArticle-, DistributedDrug-, Drug- och Atcobjekt för en (eller flera) förpackningar med ett anrop. De tekniska förändringarna gentemot SIL-API 3.0 är: En del nya tjänster och objekt har tillkommit. Ett antal tjänster har markerats som utgångna (deprecated). Dessa kommer att tas bort i nästa icke-bakåtkompatibla release av SIL SOAP API. Tjänster som markerats som utgångna ska man inte använda i nyutveckling och man ska i förvaltning av existerande system som använder dessa tjänster planera och genomföra anpassningar av sina system till att använda andra tjänster i SIL SOAP API. I SIL-API 3.0 infördes tjänster för att komma åt information om fler läkemedelsprodukttyper än i tidigare versioner av SIL. Då infördes också en gruppering av läkemedelsprodukttyper. Denna gruppering styr vilken information som returneras av en del tjänster i SIL-API. Produkttypsgrupperna är idag: APPROVED. Omfattar produkttyperna MEP, ALL, VBL, RAP, NLM, VUM och NIN. NON_APPROVED. Omfattar produktyperna APL och LIC. TRADITIONAL. Omfattar produkttypen TVB. Tjänsterna för läkemedel som ingår i gruppen APPROVED fungerar som i SIL SOAP API 2.9. Nya tjänster har tillkommit för läkemedel i grupperna NON_APPROVED och TRADITIONAL. Grupper utöver gruppen APPROVED kan komma att ändras i framtiden och integrerande system måste ta det i beaktande vid implementation.

11 Specifikation 11 (115) 3.1 Nya tjänster och objekt Här listas de nya tjänsterna och objekten. Läsaren hänvisas till relevant kapitel i dokumentet för mer ingående information om varje tjänst och objekt. Det finns sex nya tjänster för att hämta information om amnings- och graviditetsvarningar: getsilpregnancylactationwarningsbynplidlist () returnerar SILPregnancyLactationWarning-objekt. getwarningclassificationsbycode () returnerar WarningClassification-objekt. getjanusinfolactationdocsbynplidlist () returnerar JanusInfoLactationDoc-objekt. getjanusinfopregnancydocsbynplidlist () returnerar JanusInfoPregnancyDoc-objekt. getfasslactationdocsbynplidlist () returnerar FassLactationDoc-objekt. getfasspregnancydocsbynplidlist () returnerar FassPregnancyDoc-objekt. Det finns tre nya substansrelaterade tjänster: getsubstancesbynplsubstanceidlist () returnerar Substance-objekt. getsubstancesbysubstancename () returnerar Substance-objekt. getdistributeddrugcontentsbynplidlistfiltered () returnerar DistributedDrugContentobjekt. Det finns sex nya tjänster med information om rekommenderade läkemedel: gettherapygroups () returnerar TherapyGroup-objekt. getindicationpaths () returnerar IndicationPath-objekt. getindicationpath () returnerar IndicationPath-objekt. getrecommendationsbytherapygroupindicationname () returnerar Recommendationobjekt. getrecommendationsbynplpackidlist () returnerar Recommendation-objekt. getrecommendedlistinfosbyregionid () returnerar RecommendedListInfo-objekt. Det finns tre nya tjänster med information om biverkningar: getsideeffectsbynplidlist () returnerar SideEffects-objekt. getsideeffectfrequencies () returnerar String-objekt. getsideeffectsocs () returnerar String-objekt. Det finns en ny Super-tjänst som ger möjlighet att hämta DrugArticle-, DistributedDrug-, Drug- och Atcobjekt för en (eller flera) förpackningar med ett anrop: getsuperdrugarticlesbynplpackidlist () returnerar SuperDrugArticle-objekt. 3.2 Utgångna tjänster och objekt Följande 7 tjänster och tillhörande objekt har markerats som utgågna (deprecated): getpregnancycategoryinfosbycategory () getpregnancycategoryinfos () getlactationgroupinfosbygroup () getlactationgroupinfos () getrecommendlistsbyregionid ()

12 Specifikation 12 (115) getrecommendsbynplpackidlistregionidlisttypes () getrecommendsbytherapygroupindicationnameregionidlisttypes ()

13 Specifikation 13 (115) 4. Objektmodell för läkemedelsinformation SIL SOAP API tillhandahåller tjänster för att komma åt information om förskrivningsbara läkemedel och 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 (parallellimporterat läkemedel), DistributedDrug (läkemedelsprodukt) och DrugArticle (läkemedelsvara). Ett DistributedDrug-objekt representerar en hos Läkemedelsverket registrerad läkemedelsprodukt med unikt NPL-id. Ett DistributedDrug-objekt har en unik kombination av handelsnamn, läkemedelsform, styrka och ansvarigt företag. Ett Drug-objekt representerar ett parallellimporterat läkemedel. Drug-objekt innehåller den gemensamma information som ska gälla för alla läkemedelsprodukter som är parallellimporter till en given läkemedelsprodukt. Det finns således alltid ett Drug-objekt även för sådana läkemedelsprodukter som saknar faktiska parallellimporter. 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äkemedelsförpackning med unikt NPL-packid. Den hör till ett och endast ett distribuerat läkemedel. Nedan ges en översiktlig bild av hierarkin för de grundläggande läkemedelsobjekten Drug, DistributedDrug och DrugArticle samt dess tillhörande, huvudsakliga identifierare. Drug (Läkemedel) Drug (Läkemedel) identifierare: drugid identifierare: drugid En till flera Distributed Drug (Distribuerat Distributed läkemedel) Drug (Distribuerat läkemedel) identifierare: nplid identifierare: nplid Distributed Drug Distributed Drug Distributed Drug Distributed Drug En till flera DrugArticle (Läkemedelsvara) DrugArticle (Läkemedelsvara) identifierare: nplpackid identifierare: nplpackid DrugArticle DrugArticle DrugArticle DrugArticle

14 Specifikation 14 (115) 4.1 Tjänster för att söka efter läkemedelsinformation Sökning på läkemedelsinformation i form av Drug-, DistributedDrug- och DrugArticle-objekt kan göras på flera sätt. Det finns tjänster för att söka efter läkemedelsinformation baserat på bla. handelsnamn, NPL-id, NPL-packid, ATC text eller kod, NPL substansgruppsnamn, NPL substansnamn samt NPL substansid. 4.2 Några exempel I följande exempel presenteras hur man kan söka efter Drug-objekt (läkemedel) och DistributedDrugobjekt (distribuerade läkemedel) och hur informationen som returneras ser ut beroende på om det finns parallellimporter eller inte. Syftet med exemplen är att dels visa på hur man kan söka efter information och dels visa 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 1. För att snabbt komma igång med SIL SOAP-API kan man använda SIL:s testserver 2 och Python-modulen suds 3. Med Python och suds kan man interaktivt ansluta sig till SIL:s testserver med SIL SOAP API så här (se till att använda rätt URL!): >>> 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 tex. 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 enskild 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 idag tillgängliga läkemedelsprodukter och den tredje parametern med värdet -1 anger att vi att vi inte vill begränsa vår sökning till någon regional rekommenderad läkemedelslista. Antalet returnerade DistributedDrug-objekt fås genom att skriva: 1 Exemplen har körts i Python Se för information om hur man kommer åt SIL testservrar. 3 Se för information om suds.

15 Specifikation 15 (115) >>> 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 = " " availabledate = None availableflag = "Y" containslactosflag = "N" containslatexflag = "N" dosdispflag = "N" dosdisplife = 0 dosdisplifeunit = "Månader" drugformcode = "TABLET" drugformtextsv = "Tablett" drugid = " " exportedfromcountrycode = "-" hasrecommendedarticle = True interchangeableflag = "N" localrepresentative = None marketingauthholder = "Bayer AB" nplid = " " parallelimportdeviation = None parimporiginalid = " " procstatusindcode = "-" productnoteind = None salesstoppedflag = "N" sildeviationcode = "-" strengthnumeric = strengthnumericunit = "mg" strengthtext = "500 mg" tradename = "Aspirin " withdrawaldate = None } Även om inte just denna läkemedelsprodukt har några parallellimporter finns det alltså ett Drug-objekt vilket identifieras av fältet drugid. Detta Drug-objekt representerar alltså den gemensamma information som ska vara samma för alla parallellimporter till "Aspirin" om de funnits! Vi kan hämta denna information i form av ett Drug-objekt genom att använda det drugid som är angivet i DistributedDrug-objektet ovan och använda tjänsten getdrugbydrugid: >>> drug = sil.service.getdrugbydrugid (" ", True, -1) >>> print drug (Drug){ controlclasscode = "0" drugclassificationcode = "1" drugformcode = "TABLET" drugformtextsv = "Tablett" drugid = " "

16 Specifikation 16 (115) hasrecommendedarticle = True interactionstatus = 1 interchangeableflag = "N" lactationgroup = "II" pharmaceuticalformgroupid = 0 pharmaceuticalformgroupname = "Ospecificerad" pregnancycategory = "C" prescribercodes[] = "1", "2", "3", "4", "6", prescriptioncode = "0" producttypecode = "MEP" routeofadministrationcodes[] = "-", sildeviationcode = "-" strengthgroupid = 0 strengthgroupname = "Ospecificerad" strengthnumeric = strengthnumericunit = "mg" strengthtext = "500 mg" substancegroupid = 0 substancegroupname = "Ospecificerad" tradename = "Aspirin" withdrawaldate = None } För att verifiera att det inte finns några parallellimporterade läkemedelsprodukter kan vi använda tjänsten getdistributeddrugsbydrugid: >>> ddrugs = sil.service.getdistributeddrugsbydrugid (" ", True, -1) >>> len (ddrugs) 1 Således finns det alltid ett Drug-objekt för varje läkemedelsprodukt även om den inte har några parallellimporter. Notera också att Drug-objekt innehåller information om läkemedel som inte finns tillgängligt i DistributedDrug-objekt En läkemedelsprodukt med parallellimporter: Stilnoct I detta exempel söker vi efter information om läkemedelsprodukter med handelsnamnet "Stilnoct". Det finns två olika grupper av parallellimporterade läkemedelsprodukter som innehåller handelsnamnet "Stilnoct". Således ska det finnas två Drug-Objekt med information om "Stilnoct". Sökning efter information om parallellimporterade läkemedelsprodukter med handelsnamnet "Stilnoct" görs med följande tjänst för Drug-objekt: >>> drugs = sil.service.getdrugsbydistributeddrugtradename ("Stilnoct", True, -1) >>> len (drugs) 2

17 Specifikation 17 (115) Således ser vi att det finns två Drug-objekt som returneras. Det innebär som väntat att det finns två olika grupper med parallellimporterade läkemedelsprodukter som båda innehåller "Stilnoct" i handelsnamnet. För att kunna jämföra dessa två Drug-objekt skriver vi först en liten hjälpfunktion för att skriva ut information om drug-id, handelsnamn, läkemedelsform samt styrka för ett Drug-objekt: >>> def print_drug (drug):... print "%s %s, %s [drugid: %s]" % \... (drug['tradename'], \... drug['strengthtext'], \... drug['drugformtextsv'], \... drug['drugid'])... Vi använder hjälpfunktionen för att titta på handelsnamn, styrka, läkemedelsform samt drug-id för de returnerade Drug-objekten: >>> for x in drugs: print_drug (x)... Stilnoct 5 mg, Tablett (drugid: ) Stilnoct* 10 mg, Tablett (drugid: ) Det sista Drug-objektet har en avslutande asterisk '*' i handelsnamnet. Det innebär att a) det finns minst en läkemedelsprodukt i den gruppen av parallellimporterade läkemedelsprodukter som inte har "Stilnoct" som handelsnamn och b) originalläkemedelsprodukten har handelsnamnet "Stilnoct". Vi kan nu hämta alla läkemedelsprodukter som ingår i den gruppen av paralellimporter med tjänsten: >>> ddrugs = sil.service.getdistributeddrugsbydrugid (" ", True, -1) >>> len (ddrugs) 1 Vi upptäcker då att det bara ingår en läkemedelsprodukt i denna grupp av parallellimporterade läkemedel! Detta beror på att vi har angivit värdet True på den andra parametern i anropet. Det anger att vi bara vill se läkemedelsprodukter för vilka det finns minst en tillgänglig läkemedelsförpackning. Om vi istället vill se alla läkemedelsprodukter som ingår i denna grupp av parallellimporter, oavsett om de har tillgängliga läkemedelsförpackningar eller inte, ska vi anropa med värdet False: >>> ddrugs = sil.service.getdistributeddrugsbydrugid (" ", False, -1) >>> len (ddrugs) 10 För att kunna jämföra dessa tio DistributedDrug-objekt skriver vi först en liten hjälpfunktion för att skriva ut information om handelsnamn, styrka, läkemedelsform, NPL-id, tillgänglighet samt ansvarigt företag (MAH) för ett DistributedDrug-objekt: >>> def print_ddrug (ddrug):... print "%s %s, %s, [nplid: %s, (%s), MAH: %s]" % \... (ddrug['tradename'], \... ddrug['strengthtext'], \... ddrug['drugformtextsv'], \... ddrug['nplid'], \... ddrug['availableflag'], \... ddrug['marketingauthholder'])...

18 Specifikation 18 (115) Om vi använder denna funktion för att skriva ut information om alla tio läkemedelsprodukterna ovan får vi: >>> for x in ddrugs: print_ddrug (x)... Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (Y), MAH: sanofi-aventis AB] Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Paranova Läkemedel AB] Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Paranova Läkemedel AB] Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Paranova Läkemedel AB] Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Orifarm AB] Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Orifarm AB] Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Paranova Läkemedel AB] Stilnoct 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Orifarm AB] Stilnox 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Medartuum AB] Stilnox 10 mg, Filmdragerad tablett, [nplid: , (N), MAH: Medartuum AB] Då ser vi att det bara är en av alla läkemedelsprodukterna som är tillgänglig (vilket indikeras med ett 'Y' inom parentes), dvs. har minst en tillgänglig läkemedelsförpackning. Vi ser också att det finns två läkemedelsprodukter som har ett annat handelsnamn än originalläkemedelsprodukten, nämligen "Stilnox". Det är därför som Drug-objektet som representerar denna grupp av parallellimporter har en asterisk '*' i slutet av handelsnamnet. Den uppmärksamme läsaren ser att det finns tre parallellimporterade läkemedelsprodukter i listan ovan som har samma handelsnamn, styrka, läkemedelsform och ansvarigt företag (NPL-id: , och ). Det som skiljer dem är att de importeras från olika länder (Spanien, Portugal och Grekland). Informationen om vilket land läkemedelsprodukten importeras från finns tillgänglig i fältet exportedfromcountrycode i respektive DistributedDrugobjekt En substans som börjar med vissa tecken: Ace För att anropa en specifik tjänst som t.ex. getsubstancesbysubstancename kan man för att få alla substanser med substansnamn som börjar med "ace" skriva: >>> subs = sil.service.getsubstancesbysubstancename ("ace%") Resultatet av anropet är nu tillgängligt i variabeln subs. För att presentera resultat av anrop i kan man använda Pythons standardfunktion print: >>> print subs [(Substance){ casno = None children[] = <empty> nplsubstanceid = "IDE4POFKUB2F9VERT1" parents[] = <empty> substancename = "aceklofenak"

19 Specifikation 19 (115) 5. Tjänster Detta avsnitt beskriver samtliga tjänster som ingår i SIL SOAP API. Tjänsterna och den information de returnerar är beroende av strukturen och informationsinnehållet i de datakällor som SIL använder. I designen av API:et har vi försökt att i möjligaste mån ta höjd för framtida förändringar i datakällorna för att åstadkomma ett stabilt tjänstegränssnitt. Notera att för de fall där en sträng kan användas som inparameter kan man i vissa fall använda SQLspecifik syntax. Ett exempel på detta är wildcards, som innebär att man kan ange % -tecken som del av strängen (%alv% söker oberoende av versaler och gemener efter sträng som innehåller texten alv ). En del tjänster tillåter dock inte wildcards. Det framgår då i kommentarfältet för tjänsten. 5.1 Felhantering Felhanteringen i SIL-gränssnittet är implementerad genom att tjänsterna kastar SILExceptions vid felsituationer. Ett SilException består av en kod (errorcode) samt en förklarande text (errormsg). Följande felkoder (errorcode) finns för tillfället: errorcode errormsg 100 Invalid parameter 800 Service returns too many elements 900 Server received an internal error När felsituationer uppstår skickar webbservern AxisFault exceptions till klienten med en <detail> tag, som bl.a. innehåller detta SilException, se nedan. Ur detta xml-meddelande kan sedan errorcode och errormsg erhållas genom traditionell xml-parsning. <detail> <sil.main.silexception xsi:type="ns1:silexception" xmlns:ns1="urn:xml-soap-sil"> <errorcode xsi:type="xsd:int">100</errorcode> <errormsg xsi:type="xsd:string"> Invalid parameter </errormsg> </sil.main.silexception> </detail>

20 Beskrivning 20 (115) 5.2 Exempel (OBS! endast exempel) I detta kapitel ges en beskrivning av den struktur för information om tjänsterna som behandlas i resterande del av dokumentet. Beskrivning av de olika fälten och kolumnerna finns inom parentes. Id Namn SOAP Inparametrar Kommentar getexampleservice (namn på tjänsten, case-sensitive) Inparametrar Respons Villkor Exempel Returnerar Atc-objekt för angiven Atc-kod. atccode<string> <Atc[ ]> längd = 8 C07AA Wildcard tillåtet (Beskrivning av tjänsten) (inparameterbeskrivning) (returobjektbeskrivning) (fristående exempel på inparameter) (förtydligande beskrivning och begränsningar) Exempel-objekt (OBS! endast exempel) Objekt som skickas som svar på anrop av tjänsterna där Exempel-objekt returneras. atcexamplecode (attributnamn) <string> (datatyp) 8 (fältlängdbegränsning) Atc-kod (Fältbeskrivning) C07AA (fristående exempel på fälttvärde) atcexample <string> Se (referens till annan del av dokumentet) Beskrivning av den komplexa Atc-strukturen... Atc-kod kan anta värden mellan...