SIL SOAP API 4.0. beta prerelease

Transkript

1 SIL SOAP API 4.0 beta prerelease Nyheter och förändringar gentemot SIL SOAP API 3.1 Sid 1/19

2 Innehållsförteckning 1. Inledning Sammanfattning Tekniska förutsättningar Generellt Ny driftmiljö Loggning FTP-server för hämtning av SIL-databas Anpassning till SIL SOAP API Läkemedelsprodukter Tjänster DistributedDrug-objekt Parallellimporterade läkemedel Tjänster Drug-objekt Läkemedelsartiklar Tjänster DrugArticle-objekt ExchangePeriod-objekt Handelsvaror Tjänster NonDrugArticle-objekt Graviditet- och amningsvarningar Tjänster JanusInfoLactation-objekt Rekommenderade läkemedel Tjänster Organisationer och företag Referensdatatjänster Tjänster Ytterligare attribut som troligtvis tas bort Sid 2/19

3 13. Produktions- och driftändringar Dagliga uppdateringar av SIL-databasen Konsekvens för driftansvariga i Landstingen Övriga nyheter Rapporter om senaste produktion av SIL-databas Sid 3/19

4 1. Inledning Detta dokument innehåller en beskrivning av nyheter och förändringar i SIL SOAP API 4.0 gentemot SIL SOAP API 3.1. SIL SOAP API 4.0 är inte tekniskt bakåtkompatibelt med SIL SOAP API 3.1, men förändringarna är inte speciellt omfattande och vi bedömer att det inte bör vara något omfattande arbete att anpassa system som är integrerade med 3.1 till 4.0. Dokumentet vänder sig till systemutvecklare, produktansvariga och verksamhetsansvariga som arbetar med integration av journalsystem och andra beslutsstödssystem med SIL. Dokumentet ska ses som ett komplement till "Tjänstegränssnittsbeskrivning för SIL SOAP API 3.1". När SIL SOAP API 4.0 släpps kommer det att finnas en komplett, sammanhållen och uppdaterad Tjänstegränssnittsbeskrivning för SIL SOAP API 4.0. Under juni 2014 kommer en betarelease av SIL SOAP API 4.0 göras och då kommer en testserver göras tillgänglig för att externa system ska kunna testa mot den kommande releasen. Avsikten är att SIL 4.0 och SIL SOAP API 4.0 ska släpps den 30 september Då upphör produktion av SIL Sammanfattning SIL SOAP API 4.0 är inte tekniskt bakåtkompatibelt med SIL SOAP API 3.1. Det innehåller dock inga nya stora informationsmängder. Syftet med en icke-bakåtkompatibel release är att dels att erbjuda en del ny och viktig information och dels att ta bort ett antal utgångna tjänster. Sammanfattningsvis innehåller SIL SOAP API 4.0 följande förändringar: En (1) ny tjänst. Ett (1) nytt objekt. Tretton (13) borttagna tjänster. Sju (7) borttagna objekt. Fem (5) ändrade objekt. Fem (5) nya attribut i olika objekt. Sju (7) attribut som fått ändrade namn. Med releasen av SIL SOAP API avser SIL förvaltning även att börja uppdatera viss information i SIL-databasen varje dag. Det innebär att driftorganisationer och driftansvariga för SIL-servrar bör anpassa sina uppdateringsrutiner så att en ny SIL-databas hämtas varje natt. Sid 4/19

5 3. Tekniska förutsättningar SIL SOAP API 4.0 är som ovan nämnts inte tekniskt bakåtkompatibelt med SIL SOAP API Generellt För en generell genomgång av de tekniska förutsättningarna för integration med SIL SOAP API se dokumentet "Tjänstegränssnittsbeskrivning för SIL SOAP API 3.1". Den generella URL:en till SIL SOAP API:et på SIL-servrar kommer att se ut så här: Givetvis måste man ange rätt server och port för den server man vill anropa Ny driftmiljö SIL-servern med SIL SOAP API 4.0 är avsedd att köras på följande plattform: Windows Server Microsoft SQL Server Java 7 eller Java Loggning Loggningen i SIL-server kommer att förändras för att dels underlätta vid felsökning och dels generera mer relevant information om hur SIL SOAP API används. Instruktioner om hur man ska och bör konfigurera SIL-servern avseende loggning kommer i den uppdaterade installations- och driftmanualen för SIL-servern FTP-server för hämtning av SIL-databas Vi kommer att byta FTP-server programvara som används på den FTP-server där man hämtar SIL-Server samt SIL-Databas. Vi kommer också att inför SITHS funktionscertifikat (servercertifikat) på den FTP-servern. Instruktioner om vad driftansvariga måset göra för att anpassa drift- och uppdateringsskript kommer i den uppdaterade installations- och driftmanualen för SIL-Servern. Sid 5/19

6 3.5. Anpassning till SIL SOAP API 4.0 Förändringarna som gjorts i API:et avser tjänster, objekt och attribut som tagits bort eller tillkommit. De kan således kategoriseras enligt: a) Borttagen, b) Borttagen och ersatt av, c) Ny. Om ett system som integrerat med SIL SOAP API inte använder någon av de borttagna tjänsterna, objekten och attributen så måste de ändå kompilera om sitt system och köra sina tester. För de system som integrerat med tjänster, objekt eller attribut som tagits bort så måste de anpassa sin kod så att de inte använder dem och i tillämpliga fall använder ersättande eller nytillkomna tjänster, objekt och attribut. I resten av dokumentet är varje förändring märkt som en av Borttagen, Borttagen och ersatt av eller Ny. Till varje förändring står också konsekvens och förslag på åtgärd som bör göras av förvaltare av integrerande system. Sid 6/19

7 4. Läkemedelsprodukter 4.1. Tjänster Inga borttagna eller nya tjänster DistributedDrug-objekt Följande ändringar av attribut är gjorda i DistributedDrug-objekt. Attribut Förändring Kommentar och Föreslagen åtgärd availableflag availabledate Borttagen och ersatt av marketedflag Borttagen och ersatt av marketedfromdate Kommentar: Samma namn som i VARA2 och kommunicerar bättre vad attributet avser. Åtgärd: Gör search and replace i källkod som använder detta attribut. Kommentar: Samma namn som i VARA2 och kommunicerar bättre vad attributet avser. Åtgärd: Gör search and replace i källkod som använder detta attribut. ProcStatusIndCode Borttagen Kommentar: Ej tillämpligt längre (har inte använts). sildeviationcode Borttagen Kommentar: Ej tillämpligt längre (har inte använts). hasantirecommmendedarticle Ny Kommentar: Liknande attribut finns redan på DrugArticle. Anger om någon artikel som hör till produkten är antirekommenderad. sillactationcode Ny Kommentar: Anger kod för läsanvisning baserat på klassificering av information från JanusInfo och FASS om amning. silpregnancycode Ny Kommentar: Anger kod för läsanvisning baserat på klassificering av information från JanusInfo och FASS om graviditet. Sid 7/19

8 5. Parallellimporterade läkemedel 5.1. Tjänster Inga borttagna eller nya tjänster Drug-objekt Följande ändringar av attribut är gjorda i Drug-objekt. Attribut Förändring Kommentar och Föreslagen åtgärd lactationgroup Borttagen Kommentar: Ej tillämpligt längre. Innehöll tidigare effektgruppering för effekter vid amning, från FASS. Information om detta kan fås via tjänsten getsilpregnancylactationwarningsbyn plidlist pregancycategory Borttagen Kommentar: Ej tillämpligt längre. Innehöll tidigare informationskategori för effekter vid graviditet, från FASS. Information om detta kan fås via tjänsten getsilpregnancylactationwarningsbyn plidlist sildeviationcode Borttagen Kommentar: Ej tillämpligt längre (har inte använts). hasantirecommmendedarticle Ny Kommentar: Liknande attribut finns redan på DrugArticle. Anger om någon artikel som hör till produkten är antirekommenderad. Sid 8/19

9 6. Läkemedelsartiklar 6.1. Tjänster Inga borttagna eller nya tjänster DrugArticle-objekt Följande ändringar av attribut är gjorda i DrugArticle-objekt. Attribut Förändring Kommentar och Föreslagen åtgärd availableflag availabledate lfnpriceaupprescription eancode Borttagen och ersatt av marketedflag Borttagen och ersatt av marketedfromdate Borttagen och ersatt av aup Borttagen och ersatt av barcode. Kommentar: Samma namn som i VARA2 och kommunicerar bättre vad attributet avser. Åtgärd: Gör search and replace i källkod som använder detta attribut. Kommentar: Samma namn som i VARA2 och kommunicerar bättre vad attributet avser. Åtgärd: Gör search and replace i källkod som använder detta attribut. Kommentar: Samma namn som i VARA2 och kommunicerar bättre vad attributet avser (Apotekens utförsäljningspris ). Åtgärd: Gör search and replace i källkod som använder detta attribut. Kommentar: Samma namn som i VARA2 och kommunicerar bättre vad attributet avser (Streckkod ). Åtgärd: Gör search and replace i källkod som använder detta attribut. sildeviationcode Borttagen Kommentar: Ej tillämpligt längre (har inte använts). isreimbursed Ny Kommentar: Anger om artikeln ingår i förmånen. Sid 9/19

10 6.3. ExchangePeriod-objekt Följande ändringar av attribut är gjorda i ExchangePeriod-objekt. Attribut Förändring Kommentar och Föreslagen åtgärd rank Ny Kommentar: Detta anger rangen på månadens vara enligt VARA2. aipperunit Ny Kommentar: Apotekens inköpspris per enhet under angiven utbytesperiod. aupperunit Ny Kommentar: Apotekens utförsäljningsspris per enhet under angiven utbytesperiod. Sid 10/19

11 7. Handelsvaror 7.1. Tjänster Inga borttagna eller nya tjänster. Objektet NoneDrugArticle byter namn till NonDrugArticle. Rekommenderad åtgärd för integrerande system: Gör search-and-replace i källkoden. Följande tjänster byter namn: getnonedrugarticlebyarticlegroupcode byter namn till getnondrugarticlebyproductgroupcode. getnonedrugarticlesbyarticlename byter namn till getnondrugarticlesbyarticlename. getnonedrugarticlesbyarticlegroupcode byter namn till getnondrugarticlesbyarticlegroupcode. getnonedrugarticlesbyarticlenolist byter namn till getnondrugarticlesbyarticlenolist. Rekommenderad åtgärd för integrerande system: Gör search-and-replace i källkoden NonDrugArticle-objekt Följande ändringar av attribut är gjorda i nondrugarticle-objekt. Attribut Förändring Kommentar och Föreslagen åtgärd sellingprice isdiscounted articlegroupcode Borttagen och ersatt av aup. Borttagen och ersatt av isreimbursed. Borttagen och ersatt av productgroupcode Kommentar: Samma namn som i VARA2 och kommunicerar bättre vad attributet avser (Apotekens utförsäljningspris ). Åtgärd: Gör search and replace i källkod som använder detta attribut. Kommentar: Anger om artikeln ingår i förmånen. Den engelska termen är reimbursed. Åtgärd: Gör search and replace i källkod som använder detta attribut. Kommentar: Heter handelsvarugrupp i VARA2 och anges för handelsvaruprodukter. SIL har haft denna information men har kallat attributet articlegroupcode vilket är missvisande. Åtgärd: Gör search and replace i källkod som använder detta attribut. articlegroupcode Ny Kommentar: Är ett nytt informationselement i VARA2 och anger varugruppkod på handelsvaruartiklar. Sid 11/19

12 productdescription Ny Kommentar: Innehåller kompletterande produktbeskrivning av aktuell handelsvara. Sid 12/19

13 8. Graviditet- och amningsvarningar 8.1. Tjänster Följande tjänster har tagits bort: getpregnancycategoryinfosbycategory. Utgången tidigare i SIL 3.1 p.g.a ny hantering av graviditetsvarningar från två källor FASS och JanusInfo. getpregnancycategoryinfos. Utgången tidigare i SIL 3.1 p.g.a ny hantering av graviditetsvarningar från två källor FASS och JanusInfo. getlactationgroupinfosbygroup. Utgången tidigare i SIL 3.1 p.g.a ny hantering av amningsvarningar från två källor FASS och JanusInfo. getlactationgroupinfos. Utgången tidigare i SIL 3.1 p.g.a ny hantering av amningsvarningar från två källor FASS och JanusInfo. Ta bort eventuella referenser till tjänsterna i källkod. Följande objekt har tagits bort: PregnancyCategoryInfo-objekt. Utgången tidigare i SIL 3.1 p.g.a ny hantering av graviditetsvarningar från två källor FASS och JanusInfo. LactationGroupInfo-objekt. Utgången tidigare i SIL 3.1 p.g.a ny hantering av amningsvarningar från två källor FASS och JanusInfo. Ta bort eventuella referenser till objekten i källkod JanusInfoLactation-objekt Följande ändringar av attribut är gjorda i DrugArticle-objekt. Attribut Förändring Kommentar och Föreslagen åtgärd atccodegroup Borttagen. Kommentar: Informationen tillhandahålls inte av källan JanusInfo. Sid 13/19

14 9. Rekommenderade läkemedel 9.1. Tjänster Följande tjänster har tagits bort: getrecommendlistsbyregionid. Kommentar: Ersatt tidigare i SIL 3.1 av getrecommendedlistinfosbyregionid. getrecommendsbynplpackidlistregionidlisttypes. Kommentar: Ersatt tidigare i SIL 3.1 av getrecommendationsbynplpackidlist. getrecommendsbytherapygroupindicationnameregionidlisttypes. Kommentar: Ersatt tidigare i SIL 3.1 av getrecommendationsbytherapygroupindicationname. getdrugidshasantirecommendedarticlebydrugidlistregionid. Kommentar: Använd det nya attributet hasantirecommendedarticles i DistributedDrug- och Drug-objekt. GetNplIdsHasAntiRecommendedArticleByNplIdListRegionId. Kommentar: Använd det nya attributet hasantirecommendedarticles i DistributedDRug- och Drug-objekt. Ta bort eventuella referenser till de borttagna tjänsterna i källkod. Följande objekt har tagits bort: Recommed-objekt. Kommentar: Ersatt tidigare i SIL 3.1 av Recommendation-objekt. RecommedList-objekt. Kommentar: Ersatt tidigare i SIL 3.1 av RecommendedListInfo-objekt. Indic-objekt. Kommentar: Ersatt tidigare i SIL 3.1 av Indication-objekt. Ta bort eventuella referenser till objekten i källkod. Sid 14/19

15 10. Organisationer och företag Det troligtvis en eller ett par tjänster med utökad information om organisationer (läs juridiska personer) och deras roller kopplat till läkemedelsproukter och artiklar. Idag finns information om innehavare av godkännande för försäljning av produkter (marketing authorisation holder) och svensk försäljningsrepresentant (local representative) av produkter i DistributedDrugobjekt. Den informationen kommer att vara kvar men det finns kompletterande information i VARA2 som vi gärna tillhandahåller. Sid 15/19

16 11. Referensdatatjänster Tjänster Följande tjänster har tagits bort: getsildeviations. Ej tillämpligt längre (har inte använts). getsildeviationbycode. Ej tillämpligt längre (har inte använts). getprocstatuses. Ej tillämpligt längre (har inte använts). getprocstatusesbycode. Ej tillämpligt längre (har inte använts). Ta bort eventuella referenser till tjänsterna i källkod. Följande objekt har tagits bort: SilDeviation-objekt. Ej tillämpligt längre (har inte använts). ProcStatus-objekt. Ej tillämpligt längre (har inte använts). Ta bort eventuella referenser till objekten i källkod. Sid 16/19

17 12. Ytterligare attribut som troligtvis tas bort Följande attribut kommer troligtvis att tas bort men en del utredningsarbete kvarstår. Det finns alltså inget beslut taget om dessa i dag. Attribut Förändring Kommentar och Föreslagen åtgärd DrugArticle-objekt barcodesingledose DrugArticle-objekt packsizealphanumeric DistributedDrugContent-objekt comptotweightvol DistributedDrugContent-objekt comptotweightvolunitcode DistributedDrugContent-objekt comprefquantitycode Tas bort. Tas bort. Tas bort. Tas bort. Tas bort. Kommentar: Streckkod på endosförpackning för t.ex. sjukhusbruk. Streckkodsstandard Code 39 används. För framtida bruk, används ej i nuläget. Oklart om det finns en källa. Kommentar: Förpackningsantal som inte kan uttryckas numeriskt. För framtida bruk, används ej i nuläget. Oklart om det finns en källa. Kommentar: Totalvikt eller volym för ingredienserna. För framtida bruk, används ej i nuläget. Oklart om det finns en källa. Kommentar: Kod som representerar enhet till totalvikt eller volym för ingredienserna. För framtida bruk, används ej i nuläget. Oklart om det finns en källa. Kommentar: Kod som representerar den enhet till vilken ingrediensens mängd refererar. För framtida bruk, används ej i nuläget. Oklart om det finns en källa. Sid 17/19

18 13. Produktions- och driftändringar Dagliga uppdateringar av SIL-databasen Då SIL 4.0 sätts i produktion kommer SIL-databasen att ha en större uppdatering av hela innehållet varje vecka och sedan mindre uppdateringar varje dag. Den större uppdateringen varje vecka fungerar precis som idag. De mindre uppdateringarna omfattar visa avgränsade informationsmängder i SIL-databasen. Det är idag inte exakt bestämt vilken information som kommer att uppdateras varje dag, men med största sannolikhet omfattar det FASS-information från FASS Konsekvens för driftansvariga i Landstingen Detta innebär att alla driftansvariga för SIL-servrar bör se till att uppdatera sina drift och uppdateringsskript så att en ny SIL-databas hämtas varje natt, om man vill ha tillgång till de mindre dagliga uppdateringarna. Sid 18/19

19 14. Övriga nyheter Rapporter om senaste produktion av SIL-databas SIL kommer att tillhandahålla rapporter om varje produktion av SIL-databasen och dess innehåll, och göra dessa tillgängliga på SIL:s hemsida. Rapporterna kommer att innehålla information om antal produkter och artiklar men också om förändringar sedan förra produktionen. T.ex. om vilka produkter och artiklar som är nya eller avregistrerade och om vilka produkter som fått ändrad information, t.ex. rörande godkännande, avregistrering etc. Exakt hur rapporterna kommer att se ut är inte klart idag. Sid 19/19