SIL SOAP API 4.0

SIL SOAP API 4.0
Tjänstegränssnittsbeskrivning
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Revisionshistorik
Version
Författare
Kommentar
1.0 (2014-09-30)
Paul Cohen
Första utgåva.
1.1 (2014-12-17)
Paul Cohen
Korrigerat beskrivning av text-attributet i
FassLactationDoc-objekt (4.13.15).
Korrigerat funktionsnamn i exemplet för
getStoragesByNplPackIdList (4.8.2).
Tagit bort kommentaren ”För framtida bruk, används ej i
nuläget.” i beskrivningen av attributen
salesRestrictionCodes och marketedFromDate i
DrugArticle-objekt (4.7.11), av attributet i
marketedFromDate i DistributedDrug-objekt (4.7.11),
och av attributet compRefQuantityCode i
DistributedDrugContent-objekt (4.16.6). Dessa attribut
har värden nu.
Korrigerat beskrivningen av attributet
routeOfAdministrationCodes i Drug-objekt (4.5.9) samt
av attributen routeOfAdministration och
patientInformation i Dosage-objekt så att det står ”För
framtida bruk, används ej i nuläget.”.
Förtydligat beskrivningen av CompRefQuantity-objekt
(4.23.64).
Några smärre stiljusteringer av texten i några avsnitt.
1.2 (2015-01-19)
Paul Cohen
Rättat skrivelse om hur ofta den publicerade SILdatabasen uppdateras i avsnitt 1.2 Allmänt.
1.3 (2015-04-14)
Erik Heneryd
Rättat beskrivningen av
getSuperDrugArticlesByNplPackIdList (4.22.9) som
hade fått en extra, icke-existerande parameter och fel
returtyp.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 2/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Innehåll
1. Inledning .............................................................................................................................. 10
1.1 Avgränsningar ................................................................................................................. 10
1.2 Allmänt ........................................................................................................................... 10
1.3 Integration ....................................................................................................................... 10
1.4 Drift av SIL-server och uppdatering av SIL-databas ....................................................... 11
1.5 Datakällor i SIL ................................................................................................................ 11
1.6 Teknisk lösning ................................................................................................................ 11
1.7 Utvecklingsmiljö för integrerande system ....................................................................... 12
1.8 Testmiljö .......................................................................................................................... 12
1.9 Definitioner ..................................................................................................................... 13
1.9.1 Vård- och läkemedelsinformatiktermer ..................................................................................... 13
1.9.2 Tekniktermer ............................................................................................................................. 15
1.9.3 SIL SOAP API termer ............................................................................................................... 16
1.10 Stilkonventioner ............................................................................................................ 16
2. Viktiga förändringar i SIL SOAP API 4.0 ........................................................................... 17
2.1 Ändrade objekt ................................................................................................................ 17
2.2 Nya tjänster och objekt ................................................................................................... 19
2.3 Borttagna tjänster och objekt .......................................................................................... 19
3. Objektmodell för läkemedelsinformation ......................................................................... 21
3.1 SIL:s produkttypsgrupper ................................................................................................ 22
3.2 Tjänster för att söka efter läkemedelsinformation ........................................................... 22
3.3 Exempel .......................................................................................................................... 23
3.3.1 En läkemedelsprodukt utan parallellimporter: ”Aspirin” ............................................................ 23
3.3.2 En läkemedelsprodukt med parallellimporter: ”Stilnoct” ........................................................... 25
3.3.3 Sökning på substanser som börjar med tecknen ”Ace” ........................................................... 28
4. Tjänster ................................................................................................................................ 29
4.1 Inledning ......................................................................................................................... 29
4.2 Organisation och layout av beskrivningarna ................................................................... 29
4.3 Felhantering .................................................................................................................... 30
4.4 ATC-koder ....................................................................................................................... 31
4.4.1 getAtcsByAtcCode .................................................................................................................... 31
4.4.2 getAtcsByTextSv ....................................................................................................................... 31
4.4.3 getAtcsByDrugId ....................................................................................................................... 32
4.4.4 getAtcNarrowersByAtcCode ..................................................................................................... 32
4.4.5 getAtcWiderByAtcCode ............................................................................................................ 32
4.4.6 getAtcsByAtcCodeAndLevelInterval ......................................................................................... 33
4.4.7 getAtcsByTextSvAndLevelInterval ............................................................................................ 33
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 3/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.4.8 getAtcsByLevel ......................................................................................................................... 34
4.4.9 getAtcsByAtcCodeList .............................................................................................................. 34
4.4.10 getDrugAtcCodesByDrugIdList ............................................................................................... 34
4.4.11 getAtcCodeDrugsByAtcCodeList ............................................................................................ 35
4.4.12 Atc ........................................................................................................................................... 35
4.4.13 DrugAtcCode .......................................................................................................................... 35
4.4.14 AtcCodeDrug .......................................................................................................................... 35
4.5 Parallellimporterade läkemedel ...................................................................................... 36
4.5.1 getDrugsByAtcCode ................................................................................................................. 36
4.5.2 getDrugsByDistributedDrugTradeName ................................................................................... 37
4.5.3 getDrugByDrugId ...................................................................................................................... 37
4.5.4 getDrugsByDrugIdList ............................................................................................................... 38
4.5.5 getDrugsBySubstanceGroupId ................................................................................................. 38
4.5.6 getDrugsByPharmaceuticalFormGroupId ................................................................................. 39
4.5.7 getDrugsByStrengthGroupId .................................................................................................... 39
4.5.8 getDrugIdsByNplIdList .............................................................................................................. 40
4.5.9 Drug .......................................................................................................................................... 40
4.6 Läkemedelsprodukter ..................................................................................................... 42
4.6.1 getDistributedDrugsByDistributedDrugTradeName .................................................................. 42
4.6.2 getDistributedDrugByNplId ....................................................................................................... 43
4.6.3 getDistributedDrugsByNplIdList ................................................................................................ 43
4.6.4 getDistributedDrugsByDrugId ................................................................................................... 44
4.6.5 getDistributedDrugsByDrugIdList ............................................................................................. 44
4.6.6 getDistributedDrugHistoricalNamesByNplId ............................................................................. 45
4.6.7 getNplIdsByDistributedDrugHistoricalName ............................................................................. 45
4.6.8 getInterchangeableDistributedDrugsByNplId ............................................................................ 46
4.6.9 getDistributedDrugsByNplSubstanceId .................................................................................... 46
4.6.10 getDistributedDrugsBySubstanceName ................................................................................. 47
4.6.11 getUnauthorisedDistributedDrugsBySubstanceName ............................................................ 47
4.6.12 getUnauthorisedDistributedDrugsByNplSubstanceId ............................................................. 48
4.6.13 DistributedDrug ....................................................................................................................... 48
4.7 Läkemedelsartiklar .......................................................................................................... 51
4.7.1 getDrugArticlesByDistributedDrugTradeName ......................................................................... 51
4.7.2 getDrugArticlesByDrugId .......................................................................................................... 52
4.7.3 getDrugArticlesByDrugIdList ..................................................................................................... 52
4.7.4 getDrugArticlesByNplId ............................................................................................................. 53
4.7.5 getDrugArticlesByNplIdList ....................................................................................................... 53
4.7.6 getDrugArticleByNplPackId ...................................................................................................... 54
4.7.7 getDrugArticlesByNplPackIdList ............................................................................................... 54
4.7.8 getHistoricalArticleNosByNplPackId ......................................................................................... 55
4.7.9 getNplPackIdsByDateAdded .................................................................................................... 55
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 4/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.7.10 getTlvExchangesByNplPackIdList .......................................................................................... 56
4.7.11 DrugArticle .............................................................................................................................. 56
4.7.12 TlvExchange ........................................................................................................................... 58
4.7.13 ExchangePeriod ..................................................................................................................... 58
4.8 Läkemedelsförvaring ...................................................................................................... 59
4.8.1 getStoragesByNplPackId .......................................................................................................... 59
4.8.2 getStoragesByNplPackIdList .................................................................................................... 59
4.8.3 Storage ..................................................................................................................................... 60
4.9 Läkemedelsformer .......................................................................................................... 61
4.9.1 getDrugForms ........................................................................................................................... 61
4.9.2 getDrugFormByDrugFormCode ................................................................................................ 61
4.9.3 DrugForm .................................................................................................................................. 62
4.9.4 Dosage ..................................................................................................................................... 62
4.10 FASS-texter .................................................................................................................. 63
4.10.1 getFassDocsByDrugId ............................................................................................................ 63
4.10.2 getFassDocsByNplId .............................................................................................................. 63
4.10.3 FassDoc .................................................................................................................................. 63
4.11 Interaktioner .................................................................................................................. 64
4.11.1 getInteractionsByDrugIdAgainstAll ......................................................................................... 64
4.11.2 getInteractionsByDrugIdAgainstList ........................................................................................ 65
4.11.3 getInteractionsWithinDrugIdList .............................................................................................. 65
4.11.4 getShortInteractionsByInteractionIdList .................................................................................. 66
4.11.5 getInteractionsByDrugIdAgainstListSevClassification ............................................................ 66
4.11.6 getInteractionsWithinDrugIdListSevClassification ................................................................... 67
4.11.7 getCompleteInteractionByInteractionId ................................................................................... 67
4.11.8 DrugInteraction ....................................................................................................................... 68
4.11.9 ShortInteraction ....................................................................................................................... 68
4.11.10 InteractionSection ................................................................................................................. 69
4.11.11 CompleteInteraction .............................................................................................................. 69
4.11.12 InteractingPart ....................................................................................................................... 69
4.11.13 Reference ............................................................................................................................. 69
4.12 Biverkningar .................................................................................................................. 70
4.12.1 getSideEffectsByNplIdList ...................................................................................................... 71
4.12.2 getSideEffectFrequencies ....................................................................................................... 71
4.12.3 getSideEffectSocs .................................................................................................................. 71
4.12.4 SideEffects .............................................................................................................................. 72
4.12.5 SideEffect ............................................................................................................................... 72
4.13 Graviditets- och amningsvarningar ............................................................................... 73
4.13.1 getSILPregnancyLactationWarningsByNplIdList .................................................................... 73
4.13.2 getWarningClassificationsByCode .......................................................................................... 74
4.13.3 getJanusInfoLactationDocsByNplIdList .................................................................................. 74
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 5/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.13.4 getJanusInfoPregnancyDocsByNplIdList ................................................................................ 75
4.13.5 getFassLactationDocsByNplIdList .......................................................................................... 75
4.13.6 getFassPregnancyDocsByNplIdList ....................................................................................... 76
4.13.7 SILPregnancyLactationWarning ............................................................................................. 76
4.13.8 SourceWarning ....................................................................................................................... 76
4.13.9 WarningClassification ............................................................................................................. 77
4.13.10 JanusInfoLactationDoc ......................................................................................................... 77
4.13.11 JanusInfoPregnancyDoc ....................................................................................................... 78
4.13.12 JanusInfoReference .............................................................................................................. 78
4.13.13 JanusInfoLink ........................................................................................................................ 78
4.13.14 FassPregnancyDoc .............................................................................................................. 79
4.13.15 FassLactationDoc ................................................................................................................. 79
4.14 Rekommenderade läkemedel ....................................................................................... 80
4.14.1 getValidRegions ...................................................................................................................... 80
4.14.2 getListTypes ............................................................................................................................ 81
4.14.3 getTherapyGroups .................................................................................................................. 81
4.14.4 getIndicationPaths .................................................................................................................. 82
4.14.5 getIndicationPath .................................................................................................................... 83
4.14.6 getRecommendationsByNplPackIdList ................................................................................... 84
4.14.7 getRecommendationsByTherapyGroupIndicationName ........................................................ 85
4.14.8 Region .................................................................................................................................... 85
4.14.9 ListType .................................................................................................................................. 85
4.14.10 TherapyGroup ....................................................................................................................... 86
4.14.11 IndicationPath ....................................................................................................................... 86
4.14.12 Indication .............................................................................................................................. 86
4.14.13 RecommendedListInfo .......................................................................................................... 87
4.14.14 Recommendation .................................................................................................................. 87
4.14.15 IdentifierValue ....................................................................................................................... 88
4.14.16 ShortIndication ...................................................................................................................... 88
4.15 Utbytbarhet ................................................................................................................... 89
4.15.1 getSubstanceGroups .............................................................................................................. 90
4.15.2 getSubstanceGroupBySubstanceGroupId .............................................................................. 90
4.15.3 getPharmaceuticalFormGroups .............................................................................................. 90
4.15.4 getPharmaceuticalFormGroupByPharmaceuticalFormGroupId ............................................. 91
4.15.5 getStrengthGroups ................................................................................................................. 91
4.15.6 getStrengthGroupByStrengthGroupId .................................................................................... 91
4.15.7 SubstanceGroup ..................................................................................................................... 92
4.15.8 PharmaceuticalFormGroup ..................................................................................................... 92
4.15.9 StrengthGroup ........................................................................................................................ 92
4.16 Ingredienser och substanser ........................................................................................ 93
4.16.1 getSubstancesByNplSubstanceIdList ..................................................................................... 94
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 6/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.16.2 getSubstancesBySubstanceName ......................................................................................... 94
4.16.3 getDistributedDrugContentsByNplIdList ................................................................................. 95
4.16.4 getDistributedDrugContentsByNplIdListFiltered ..................................................................... 95
4.16.5 Substance ............................................................................................................................... 96
4.16.6 DistributedDrugContent .......................................................................................................... 96
4.16.7 Ingredient ................................................................................................................................ 96
4.17 Kortnotationer ............................................................................................................... 97
4.17.1 getShortEncDosageTranslation .............................................................................................. 97
4.18 Utsättningsorsaker ........................................................................................................ 98
4.18.1 getTreatmentWithdrawalReasons .......................................................................................... 98
4.18.2 TreatmentWithdrawalReason ................................................................................................. 98
4.19 Läkemedelsföretag ....................................................................................................... 99
4.19.1 getDistributedDrugOrganizationsByNplIdList ......................................................................... 99
4.19.2 getDrugArticleOrganizationsByNplPackIdList ......................................................................... 99
4.19.3 DistributedDrugOrganizations ............................................................................................... 100
4.19.4 DrugArticleOrganizations ...................................................................................................... 100
4.19.5 RoleOrganization .................................................................................................................. 100
4.19.6 Organization ......................................................................................................................... 100
4.20 Handelsvaror (icke-läkemedel) ................................................................................... 101
4.20.1 getNonDrugArticlesByArticleName ....................................................................................... 101
4.20.2 getNonDrugArticlesByProductGroupCode ........................................................................... 101
4.20.3 getNonDrugArticlesByArticleNoList ...................................................................................... 102
4.20.4 NonDrugArticle ..................................................................................................................... 102
4.21 Söktjänster för läkemedelsidentifierare ....................................................................... 103
4.21.1 getNplPackIdsByArticleNoList .............................................................................................. 103
4.21.2 getNplIdsBySemanoList ....................................................................................................... 103
4.21.3 getDrugIdsBySemanoList ..................................................................................................... 105
4.21.4 getSemanosByNplIdList ....................................................................................................... 105
4.21.5 getSemanosByDrugIdList ..................................................................................................... 106
4.21.6 IdPair .................................................................................................................................... 106
4.22 Tjänster för samlad läkemedelsinformation (supertjänster) ........................................ 107
4.22.1 getSuperDrugsByDistributedDrugTradeName ..................................................................... 107
4.22.2 getSuperDrugsByDrugIdList ................................................................................................. 108
4.22.3 getSuperDrugsByNplIdList ................................................................................................... 108
4.22.4 getSuperDrugsByAtcCodeList .............................................................................................. 109
4.22.5 getSuperDrugsByAtcTextSv ................................................................................................. 109
4.22.6 getUnauthorisedSuperDrugsByDistributedDrugTradeName ................................................ 110
4.22.7 getUnauthorisedSuperDrugsByAtcCodeList ......................................................................... 110
4.22.8 getUnauthorisedSuperDrugsByAtcTextSv ............................................................................ 111
4.22.9 getSuperDrugArticlesByNplPackIdList .................................................................................. 111
4.22.10 SuperDrug ........................................................................................................................... 112
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 7/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.22.11 SuperDrugArticle ................................................................................................................. 112
4.23 Referensdatatjänster ................................................................................................... 113
4.23.1 getDrugClassifications .......................................................................................................... 113
4.23.2 getDrugClassificationByCode ............................................................................................... 113
4.23.3 getControlClasses ................................................................................................................. 113
4.23.4 getControlClassByCode ........................................................................................................ 114
4.23.5 getRouteOfAdministrations ................................................................................................... 114
4.23.6 getRouteOfAdministrationByCode ........................................................................................ 114
4.23.7 getPrescribers ....................................................................................................................... 114
4.23.8 getPrescriberByCode ............................................................................................................ 115
4.23.9 getProductTypes ................................................................................................................... 115
4.23.10 getProductTypeByCode ...................................................................................................... 115
4.23.11 getPrescriptions .................................................................................................................. 115
4.23.12 getPrescriptionByCode ....................................................................................................... 116
4.23.13 getStrengthNumericUnits .................................................................................................... 116
4.23.14 getStrengthNumericUnitByCode ......................................................................................... 116
4.23.15 getOrganizationRoles ......................................................................................................... 116
4.23.16 getOrganizationRoleByCode .............................................................................................. 117
4.23.17 getCountries ........................................................................................................................ 117
4.23.18 getCountryByCode .............................................................................................................. 117
4.23.19 getDosdispLifeUnits ............................................................................................................ 117
4.23.20 getDosdispLifeUnitByCode ................................................................................................. 118
4.23.21 getPackageTypeInners ....................................................................................................... 118
4.23.22 getPackageTypeInnerByCode ............................................................................................ 118
4.23.23 getPackConditions .............................................................................................................. 118
4.23.24 getPackConditionByCode ................................................................................................... 119
4.23.25 getStorageTemps ................................................................................................................ 119
4.23.26 getStorageTempByCode ..................................................................................................... 119
4.23.27 getSalesRestrictions ........................................................................................................... 119
4.23.28 getSalesRestrictionByCode ................................................................................................ 120
4.23.29 getPackSizeNumericUnits .................................................................................................. 120
4.23.30 getPackSizeNumericUnitByCode ....................................................................................... 120
4.23.31 getShelfLifeUnits ................................................................................................................. 120
4.23.32 getShelfLifeUnitByCode ...................................................................................................... 121
4.23.33 getStorageConditions ......................................................................................................... 121
4.23.34 getStorageConditionByCode .............................................................................................. 121
4.23.35 getIngredientRoles .............................................................................................................. 121
4.23.36 getIngredientRoleByCode ................................................................................................... 122
4.23.37 getQuantityUnits ................................................................................................................. 122
4.23.38 getQuantityUnitByCode ...................................................................................................... 122
4.23.39 getAlternativeQuantityUnits ................................................................................................ 122
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 8/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.40 getAlternativeQuantityUnitByCode ..................................................................................... 123
4.23.41 getCompRefQuantities ....................................................................................................... 123
4.23.42 getCompRefQuantityByCode ............................................................................................. 123
4.23.43 getSILProductTypeGroups ................................................................................................. 123
4.23.44 DrugClassification ............................................................................................................... 124
4.23.45 ControlClass ....................................................................................................................... 124
4.23.46 RouteOfAdministration ........................................................................................................ 124
4.23.47 Prescriber ........................................................................................................................... 124
4.23.48 ProductType ........................................................................................................................ 124
4.23.49 Prescription ......................................................................................................................... 124
4.23.50 StrengthNumericUnit .......................................................................................................... 124
4.23.51 OrganizationRole ................................................................................................................ 124
4.23.52 Country ............................................................................................................................... 124
4.23.53 DosdispLifeUnit ................................................................................................................... 124
4.23.54 PackageTypeInner .............................................................................................................. 124
4.23.55 PackCondition ..................................................................................................................... 125
4.23.56 StorageTemp ...................................................................................................................... 125
4.23.57 SalesRestriction .................................................................................................................. 125
4.23.58 PackSizeNumericUnit ......................................................................................................... 125
4.23.59 ShelfLifeUnit ....................................................................................................................... 125
4.23.60 StorageCondition ................................................................................................................ 125
4.23.61 IngredientRole .................................................................................................................... 125
4.23.62 QuantityUnit ........................................................................................................................ 125
4.23.63 AlternativeQuantityUnit ....................................................................................................... 125
4.23.64 CompRefQuantity ............................................................................................................... 125
4.24 Versionsinformation .................................................................................................... 126
4.24.1 getDataVersions ................................................................................................................... 126
4.24.2 getApiVersion ........................................................................................................................ 126
4.24.3 DataVersion .......................................................................................................................... 126
4.24.4 ApiVersion ............................................................................................................................. 126
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 9/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
1. Inledning
Detta dokument beskriver SIL SOAP API 4.0. SIL SOAP API är ett skrivskyddat API för
åtkomst till information om alla läkemedelsprodukter och förpackningar i Sverige samt om
handelsvaror (icke-läkemedel) inom förmånen, d.v.s. som omfattas av TLV:s subventioner enligt
deras nämnd för läkemedelsförmåner. Dokumentet vänder sig till systemutvecklare som vill
integrera SIL i journalsystem eller andra expert- och stödsystem i vården.
För en mer komplett och verksamhetsorienterad beskrivning av nytta och möjligheter med
tjänster och informationen i SIL hänvisas läsaren till de olika verksamhetshandledningar som
SIL tillhandahåller.
Den senaste versionen av detta dokument finns att hämta på SIL:s hemsida 1.
1.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 SIL
Installationsmanual. Se SIL:s hemsida för senaste version av det dokumentet.
1.2
Allmänt
SIL SOAP API innehåller 146 read-only tjänster som ger åtkomst till information om läkemedel
i Sverige. SIL SOAP API använder internt en databas som kallas för SIL-databasen. SIL SOAP
API tillsammans med SIL-databasen kallas för SIL-servern. En ny version av SIL SOAP API
releasas varje år. SIL förvaltningen på Inera producerar och publicerar en ny SIL databas varje
vecka (på onsdagar) på SIL:s SFTP-server. FASS-texter och annan FASS-information
uppdateras alla vardagar utom röda dagar, i den publicerade databasen på SFTP-servern.
1.3
Integration
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.
1
Se: http://www.inera.se/TJANSTER--PROJEKT/SIL/
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 10/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
1.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Drift av SIL-server och uppdatering av SIL-databas
Ansvaret för att ett journal- eller vårdsystem har tillgång till, och anropar, en SIL-server med
rätt version av 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-drift
organisationer som ansvarar för detta.
Inera tillhandahåller alltså inga SIL-servrar i drift utöver ett par testservrar som kan användas
för att lära sig om SIL SOAP API eller för prototyputveckling. I framtiden kan Inera komma att
tillhandahålla nationella SIL-servrar i skarp drift.
Aktuella och uppdaterade SIL-databaser kan laddas ner från SIL:s SFTP-server och uppdatering
sker genom att göra ett kortare driftstopp (på ca 1 minut) på SIL-servern och då skriva över SILdatabasen med en ny version av hela SIL-databasen.
För att 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.5
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 kvalitetssäkringssystem varje vecka. Efter att informationen validerats och
granskats skapas sedan en ny SIL-databas som publiceras på SIL:s SFTP-sajt.
Källorna som används i SIL 4.0 är VARA (eHälsomyndigheten), NSL (Läkemedelsverket)
SFINX (SLL/JanusInfo), FASS (LIF) Amning & graviditetsvarningar (LIF/FASS), Amning &
Fosterskador (SLL/JanusInfo), Doseringsregistret (SIL), Utsättningsorsaksregistret (SIL).
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 från eHälsomyndigheten, Läkemedelsverket, TLV samt läkemedelsföretagen. SIL har
endast redaktionellt ansvar för Doseringsregistret och Utsättningsorsaksregistret.
Vidare finns i SIL 4.0 också information om biverkningar som extraherats från Läkemedelsverkets produktresuméer. Denna informationsextraktion är ännu inte helt kvalitetssäkrad. 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 beslutsstödsfunktionalitet för biverkningsinformation
kan utformas på ett bra sätt.
1.6
Teknisk lösning
SIL SOAP API är implementerat i Java med Metro (JAX-WS RI) och Tomcat och använder
Microsoft SQL server som databasystem. JAX-WS RI ersätter Axis/Java som användes i förra
versionen av SIL (3.1).
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 11/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
1.7
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Utvecklingsmiljö för integrerande system
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 utvecklings-miljö
och det programmeringsspråk som man utvecklar med eller programmera manuellt mot den.
wsdl-filen för SIL SOAP API 4.0 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).
1.8
Testmiljö
För att kunna testa sin integration mot SIL API måste man ha åtkomst till en installation av SILservern med SIL SOAP API och en SIL-databas. För initial prototyputveckling och test kan man
använda en testserver med SIL SOAP API 4.0 som är åtkomlig på Internet:
http://sil40.test.silinfo.se
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 SILservern med en SIL-databas.
För åtkomst till SIL:s testserver måste man skicka in en ansökan till Inera om åtkomst till den
där man deklarerar ansvarig kontaktperson, syfte med åtkomst samt från vilken eller vilka IPadresser man vill anropa testservern. Se SIL:s hemsida för mer information och för en
ansökningsblankett.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 12/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
1.9
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Definitioner
1.9.1
Vård- och läkemedelsinformatiktermer
Term
Förklaring
Amningsgrupp
(LIF/FASS)
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:
http://www.fass.se/LIF/produktfakta/fakta_lakare_artikel.jsp?articleID=18338
Amningsriskklass
(SLL/JanusInfo)
SLL/JanusInfo klassificering av ett läkemedels dokumenterade effekt på barn
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:
http://www.janusinfo.se/Beslutsstod/Lakemedel-amning/
Anti-rekommendation En lista med rekommenderade läkemedelsartiklar kan innehålla antirekommendationer i betydelsen att de uttrycker en rekommendation att inte förskriva läkemedelsartikeln (under vissa villkor). Anti-rekommendationer kombineras
vanligtvis med en hänvisningsrekommendation till en alternativ nivå 7 ATCkod. Anti-rekommendationer kallas också noll-rekommendationer.
ATC-kod
Klassifikationssystem för läkemedel som baseras på deras anatomiska,
terapeutiska och kemiska egenskaper. SIL innehåller endast de ATC-koder för
vilka det finns minst en registrerad läkemedelsprodukt hos Läkemedels-verket.
Biverkning
Oönskad effekt av ett läkemedel.
Läkemedelsprodukt
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.
Eumano
Det europeiska godkännandenumret för en läkemedelsprodukt vilket fastställs
av EMA.
Fass-text
Beskrivning av läkemedelsprodukter som ges ut av LIF. FASS-texten baseras på
den läkemedelsproduktens produktresumé (SPC) som är registrerad hos
Läkemedels-verket.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 13/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Term
Förklaring
Graviditetskategori
(LIF/FASS)
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:
http://www.fass.se/LIF/produktfakta/fakta_lakare_artikel.jsp?articleID=18338
Graviditetsriskklass
(SLL/JanusInfo)
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:
http://www.janusinfo.se/Beslutsstod/Lakemedel-och-fosterpaverkan/
Handelsnamn
Ett läkemedels försäljningsnamn (produktnamn). Handelsnamn kan både vara
registrerade varumärkesnamn (®) eller ej registrerade varumärkesnamn (™).
Handelsvara
Icke-läkemedel
I SIL avser termen handelsvara en förskrivningsbar artikel inom förmånen som
kan expedieras av apotek men som inte innehåller läkemedel. I SIL är termerna
”handelsvara” och ”icke-läkemedel” synonymer. Exempel: Zetuvit E", 25 styck,
sterilt absorbationsförband. I SIL SOAP API representeras de av dataobjektet
NonDrugArticle.
Kontrollkod
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äkemedelsartikel t.ex. ett
narkotikaklassat läkemedel ska kunna expedieras på apoteken.
Parallellimporterat
läkemedel
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.
Läkemedelsform
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.
Läkemedelsartikel
Läkemedelsvara
I SIL är termerna ”läkemedelsartikel” och "läkemedelsvara" synonymer och
avser en hos Läkemedelsverket registrerad läkemedelsartikel med unikt NPLpackid. Den hör till ett och endast ett distribuerat läkemedel. I SIL SOAP API
representeras det av dataobjektet DrugArticle.
Läkemedelsförpackning
Avser en förpackning av ett läkemedel. Vissa läkemedelsartiklar kan innehålla
flera läkemedelsförpackningar.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Senast ändrad
2015-04-14
Sid 14/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Term
Förklaring
semano
En läkemedelsprodukts svenska godkännandenummer. Fastställs av
Läkemedelsverket.
1.9.2
Tekniktermer
Term
Förklaring
API
“Application Programming Interface”. Programmeringsgränssnitt mot ett
program- eller operativsystem.
SOAP
En W3C standard för RPC-baserat API-protokoll. Tidigare stod SOAP för “Simple
Object Access Protocol”. Se:
http://www.w3.org/TR/2007/REC-soap12-part1-20070427/
Read-only tjänst
Teknisk tjänst eller funktion som enbart erbjuder möjlighet att hämta eller läsa
information men inte att ändra information.
Inera AB
Senast ändrad
2015-04-14
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 15/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
1.9.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
SIL SOAP API termer
Term / Symbol
drugId
Förklaring
string
Ett id för de dataobjekt i SIL SOAP API som har information om parallell-importerade
läkemedel (Drug). Baseras på NPL-id för originalläkemedels-produkten.
Anger en textsträng.
boolean
Anger ett sant eller falskt värde (true eller false).
int
Anger ett heltal.
float
Anger ett decimaltal.
[]
Anger en lista med datavärden eller data-objekt.
Y
Strängvärde som anger ”Yes” (ja).
N
Strängvärde som anger ”No” (nej).
1.10 Stilkonventioner
Följande fonter har använts i dokumentet.
Times New Roman (11pt) för löpande text.
Arial (olika fontstorlekar) för rubriker och text i sidhuvud och sidfot.
Arial (9pt fetstil) för
namn på tjänster, objekt, attribut och grundtyper.
Arial (10pt och blå färg) för källkodsexempel.
Dokument har skrivits i LibreOffice 3.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 16/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
2. Viktiga förändringar i SIL SOAP API 4.0
SIL SOAP API 4.0 är inte tekniskt bakåtkompatibelt med SIL SOAP API 3.1. Förändringarna i
SIL SOAP API 4.0 rör dels den tekniska implementationen men också att vissa tjänster och
objekt har tagits bort och att vissa objekt har fått attribut borttagna eller fått ändrade attributnamn. Ett par nya tjänster och objekt för att tillhandahålla information om läkemedelsföretag
har också lagts till.
Dessa förändringar innebär att system som integrerat med SIL SOAP API 3.1 och som är
utvecklade med kompilerade språk (som C# och Java) och tillhörande utvecklingsmiljöer måste
generera om SOAP klientstubbar och anpassa sin källkod. För system som är utvecklade med
interpreterade språk (som Python och Ruby) som erbjuder möjlighet till dynamisk tolkning av
wsdl-filer så måste de, även om de inte använder tjänster som berörs av förändringarna,
åtminstone verifiera att deras system klarar alla deras system- och integrationstester.
Förändringen av teknisk implementation i SIL-API 4.0 är att metoden för WSDL SOAP-binding
har ändrats från ”RPC/encoded” till ”Document/literal wrapped” 2. Det har gjorts för att få bättre
interoperabilitet med moderna SOAP ramverk som används av integrerande system.
Övriga förändringar är att tjänster och objekt som tidigare markerats som utgångna har tagits
bort samt att vissa tjänster och objekt fått ändrade namn. Tio (10) objekt har fått förändrade
attribut. Fyra (4) nya tjänster och fyra (4) nya objekt har tillkommit. Sexton (16) tjänster och
åtta (8) objekt har tagits bort.
2.1
Ändrade objekt
Här listas de ändrade objekten. Läsaren hänvisas till relevant kapitel i dokumentet för mer
ingående information om varje objekt.
•
DistributedDrug-objekt.
Följande ändringar har gjorts i attributen:
1) availableDate har ersatts av marketedFromDate.
2) availableFlag har ersatts av marketedFlag.
3) procStatusIndCode har tagits bort.
4) silDeviationCode har tagits bort.
5) hasAntiRecommendedArticle har tillkommit.
6) silLactationCode har tillkommit.
7) silPregnancyCode har tillkommit.
•
Drug-objekt.
Följande ändringar har gjorts i attributen:
1) lactationGroup har tagits bort.
2
För mer information om WSDL SOAP bindings se: http://www.ibm.com/developerworks/library/wswhichwsdl/
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 17/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
2) pregnancyCategory har tagits bort.
3) silDeviationCode har tagits bort.
4) hasAntiRecommendedArticle har tillkommit.
•
DrugArticle-objekt.
Följande ändringar har gjorts i attributen:
1) barcodeSingleDose har tagits bort.
2) packSizeAlphanumeric har tagits bort.
3) productNoteApo har tagits bort.
4) productPropertyApo har tagits bort.
5) availableDate har ersatts av marketedFromDate.
6) availableFlag har ersatts av marketedFlag.
7) eanCode har ersatts av barcode.
8) lfnPriceAupPrescription har ersatts av aup.
9) silDeviationCode har tagits bort.
10) isReimbursed har tillkommit.
•
DistributedDrugContent-objekt.
Följande ändringar har gjorts.
1) compTotWeightVol har tagits bort.
2) compTotWeightVolUnitCode har tagits bort.
•
DrugForm-objekt.
Följande ändringar har gjorts.
1) drugFormGroupNameSv har tagits bort.
•
Ingredient-objekt.
Följande ändringar har gjorts.
1) quantityMax har tagits bort.
•
ExchangePeriod-objekt.
Följande ändringar har gjorts.
1) rank har tillkommit.
2) aipPerUnit har tillkommit.
3) aupPerUnit har tillkommit.
•
JanusInfoLactationDoc-objekt.
Följande ändringar har gjorts.
1) atcCodeGroup har tagits bort.
2) authors har tagits bort.
•
JanusInfoPregnancyDoc-objekt.
Följande ändringar har gjorts.
1) authors har tagits bort.
•
NoneDrugArticle-objekt
har fått ändrat namn till NonDrugArticle och följande ändringar
har gjorts:
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 18/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
1) isDiscounted har ersatts av isReimbursed.
2) articleGroupCode har ersatts av productGroupCode.
3) sellingPrice har tagits bort.
4) aup har tillkommit.
5) productDescription har tillkommit.
2.2
Nya tjänster och objekt
Följande fyra (4) tjänster har tillkommit.
•
getDistributedDrugOrganizationsByNplIdList
•
getDrugArticleOrganizationsByNplPackIdList
•
getNonDrugArticlesByProductGroupCode
•
getUnauthorisedDistributedDrugByNplSubstanceId
Följande fyra (4) objekt har tillkommit.
•
DistributedDrugOrganizations-objekt
•
DrugArticleOrganizations-objekt
•
Organization-objekt
•
RoleOrganization-objekt
2.3
Borttagna tjänster och objekt
Följande sexton (16) tjänster har tagits bort.
•
getDrugIdsHasAntiRecommendedArticleByDrugIdListRegionId
•
getNplIdsHasAntiRecommendedArticleByNplIdListRegionId
•
getLactationGroupInfos
•
getLactationGroupInfosByGroup
•
getNoneDrugArticlesByArticleGroupCode
•
getPregnancyCategoryInfos
•
getPregnancyCategoryInfosByCategory
•
getProcStatusByCode
•
getProcStatuses
•
getRecommendListsByRegionId
•
getRecommendsByNplPackIdListRegionIdListTypes
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 19/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
•
getRecommendsByTherapyGroupIndicationNameRegionIdListTypes
•
getCompTotWeightVolUnitByCode
•
getCompTotWeightVolUnits
•
getSilDeviationByCode
•
getSilDeviations
Senast ändrad
2015-04-14
Följande 8 (åtta) objekt har tagits bort.
•
Indic-objekt
•
ProcStatus-objekt
•
SilDeviation-objekt
•
Recommend-objekt
•
RecommendList-objekt
•
LactationGroupInfo-objekt
•
PregnancyCategoryInfo-objekt
•
CompTotWeightVolUnit-objekt
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 20/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
3. Objektmodell för läkemedelsinformation
SIL SOAP API tillhandahåller tjänster för att komma åt information om förskrivningsbara
läkemedel och handelsvaror (icke-läkemedelsvaror) inom förmånen. Denna information är
tillhandahålls via ett antal tjänster och informationsobjekt som var och en representerar olika
förskrivnings- och läkemedelsrelaterade begrepp.
För läkemedelsinformation finns tre viktiga objekt; Drug (parallellimporterade läkemedel),
DistributedDrug (läkemedelsprodukt) och DrugArticle (läkemedelsartikel).
Ett DistributedDrug-objekt representerar en hos Läkemedelsverket registrerad läkemedelsprodukt med unikt NPL-id. Ett DistributedDrug-objekt identifieras med NPL-id och har en unik
kombination av handelsnamn, läkemedelsform, styrka och ansvarigt företag.
Ett Drug-objekt representerar en grupp parallellimporterade läkemedel. Drug-objekt innehåller
den gemensamma information som ska gälla för alla läkemedelsprodukter som är parallellimporter till någon läkemedelsprodukt. Det finns således alltid ett Drug-objekt även för sådana
läkemedelsprodukter som saknar faktiska parallellimporter.
Nedan ges en översiktlig bild av relationen mellan de grundläggande läkemedelsobjekten Drug,
DistributedDrug och DrugArticle samt dess tillhörande, huvudsakliga identifierare.
Alla läkemedelsprodukter som ingår i en grupp parallellimporter har vanligtvis samma unika
kombination av handelsnamn, läkemedelsform och styrka men olika ansvariga företag. Ibland
kan dock handelsnamnet skilja sig inom en grupp av parallellimporterade läkemedelsprodukter.
I detta fall har Drug-objektet ett handelsnamn som består av handelsnamnet på originalläkemedelsprodukten följt av tecknet '*'. Drug-objekt innehåller vidare gemensam läkemedelsinformation som gäller för alla läkemedelsprodukterna inom en grupp av parallellimporter.
Ett DrugArticle-objekt representerar en hos Läkemedelsverket registrerad läkemedelsartikel med
unikt NPL-packid. Den hör till ett och endast ett distribuerat läkemedel. En läkemedelsartikel
innehåller oftast en förpackning men den kan innehålla fler förpackningar med olika innehåll,
Ett exempel är infusionsvätskor som måste blandas innan de administreras.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 21/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
3.1
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
SIL:s produkttypsgrupper
I SIL finns en gruppering av läkemedelsprodukttyper. Denna gruppering styr vilken information
som returneras av en del tjänster i SIL-API. Produkttypsgrupperna är idag:
•
APPROVED. Avser
godkända läkemedelsprodukter. Omfattar produkttyperna MEP, ALL,
VBL, RAP, NLM, VUM och NIN.
•
NON_APPROVED. Avser
ej godkända läkemedelsprodukter. Omfattar produkttyperna
APL och LIC.
•
3.2
TRADITIONAL. Avser
traditionella läkemedelsprodukter. Omfattar produkttypen TVB.
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å bl.a.
handelsnamn, NPL-id, NPL-packid, ATC text eller kod, NPL substansgruppsnamn, NPL
substansnamn samt NPL-substansid.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 22/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
3.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Exempel
I följande exempel presenteras hur man kan söka efter Drug-objekt (parallellimporter) och
DistributedDrug- objekt (läkemedelsprodukter) och hur informationen som returneras ser ut
beroende på om det finns parallellimporter eller inte. Syftet med exemplen är att dels visa på hur
man kan söka efter information och dels visa hur Drug-objekt förhåller sig till DistributedDrugobjekt för ett par olika fall.
I exemplen nedan används programmeringsspråket Python och exemplen har gjorts som
interaktiva sessioner med Pythons standardinterpretator 3. För att snabbt komma igång med SIL
SOAP-API kan man använda SIL:s testserver4 och Python-modulen suds5. Med Python och suds
kan man interaktivt ansluta sig till SIL:s testserver med SIL SOAP API så här:
>>> import suds
>>> url = "http://sil40.test.silinfo.se/silapi40/SilDB?wsdl"
>>> sil = suds.client.Client (url)
För att se tillgängliga tjänster och datatyper i SIL SOAP-API skriv:
>>> print sil
För att anropa en specifik tjänst som t.ex. getDistributedDrugsByDistributedDrugTradeName kan
man skriva:
>>> ddrugs = sil.service.getDistributedDrugsByDistributedDrugTradeName ("Aspirin", True, -1)
Resultatet av anropet är nu tillgängligt i variabeln ddrugs. För att presentera resultat av anrop i
exemplen nedan används Pythons standardfunktion print.
3.3.1
En läkemedelsprodukt utan parallellimporter: ”Aspirin”
I detta exempel söker vi efter information om "Aspirin". Det finns endast en läkemedelsprodukt
med handelsnamnet "Aspirin" och det finns inga parallellimporter för den läkemedelsprodukten.
Således ska det finnas ett DistributedDrug-objekt och ett Drug-Objekt med information om
"Aspirin".
Sökning efter läkemedelsprodukten "Aspirin" kan göras med följande tjänst för DistributedDrugobjekt:
>>> ddrugs = sil.service.getDistributedDrugsByDistributedDrugTradeName ("Aspirin", True, -1)
Den andra parametern med värdet True anger att vi enbart vill ha tillgängliga läkemedelsprodukter och den tredje parametern med värdet -1 anger att vi att vi inte vill begränsa vår
3
4
5
Exemplen har körts med Python 2.7.
Se http://www.inera.se/TJANSTER--PROJEKT/SIL/Inforandestod-SIL/Anslutning-/ för information
om hur man kommer åt SIL testservrar.
Se https://fedorahosted.org/suds/ för information om suds.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 23/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
sökning till någon specifik rekommenderad läkemedelslista. Antalet returnerade
DistributedDrug-objekt fås genom att skriva:
>>> len (ddrugs)
1
Således returnerades bara en läkemedelsprodukt med handelsnamnet "Aspirin", vilket ju var
förväntat.
Vi kan se på information om denna enda läkemedelsprodukt genom att skriva:
>>> print ddrugs[0]
(DistributedDrug){
approvalDate = "1935-01-31"
containsLactosFlag = "N"
containsLatexFlag = "N"
dosdispFlag = "N"
dosdispLife = 0
dosdispLifeUnit = "Månader"
drugFormCode = "TABLET"
drugFormTextSv = "Tablett"
drugId = "19350131000010"
exportedFromCountryCode = "-"
hasAntiRecommendedArticle = False
hasRecommendedArticle = True
interchangeableFlag = "N"
localRepresentative = None
marketedFlag = "Y"
marketedFromDate = None
marketingAuthHolder = "Bayer AB"
nplId = "19350131000010"
parallelImportDeviation = None
parimpOriginalId = "19350131000010"
productNoteInd = None
salesstoppedFlag = "N"
silLactationCode = "M"
silPregnancyCode = "M"
strengthNumeric = 500.0
strengthNumericUnit = "mg"
strengthText = "500 mg"
tradeName = "Aspirin®"
withdrawalDate = None
}
Även om inte just denna läkemedelsprodukt har några parallellimporter finns det alltså ett Drugobjekt 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:
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 24/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
>>> drug = sil.service.getDrugByDrugId ("19350131000010", True, -1)
>>> print drug
(Drug){
controlClassCode = "0"
drugClassificationCode = "1"
drugFormCode = "TABLET"
drugFormTextSv = "Tablett"
drugId = "19350131000010"
hasAntiRecommendedArticle = False
hasRecommendedArticle = True
interactionStatus = 1
interchangeableFlag = "N"
pharmaceuticalFormGroupId = 0
pharmaceuticalFormGroupName = "Ospecificerad"
prescriberCodes[] =
"1",
"2",
"3",
"4",
"6",
prescriptionCode = "0"
productTypeCode = "MEP"
routeOfAdministrationCodes[] =
"-",
strengthGroupId = 0
strengthGroupName = "Ospecificerad"
strengthNumeric = 500.0
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 ("19350131000010", 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äkemedlet som inte
finns tillgängligt i DistributedDrug-objekt.
3.3.2
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
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 25/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
innehåller handelsnamnet "Stilnoct". Således ska det finnas två Drug-Objekt med information
om "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
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, Filmdragerad tablett [drugId: 19940128000057]
Stilnoct* 10 mg, Filmdragerad tablett [drugId: 19940128000064]
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 parallellimporter med tjänsten:
>>> ddrugs = sil.service.getDistributedDrugsByDrugId ("19940128000064", 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
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 26/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
anger att vi bara vill se läkemedelsprodukter för vilka det finns minst en tillgänglig läkemedelsartikel.
Om vi istället vill se alla läkemedelsprodukter som ingår i denna grupp av parallellimporter,
oavsett om de har tillgängliga läkemedelsartiklar eller inte, ska vi anropa med värdet False:
>>> ddrugs = sil.service.getDistributedDrugsByDrugId ("19940128000064", 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] %s" % \
…
(ddrug['tradeName'], \
…
ddrug['strengthText'], \
…
ddrug['drugFormTextSv'], \
…
ddrug['nplId'], \
…
ddrug['marketedFlag'], \
…
ddrug['marketingAuthHolder'], \
…
ddrug['exportedFromCountryCode'])
...
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: 19940128000064, (Y), MAH: sanofi-aventis AB] Stilnoct 10 mg, Filmdragerad tablett, [nplId: 19990813000138, (N), MAH: Paranova Läkemedel AB] ESP
Stilnoct 10 mg, Filmdragerad tablett, [nplId: 19990827000124, (N), MAH: Paranova Läkemedel AB] PRT
Stilnoct 10 mg, Filmdragerad tablett, [nplId: 19990910000048, (N), MAH: Paranova Läkemedel AB] GRC
Stilnoct 10 mg, Filmdragerad tablett, [nplId: 19990910000178, (N), MAH: Orifarm AB] GRC
Stilnoct 10 mg, Filmdragerad tablett, [nplId: 19991104000257, (N), MAH: Orifarm AB] ESP
Stilnoct 10 mg, Filmdragerad tablett, [nplId: 20020614000030, (N), MAH: Paranova Läkemedel AB] ESP
Stilnoct 10 mg, Filmdragerad tablett, [nplId: 20020809000043, (N), MAH: Orifarm AB] PRT
Stilnox 10 mg, Filmdragerad tablett, [nplId: 20020614000054, (N), MAH: Medartuum AB] ESP
Stilnox 10 mg, Filmdragerad tablett, [nplId: 20020719000034, (N), MAH: Medartuum AB] GRC
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äkemedelsartikel. Vi ser också att det
finns två läkemedelsprodukter som har ett annat handelsnamn än originalläkemedels-produkten,
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 (NPLid: 19990813000138, 19990827000124 och 19990910000048). Det som skiljer dem är att de
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 27/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
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 DistributedDrug- objekt.
3.3.3
Sökning på substanser som börjar med tecknen ”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 = "37517-30-9"
children[] =
"IDE4POEWUAJJEVERT1",
nplSubstanceId = "IDE4POEYUAKZYVERT1"
substanceName = "acebutolol"
}, (Substance){
casNo = "34381-68-5"
nplSubstanceId = "IDE4POEWUAJJEVERT1"
parents[] =
"IDE4POEYUAKZYVERT1",
substanceName = "acebutololhydroklorid"
},
...
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 28/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4. Tjänster
Detta kapitel beskriver samtliga tjänster och objekt som ingår i SIL SOAP API. Tjänsterna och
den information de returnerar är baserat på 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.
4.1
Inledning
Tjänsterna och SOAP-objekten beskrivs med en pseudokodssyntax. Exakt hur tjänsterna och
SOAP-objekten ser och ska anropas i olika programmeringsspråk och miljöer beror på vilka
SOAP-ramverk och WSDL-verktyg som man använder. Utöver grundtyperna string, boolean,
integer och float, används en speciell syntax för att indikera listor av SOAP-objekt i form av
hakparenteser [ ].
I vissa tjänster där en en inparameter har datatypen string kan man använda ett wildcard-tecken
för att göra strängmatchning. Wildcard-tecknet är procenttecknet %. T.ex. kan strängen ”%alv%”
innebära att tjänsten, oberoende av versaler och gemener, söker efter alla strängar som innehåller texten ”alv”). Alla tjänster som har strängar som inparametrar stödjer dock inte wildcardtecken. Det framgår i beskrivningen för varje tjänst om den stödjer wildcard-tecken i
inparametersträngar.
4.2
Organisation och layout av beskrivningarna
Tjänsterna i SIL SOAP API har grupperats i ett antal olika områden baserat på den information
de erbjuder. Tjänsterna i de olika områden beskrivs i separata underkapitel. Alla tjänsterna är
dock åtkomliga via samma SOAP service end-point och URL.
Varje tjänst och varje typ av SOAP-objekt som kan returneras av tjänsterna beskrivs i ett eget
avsnitt i respektive underkapitel.
I varje avsnitt som beskriver en tjänst finns ett inledande beskrivning av tjänsten följd av en
tabell som beskriver inparametrar, returtyp samt exempel på användning. Här är ett exempel.
Inparametrar
inpar1: string
inpar2: boolean
Beskrivning av inpar1.
Beskrivning av inpar2.
Returtyp
Dataobj1 [ ]
Lista med Dataobj1-objekt.
Exempel
Anropet:
getDataobj1 ("exempel", false)
returnerar information om alla Dataobj1 som innehåller strängen ”exempel”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 29/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
I varje avsnitt som beskriver ett SOAP-objekt finns ett inledande beskrivning av objektet följd
av en tabell som beskriver attributen i SOAP-objektet. Här är ett exempel.
Attribut
text: string
Beskrivning av text.
Beskrivning av id.
id: int
4.3
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
800
900
Invalid parameter
Service returns too many elements
Server received an internal error
När felsituationer uppstår skickar webbservern felmeddelande 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.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 30/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
ATC-koder
Tjänsterna används för att hämta ATC-kodsinformation. ATC-klassificeringen är en hierarkisk
klassificering i fem nivåer av läkemedels och substansers anatomiska, terapeutiska och kemiska
egenskaper. Nivåerna är numrerade från 1 till 5 där 1 är den högsta nivån. Varje ATC-kod i
klassificeringen har en unik kod samt en beskrivande text. I SIL finns bara information om de
ATC-koder som används för registrerade läkemedelsprodukter i Sverige. Således innehåller inte
SIL nödvändigtvis alla ATC-koder i ATC-klassificeringen.
4.4.1
getAtcsByAtcCode
Returnerar en lista med de Atc-objekt som har en ATC-kod som matchar den angivna ATCkoden atcCode. Listan är sorterad i alfanumerisk ordning på ATC-kodernas värde.
Inparametrar
atcCode: string
En hel eller en del av en ATC-kod. Strängen får vara maximalt
åtta (8) tecken långt. Wildcard-tecken '%' är tillåtet i strängen.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsByAtcCode (”C07AA%”)
returnerar information om alla ATC-koder som börjar med ”C07AA”.
4.4.2
getAtcsByTextSv
Returnerar en lista med de Atc-objekt som har en beskrivande text som matchar den angivna
svenska texten textSv. Listan är sorterad i alfanumerisk ordning på ATC-kodernas värde.
Inparametrar
textSv: string
Textsträng på svenska. Wildcard-tecken '%' är tillåtet i strängen.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsByTextSv ("%receptorblockerare%")
returnerar information om alla ATC-koder som innehåller strängen ”receptorblockerare” i
sin beskrivande text.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 31/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.4.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getAtcsByDrugId
Returnerar en lista med de Atc-objekt som är registrerade för de parallellimporter som
identifieras med angivet drugId. Listan är sorterad i alfanumerisk ordning på ATC-kodernas
värde.
Inparametrar
drugId: string
drugId
för ett Drug-objekt.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsByDrugId ("19350131000010")
returnerar information om alla ATC-koder för Drug-objektet med drugId
"19350131000010".
4.4.4
getAtcNarrowersByAtcCode
Returnerar en lista med de Atc-objekt som är hierarkiskt underordnade den angivna ATC-koden
atcCode. Listan är sorterad i alfanumerisk ordning på ATC-kodernas värde.
Inparametrar
atcCode: string
En ATC-kod. Strängen får vara maximalt åtta (8) tecken långt.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsNarrowersByAtcCode ("C07AA")
returnerar information om alla ATC-koder som ligger under ATC-koden "C07AA".
4.4.5
getAtcWiderByAtcCode
Returnerar det Atc-objekt som är hierarkiskt överordnat den angivna ATC-koden atcCode.
Inparametrar
atcCode: string
En ATC-kod. Strängen får vara maximalt åtta (8) tecken långt.
Returtyp
Atc
Ett Atc-objekt.
Exempel
Anropet:
getAtcsWiderByAtcCode ("C07AA")
returnerar information om den ATC-kod som ligger över ATC-koden "C07AA".
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 32/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.4.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getAtcsByAtcCodeAndLevelInterval
Returnerar en lista med de Atc-objekt som matchar den angivna ATC-koden AtcCode och som är
på en hierarkiskt nivå i ATC-klassificeringen mellan nivåerna levelHigh och levelLow.
Inparametrar
atcCode: string
levelHigh: int
levelLow: int
En ATC-kod. Strängen får vara maximalt åtta (8) tecken långt.
Wildcard-tecken '%' är tillåtet i strängen.
En nivå i ATC-klassificeringen.
En nivå i ATC-klassificeringen.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsByAtcCodeAndLevelInterval ("C07AA", 2, 4)
returnerar information om alla ATC-koder som börjar med ”C07AA” och som är mellan
nivå 2 och 4.
4.4.7
getAtcsByTextSvAndLevelInterval
Returnerar en lista med de Atc-objekt som har en beskrivande text som matchar den angivna
svenska texten textSv och som är på en hierarkiskt nivå i ATC-klassificeringen mellan nivåerna
levelHigh och levelLow.
Inparametrar
textSv: string
levelHigh: int
levelLow: int
Textsträng på svenska. Wildcard-tecken '%' är tillåtet i strängen.
En nivå i ATC-klassificeringen.
En nivå i ATC-klassificeringen.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsByTextSvCodeAndLevelInterval ("%receptorblockerare%", 2, 4)
returnerar information om alla ATC-koder innehåller strängen ”receptorblockerare” i sin
beskrivande text och som är mellan nivå 2 och 4.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 33/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.4.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getAtcsByLevel
Returnerar en lista med de Atc-objekt som finns på den angivna nivån level i ATCklassificeringen.
Inparametrar
level: int
En nivå i ATC-klassifieringen.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsByLevel (1)
returnerar information om alla ATC-koder som är på nivå 1.
4.4.9
getAtcsByAtcCodeList
Returnerar en lista med de Atc-objekt för de angivna ATC-koderna atcCodes.
Inparametrar
atcCodes: string [ ]
Lista med ATC-koder.
Returtyp
Atc [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcsByAtcCodeList ([”A01”, ”A02” ])
returnerar information om de ATC-koderna ”A01” och ”A02”.
4.4.10
getDrugAtcCodesByDrugIdList
Returnerar en lista med de DrugAtcCode-objekt som har ATC-koder som är registrerade för
läkemedelsprodukter med angivna drugIds.
Inparametrar
drugIds: string [ ]
Lista med drugIds.
Returtyp
DrugAtcCode [ ]
Lista med DrugAtcCode-objekt.
Exempel
Anropet:
getDrugAtcCodesByDrugIdList ([”20040916001900”, ”2010070900005” ])
returnerar information om de ATC-koder som är registrerade för läkemedelsprodukterna
med drugId ”20040916001900” och ”2010070900005”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 34/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.4.11
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getAtcCodeDrugsByAtcCodeList
Returnerar en lista med de AtcCodeDrug-objekt som har de angivna ATC-koder atcCodes.
Inparametrar
atcCodes: string [ ]
flgCurrent: boolean
Lista med ATC-koder.
Anger att information om enbart läkemedelsprodukter som har
minst en läkemedelsartikel som är tillgänglig ( true) eller om alla
(false) läkemedelsprodukter ska returneras.
Returtyp
AtcCodeDrug [ ]
Lista med Atc-objekt.
Exempel
Anropet:
getAtcCodeDrugsByAtcCodeList ([”A01”, ”A02” ])
returnerar information om ATC-koderna ”A01” och ”A02” samt om de läkemedelsprodukter som är registrerade med de ATC-koderna.
4.4.12
Atc
Ett Atc-objekt representerar en ATC-kod och tillhörande information.
Attribut
atcCode: string
ATC-koden. Maximalt åtta (8) tecken långt.
Beskrivande svensk text.
Klassificeringsnivå i ATC-kodssystemet.
textSv: string
lev: int
4.4.13
DrugAtcCode
Ett DrugAtcCode-objekt innehåller information om de ATC-koder som är registrerade för en viss
läkemedelsprodukt, och således då även för alla parallellimporter av den produkten.
Attribut
drugId: string
atcCodes: string [ ]
4.4.14
för ett Drug-objekt.
Lista med ATC-koder som är registrerade för Drug-objektet.
drugId
AtcCodeDrug
Ett AtcCodeDrug-objekt innehåller information om en viss ATC-kod och alla de läkemedelsprodukter, och således då även för alla parallellimporter av de produkterna, för vilka den ATCkoden är registrerad.
Attribut
atcCode: string
drugIds: string [ ]
Inera AB
ATC-koden. Maximalt åtta (8) tecken långt.
Lista med drugId för de Drug-objekt för vilka den angivna ATCkoden är registrerad.
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 35/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.5
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Parallellimporterade läkemedel
Tjänsterna används för att hämta generell läkemedelsinformation som är gemensam för alla
parallellimporter för en läkemedelsprodukt. Denna information representeras av Drug-objekt.
Även för läkemedelsprodukter för vilka det inte finns några faktiska parallellimporterade
läkemedelsprodukter så finns sådan generell information och således ett Drug-objekt.
De flesta av tjänsterna nedan tar två inparametrar; flgCurrent och regionId. De har följande syfte.
flgCurrent: boolean
regionId: int
4.5.1
Anger att information om enbart parallellimporterna som har minst
en läkemedelsartikel som är tillgänglig (true), eller om alla (false),
parallellimporter ska returneras.
Anger att enbart de parallellimporter som har läkemedelsartiklar i
denna rekommenderade läkemedelslista ska returneras. Om regionId
= -1 så returneras alla parallellimporter oavsett vilka rekommenderade
läkemedelslistor deras läkemedelsartiklar ingår i.
getDrugsByAtcCode
Returnerar Drug-objekt för parallellimporterna som har silProductGroupType = APPROVED och
som har registrerats med angiven ATC-kod atcCode.
Inparametrar
atcCode: string
flgCurrent: boolean
regionId: int
En hel eller en del av en ATC-kod. Strängen får vara maximalt
åtta (8) tecken långt. Wildcard-tecken '%' är tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug [ ]
Lista med Drug-objekt som är sorterade på i första hand
tradeName och i andra hand drugFormCode i fallande ordning.
Exempel
Anropet:
getDrugsByAtcCode ("C08CA02", false, -1)
returnerar information om alla parallellimporter som är registrerade med ATC-koden
”C08CA02” oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken
rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 36/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.5.2
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugsByDistributedDrugTradeName
Returnerar Drug-objekt för parallellimporterna med angivet distribuerat handelsnamn
tradeName. Observera att returnerade Drug-objekt kan ha ett annat handelsnamn än
inparametern tradeName. Detta kan inträffa då läkemedelsprodukten är en parallellimport med
annat originalnamn.
Inparametrar
tradeName: string
flgCurrent: boolean
regionId: int
En hel eller en del av ett handelsnamn. Wildcard-tecken '%' är
tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug [ ]
Lista med Drug-objekt som är sorterade på i första hand
tradeName och i andra hand drugFormCode i fallande ordning.
Exempel
Anropet:
getDrugsByDistributedDrugTradeName ("Aspirin", False, -1)
returnerar information om alla parallellimporter som har handelsnamnet ”Aspirin” oavsett
om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista de ingår i.
4.5.3
getDrugByDrugId
Returnerar Drug-objektet för parallellimporterna med angivet drugId.
Inparametrar
drugId: string
flgCurrent: boolean
regionId: int
Ett SIL drug-id.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug
Ett Drug-objekt.
Exempel
Anropet:
getDrugByDrugId ("19350131000010", False, -1)
returnerar information om alla parallellimporter som har drugId ”19350131000010”
oavsett om det har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista den ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 37/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.5.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugsByDrugIdList
Returnerar en lista med de Drug-objekt som har de angivna drugIds.
Inparametrar
drugIds: string [ ]
flgCurrent: boolean
regionId: int
En lista av strängar med drugId:n.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug [ ]
Lista med Drug-objekt som är sorterade på i första hand
tradeName och i andra hand drugFormCode i fallande ordning.
Exempel
Anropet:
getDrugsByDrugIdList (["19350131000010"], False, -1)
returnerar information om alla parallellimporter som har de angivna drugId:na oavsett om
de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad läkemedelslista
de ingår i.
4.5.5
getDrugsBySubstanceGroupId
Returnerar en lista med de Drug-objekt som ingår i substansgruppen med det angivna
substansgruppsid:t substanceGroupId samt som har interchangeableFlag satt till Y eller P.
Substansgrupper används för att ange utbytbarhet. Se kapitel 5.15 Utbytbarhet för mer
information om substansgrupper.
Inparametrar
substanceGroupId: int
flgCurrent: boolean
regionId: int
Ett heltal som anger ett substansgruppid.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug [ ]
Lista med Drug-objekt som är sorterade på i första hand
tradeName och i andra hand drugFormCode i fallande ordning.
Exempel
Anropet:
getDrugsBySubstanceGroupId (168, False, -1)
returnerar information om alla parallellimporter som har substansgruppid 168 oavsett om
de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad läkemedelslista
de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 38/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.5.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugsByPharmaceuticalFormGroupId
Returnerar en lista med de Drug-objekt som ingår i den farmaceutiska formgruppen med det
angivna farmaceutiska formgruppsid:t formGroupId samt som har interchangeableFlag satt till Y
eller P. Farmaceutiska formgrupper används för att ange utbytbarhet. Se kapitel 5.15
Utbytbarhet för mer information om farmaceutiska formgrupper.
Inparametrar
formGroupId: int
flgCurrent: boolean
regionId: int
Ett heltal som anger ett farmaceutiskt formgruppsid.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug [ ]
Lista med Drug-objekt som är sorterade på i första hand
tradeName och i andra hand drugFormCode i fallande ordning.
Exempel
Anropet:
getDrugsByPharmaceuticalFormGroupId (200, False, -1)
returnerar information om alla parallellimporter som har farmaceutiskt formgruppsid 200
oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista de ingår i.
4.5.7
getDrugsByStrengthGroupId
Returnerar en lista med de Drug-objekt som ingår i den farmaceutiska formgruppen med det
angivna farmaceutiska formgruppsid:t formGroupId samt som har interchangeableFlag satt till Y
eller P. Farmaceutiska formgrupper används för att ange utbytbarhet. Se kapitel 5.15
Utbytbarhet för mer information om farmaceutiska formgrupper.
Inparametrar
strengthGroupId: int
flgCurrent: boolean
regionId: int
Ett heltal som anger ett styrkegruppsid.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug [ ]
Lista med Drug-objekt som är sorterade på i första hand
tradeName och i andra hand drugFormCode i fallande ordning.
Exempel
Anropet:
getDrugsByStrengthGroupId ("C07AA", False, -1)
returnerar information om alla parallellimporter som har farmaceutiskt styrkegruppsid
4682 oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 39/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.5.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugIdsByNplIdList
Returnerar en lista med IdPair-objekt där varje IdPair-objekt innehåller ett av de angivna NPL-id
och det drugId som är associerat med det angivna NPL-id:t.
Inparametrar
nplids: string []
flgCurrent: boolean
regionId: int
En lista av strängar med NPL-id.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
Drug [ ]
Lista med Drug-objekt.
Exempel
Anropet:
getDrugIdsByNplIdList (["19590602000075"])
returnerar information om vilka drugId som är associerade med NPL-id:t
”19590602000075”.
4.5.9
Drug
Ett Drug-objekt representerar den generella läkemedelsinformationen som är gemensam för alla
parallellimporter för en läkemedelsprodukt.
Attribut
drugId: string
tradeName: string
strengthNumeric: float
strengthNumericUnit: string
strengthText: string
drugFormCode: string
drugFormTextSv: string
drugClassificationCode: string
controlClassCode: string
routeOfAdministrationCodes:
string [ ]
prescriberCodes: string [ ]
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
SIL SOAP API id för att identifiera Drug-objekt.
Handelsnamn. En asterisk i slutet av strängen betyder
att det finns läkemedelsprodukter i denna grupp av
parallellimporter som har olika handelsnamn. Det
handelsnamn som används i Drug-objektet är
originalläkemedlets handelsnamn.
Numerisk styrka. Tillhandahålls av Läkemedelsverket.
För kombinationsläkemedel saknar detta attribut värde.
Styrkeenhet. Tillhandahålls av Läkemedelsverket. För
kombinationsläkemedel saknar detta attribut värde.
Styrka och enhet i klartext. Tillhandahålls av ansvarigt
företag. För kombinationsläkemedel saknar detta
attribut värde.
Kod för läkemedelsform.
Läkemedelsform på svenska.
Klassificering enligt receptkungörelsens klassifikation
av särskilda läkemedel.
Narkotikaklassificering.
Kod för administrationsväg. D.v.s. vilken väg och på
vilket sätt ett läkemedel är avsett att administreras. För
framtida bruk, används ej i nuläget.
Kod som anger vilka yrkeskategorier som har
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 40/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
förskrivningsrätt.
Anger om läkemedlen är utbytbara. Strängen är alltid ett
tecken långt och har följande möjliga värden; Y, N och
P. Om alla läkemedelsprodukter i denna grupp av
parallellimporter har interchangeableFlag satta till Y så
är även detta attribut satt till Y. Om alla är satta till N så
är även detta attribut satt till N. Om det finns
läkemedelsprodukter som har Y och andra N så sätts
detta attribut till P (några).
substanceGroupId: int
Id för substansgrupp (för utbytbarhet).
substanceGroupName: string
Namn på substansgrupps.(för utbytbarhet).
pharmaceuticalFormGroupId: int Id för farmaceutisk formgrupp (för utbytbarhet).
pharmaceuticalFormGroupName: Namn på farmaceutisk formgrupp (för utbytbarhet).
interchangeableFlag: string
string
strengthGroupId: int
strengthGroupName: string
interactionStatus: int
productTypeCode: string
prescriptionCode: string
withdrawalDate: string
hasRecommendedArticle:
boolean
hasAntiRecommendedArticle:
boolean
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Id för styrkegrupp (för utbytbarhet).
Namn på styrkegrupp (för utbytbarhet).
Interaktionsstatus för läkemedlen. Möjliga värden:
1 anger att läkemedlen finns i interaktionskällan och har
kända interaktioner.
0 anger läkemedlen ingår i interaktionsskällan och har
inga kända interaktioner
-1 anger att läkemedlen inte ingår ingår i interaktionskällan och interaktionsstatus är okänt
Kod för produkttyp.
Kod som anger vilka receptföreskrifter som gäller.
Datum då samtliga parallellimporter har avregistrerats.
Anger om det finns rekommenderade läkemedelsartiklar i den rekommendationslista som angavs vid
anropet till tjänsten som returnerade detta Drug-objekt.
Anger om det finns anti-rekommenderade
läkemedelsartiklar, med denna parallellimport, i den
rekommendationslista som angavs vid anropet till
tjänsten som returnerade detta Drug-objekt.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 41/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Läkemedelsprodukter
Tjänsterna används för att hämta information om läkemedelsprodukter.
De flesta av tjänsterna nedan tar två inparametrar; flgCurrent och regionId. De har följande syfte.
flgCurrent: boolean
regionId: int
4.6.1
Anger att information om enbart läkemedelsprodukter som har minst
en läkemedelsartikel som är tillgänglig (true), eller om alla (false),
läkemedelsprodukter ska returneras.
Anger att enbart de läkemedelsprodukter som har läkemedelsartiklar i
denna rekommenderade läkemedelslista ska returneras. Om regionId
= -1 så returneras alla läkemedelsprodukter oavsett vilka
rekommenderade läkemedelslistor deras läkemedelsartiklar ingår i.
getDistributedDrugsByDistributedDrugTradeName
Returnerar DistributedDrug-objekt för läkemedelsprodukter som har silProductGroupType =
APPROVED och givet distribuerat handelsnamn tradeName.
Inparametrar
tradeName: string
flgCurrent: boolean
regionId: int
En hel eller en del av ett handelsnamn. Wildcard-tecken '%' är
tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getDistributedDrugsByDistributedDrugTradeName ("Aspirin", False -1)
returnerar information om alla läkemedelsprodukter som har handelsnamnet ”Aspirin”
oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 42/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.6.2
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDistributedDrugByNplId
Returnerar DistributedDrug-objektet för läkemedelsprodukten med angivet NPL-id nplId.
Inparametrar
nplId: string
flgCurrent: boolean
regionId: int
Ett NPL-id.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug
Ett DistributedDrug.
Exempel
Anropet:
getDistributedDrugByNplId ("19590602000075", False, -1)
returnerar information om läkemedelsprodukten som har NPL-id ”19590602000075”
oavsett om det har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista den ingår i.
4.6.3
getDistributedDrugsByNplIdList
Returnerar en lista med DistributedDrug-objekt för läkemedelsprodukterna med angivna NPLid:n nuklids.
Inparametrar
nplIds: string [ ]
flgCurrent: boolean
regionId: int
En lista av strängar med NPL-id:n.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getDistributedDrugsByNplIdList (["19590602000075"], False, -1)
returnerar information om läkemedelsprodukten som har NPL-id ”19590602000075”
oavsett om det har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista den ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 43/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.6.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDistributedDrugsByDrugId
Returnerar en lista med DistributedDrug-objekt för läkemedelsprodukterna med angivet drugId.
Inparametrar
drugId: string
flgCurrent: boolean
regionId: int
Ett drugId.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
GetDistributedDrugsByDrugId ("19590602000075", False, -1)
returnerar information om alla läkemedelsprodukter som har drugId ”19590602000075”
oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista den ingår i.
4.6.5
getDistributedDrugsByDrugIdList
Returnerar en lista med DistributedDrug-objekt för läkemedelsprodukterna med angivna drugId:n
drugIds.
Inparametrar
drugIds: string
flgCurrent: boolean
regionId: int
En lista med drugIds.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getDistributedDrugsByDrugIdList (["19590602000075"], False, -1)
returnerar information om alla läkemedelsprodukter som har drugId ”19590602000075”
oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista den ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 44/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.6.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDistributedDrugHistoricalNamesByNplId
Returnerar en lista med alla historiska handelsnamn för läkemedelsprodukten med angivet NPLid nplId.
Inparametrar
nplid: string
Ett NPL-id.
Returtyp
string [ ]
Lista med historiska handelsnamn.
Exempel
Anropet:
getDistributedDrugHistoricalNamesByNplId ("19590602000075")
returnerar alla historiska handelsnamn för läkemedelsprodukten med NPL-id
”19590602000075” .
4.6.7
getNplIdsByDistributedDrugHistoricalName
Returnerar en lista med alla NPL-id för läkemedelsprodukten med det angivna historiska
handelsnamnet name.
Inparametrar
name: string
En hel eller en del av ett handelsnamn. Wildcard-tecken '%' är
tillåtet i strängen.
Returtyp
string [ ]
Lista med NPL-id.
Exempel
Anropet:
getNplIdsByDistributedDrugHistoricalName ("Aspirin")
returnerar alla NPL-id för läkemedelsprodukter med handelsnamnet ”Aspirin”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 45/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.6.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getInterchangeableDistributedDrugsByNplId
Returnerar en lista med DistributedDrug-objekt för alla läkemedelsprodukter som är utbytbara
mot läkemedelsprodukten med angivet NPL-id nplId.
Inparametrar
nplId: string
flgCurrent: boolean
regionId: int
Ett NPL-id.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getInterchangeableDistributedDrugsByNplId ("19590602000075", False, -1)
returnerar information om alla läkemedelsprodukter som är utbytbara mot
läkemedelsprodukten med NPL-id ”19590602000075”, oavsett om de har tillgängliga
läkemedelsartiklar och oavsett vilken rekommenderad läkemedelslista de ingår i.
4.6.9
getDistributedDrugsByNplSubstanceId
Returnerar en lista med DistributedDrug-objekt för alla läkemedelsprodukter som innehåller en
aktiv substans med angivet NPL-substansid nplISubstanceId.
Inparametrar
nplSubstanceId: string
flgCurrent: boolean
regionId: int
Ett NPL-substansid.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getDistributedDrugsByNplSubstanceId ("IDE4POFGUAZERVERT1", False, -1)
returnerar information om alla läkemedelsprodukter som innehåller den aktiva substansen
med NPL-substansid ”IDE4POFGUAZERVERT1”, oavsett om de har tillgängliga
läkemedelsartiklar och oavsett vilken rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 46/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.6.10
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDistributedDrugsBySubstanceName
Returnerar en lista med DistributedDrug-objekt för alla läkemedelsprodukter som har
silProductGroupType = APPROVED och som innehåller en aktiv substans med angivet
substansnamn substanceName.
Inparametrar
substanceName: string
flgCurrent: boolean
regionId: int
Ett substansnamn.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getDistributedDrugsBySubstanceName ("Simvastatin", False, -1)
returnerar information om alla godkända läkemedelsprodukter som innehåller den aktiva
substansen med substansnamnet ”Paracetamol”, oavsett om de har tillgängliga
läkemedelsartiklar och oavsett vilken rekommenderad läkemedelslista de ingår i.
4.6.11
getUnauthorisedDistributedDrugsBySubstanceName
Returnerar en lista med DistributedDrug-objekt för alla icke-godkända läkemedelsprodukter som
innehåller en aktiv substans med angivet substansnamn substanceName.
Inparametrar
substanceName: string
flgCurrent: boolean
regionId: int
silProductTypeGroup:
string
Ett substansnamn.
Se kapitlets inledning.
Se kapitlets inledning.
SIL produkttypsgrupp. Giltiga värden är ”NON_APPROVED”och
”TRADITIONAL ”.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getUnauthorisedDistributedDrugsBySubstanceName ("Paracetamol", False, -1,
”NON_APPROVED”)
returnerar information om alla icke-godkända läkemedelsprodukter som innehåller den
aktiva substansen med substansnamnet ”Paracetamol”, oavsett om de har tillgängliga
läkemedelsartiklar och oavsett vilken rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 47/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.6.12
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getUnauthorisedDistributedDrugsByNplSubstanceId
Returnerar en lista med DistributedDrug-objekt för alla icke-godkända läkemedelsprodukter som
innehåller en aktiv substans med angivet NPL-substansid nplSubstanceId.
Inparametrar
nplSubstanceId: string
flgCurrent: boolean
regionId: int
silProductTypeGroup:
string
Ett NPL-substansid.
Se kapitlets inledning.
Se kapitlets inledning.
SIL produkttypsgrupp. Giltiga värden är ”NON_APPROVED”och
”TRADITIONAL ”.
Returtyp
DistributedDrug [ ]
Lista med DistributedDrug-objekt.
Exempel
Anropet:
getUnauthorisedDistributedDrugsByNplSubstanceId (”IDE4POC2U97HOVERT1”,
False, -1, ”NON_APPROVED”)
returnerar information om alla icke-godkända läkemedelsprodukter som innehåller den
aktiva substansen med NPL-substansid ”IDE4POC2U97HOVERT1”, oavsett om de har
tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad läkemedelslista de
ingår i.
4.6.13
DistributedDrug
Ett DistributedDrug-objekt representerar en läkemedelsprodukt och tillhörande information.
Attribut
nplId: string
drugId: string
tradeName: string
strengthNumeric: float
strengthNumericUnit: string
strengthText: string
drugFormCode: string
drugFormTextSv: string
productNoteInd: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
NPL-id
SIL SOAP API id för att identifiera Drug-objekt.
Handelsnamn.
Numerisk styrka. Tillhandahålls av Läkemedelsverket.
För kombinationsläkemedel saknar detta attribut värde.
Styrkeenhet. Tillhandahålls av Läkemedelsverket. För
kombinationsläkemedel saknar detta attribut värde.
Styrka och enhet i klartext. Tillhandahålls av ansvarigt
företag. För kombinationsläkemedel saknar detta
attribut värde.
Kod för läkemedelsform.
Läkemedelsform på svenska.
Produktanteckning som anges av ansvarigt företag. Om
tillverkaren av läkemedelsprodukten är Apoteket AB
Produktion & Laboratorier (APL) så är fälten
marketingAuthHolder och localRepresentative. Använd
då istället detta attribut för att få fram tillverkarinformation.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 48/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
marketingAuthHolder: string
localRepresentative: string
drugClassificationCode: string
containsLactos: string
containsLatex: string
parimpOriginalId: string
parallelImportDeviation: string
exportedFromCountryCode:
string
dosdispFlag: string
dosdispLife: int
dosdispLifeUnit: string
salesstoppedFlag: string
marketedFlag: string
marketedFromDate: string
approvalDate: string
withdrawalDate: string
hasRecommendedArticle:
boolean
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Innehavare av godkännande för försäljning. Om
tillverkaren av läkemedelsprodukten är Apoteket AB
Produktion & Laboratorier (APL) så saknar detta
attribut värde. Använd då productNoteInd istället för att
få fram tillverkarinformation.
Svensk försäljningsrepresentant. Om tillverkaren av
läkemedelsprodukten är Apoteket AB Produktion &
Laboratorier (APL) så saknar detta attribut värde.
Använd då productNoteInd istället för att få fram
tillverkarinformation.
Klassificering enligt receptkungörelsens klassifikation
av särskilda läkemedel.
Anger om läkemedelsprodukten innehåller laktos.
Möjliga värden är ”Y” och ”N”.
Anger om läkemedelsprodukten innehåller latex.
Möjliga värden är ”Y”, ”N” och ”S”. ”S” (some) anger
att vissa av läkemedelsproduktens artiklar innehåller
latex.
Originalläkemedelets NPL-id.
Parallellimportavvikelse. En beskrivande text avseende
avvikelser i utseende för en parallellimporterad
läkemedelsprodukt i jämförelse med originalläkemedlet.
Kod som anger landet från vilket en parallellimporterad
läkemedelsprodukt importeras.
Anger om bryttillstånd för dosdispensering beviljats.
Möjliga värden är ”Y” och ”N”.
Numerisk hållbarhetstid vid dosdispensering.
Kombineras med dosdispLifeUnit.
Enhet vid dosdispensering. Kombineras med
dosdispLife.
Anger om läkemedelsprodukten är försäljningsstoppad.
Möjliga värden är ”Y” och ”N”.
Anger om läkemedelsprodukten marknadsförs och är
tillgängligt på svenska marknaden. Möjliga värden är
”Y” och ”N”.
Anger datum för när läkemedelsprodukten ska börja
marknadsföras och finnas tillgängligt på svenska
marknaden.
Godkännandedatum.
Datum då läkemedelsprodukten avregistrerades.
Anger om det finns rekommenderade läkemedelsartiklar med denna läkemedelsprodukt i den
rekommendationslista som angavs vid anropet till
tjänsten som returnerade detta DistributedDrug-objekt.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 49/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
hasAntiRecommendedArticle:
boolean
interchangeableFlag: string
silLactationCode: string
silPregnancyCode: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Anger om det finns anti-rekommenderade läkemedelsartiklar, med denna läkemedelsprodukt, i den
rekommendationslista som angavs vid anropet till
tjänsten som returnerade detta DistributedDrug-objekt.
Anger om läkemedelsprodukten är utbytbar. Möjliga
värden är ”Y” och ”N”.
Anger SIL:s läsrekommendation angående risker vid
amning. Möjliga värden är ”L” (låg läsrekommendation), ”M” (medelhög läsrekommendation) och ”H”
(hög läsrekommendation).
Anger SIL:s läsrekommendation angående risker vid
graviditet. Möjliga värden är ” L” (låg läsrekommendation), ”M” (medelhög läsrekommendation) och ”H”
(hög läsrekommendation).
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 50/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.7
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Läkemedelsartiklar
Tjänsterna används för att hämta information om läkemedelsartiklar.
De flesta av tjänsterna nedan tar två inparametrar; flgCurrent och regionId. De har följande syfte.
flgCurrent: boolean
regionId: int
4.7.1
Anger att information om enbart läkemedelsartiklar som är
tillgängliga (true), eller inte (false), ska returneras.
Anger att enbart de läkemedelsartiklar som finns i denna
rekommenderade läkemedelslista ska returneras. Om regionId = -1 så
returneras alla läkemedelsartiklar oavsett vilka rekommenderade
läkemedelslistor de ingår i.
getDrugArticlesByDistributedDrugTradeName
Returnerar DrugArticle-objekt för läkemedelsartiklar med läkemedelsprodukter som har
silProductGroupType = APPROVED och givet handelsnamn tradeName.
Inparametrar
tradeName: string
flgCurrent: boolean
regionId: int
En hel eller en del av ett handelsnamn. Wildcard-tecken '%' är
tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DrugArticle [ ]
Lista med DrugArticle-objekt sorterade på drugId i första hand och
nplId i andra hand.
Exempel
Anropet:
getDrugArticlesByDistributedDrugTradeName ("Aspirin", False -1)
returnerar information om alla läkemedelsartiklar som har handelsnamnet ”Aspirin”
oavsett om de är tillgängliga och oavsett vilken rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 51/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.7.2
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugArticlesByDrugId
Returnerar en lista med DistributedArticle-objekt för parallellimporterna med angivet drugId.
Inparametrar
drugId: string
flgCurrent: boolean
regionId: int
Ett drugId.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DrugArticle [ ]
Lista med DrugArticle-objekt sorterade på drugId i första hand och
nplId i andra hand.
Exempel
Anropet:
getDrugArticlesByDrugId ("19590602000075", False, -1)
returnerar information om alla läkemedelsartiklar för parallellimporterna med drugId
”19590602000075” oavsett om de är tillgängliga och oavsett vilken rekommenderad
läkemedelslista de ingår i.
4.7.3
getDrugArticlesByDrugIdList
Returnerar en lista med DistributedArticle-objekt för parallellimporterna med angivna drugIds.
Inparametrar
drugIds: string [ ]
flgCurrent: boolean
regionId: int
En lista med drugId:n.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DrugArticle [ ]
Lista med DrugArticle-objekt sorterade på drugId i första hand och
nplId i andra hand.
Exempel
Anropet:
getDrugArticlesByDrugIdList (["20110823000065", "20120112000058"], False, -1)
returnerar information om alla läkemedelsartiklar för parallellimporterna med drugId:n
”20110823000065” och ”20120112000058” oavsett om de är tillgängliga och oavsett
vilken rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 52/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.7.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugArticlesByNplId
Returnerar en lista med DistributedArticle-objekt för läkemedelsprodukten med angivet NPL-id
nplId.
Inparametrar
nplId: string
flgCurrent: boolean
regionId: int
Ett NPL-id.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DrugArticle [ ]
Lista med DrugArticle-objekt sorterade på drugId i första hand och
nplId i andra hand.
Exempel
Anropet:
getDrugArticlesByNplId ("19590602000075", False, -1)
returnerar information om alla läkemedelsartiklar för parallellimporterna med nplId
”19590602000075” oavsett om de är tillgängliga och oavsett vilken rekommenderad
läkemedelslista de ingår i.
4.7.5
getDrugArticlesByNplIdList
Returnerar en lista med DistributedArticle-objekt för läkemedelsprodukterna med angivna NPLid:n nplIds.
Inparametrar
nplIds: string [ ]
flgCurrent: boolean
regionId: int
En lista med NPL-id.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DrugArticle [ ]
Lista med DrugArticle-objekt sorterade på drugId i första hand och
nplId i andra hand.
Exempel
Anropet:
getDrugArticlesByNplIdList (["19350131000010", "20120627000017"], False, -1)
returnerar information om alla läkemedelsartiklar för läkemedelsprodukter med NPL-id:n
”19350131000010” och ”20120627000017” oavsett om de är tillgängliga och oavsett
vilken rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 53/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.7.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugArticleByNplPackId
Returnerar ett DistributedArticle-objekt för läkemedelsartikeln med angivet NPL-packid
nplPackId.
Inparametrar
nplPackId: string
flgCurrent: boolean
regionId: int
Ett NPL-packid.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DrugArticle
Ett DrugArticle-objekt.
Exempel
Anropet:
getDrugArticleByNplPackId ("19590602100034", False, -1)
returnerar information om läkemedelsartikeln med NPL-packid ”19590602100034”
oavsett om den är tillgänglig och oavsett vilken rekommenderad läkemedelslista den ingår
i.
4.7.7
getDrugArticlesByNplPackIdList
Returnerar en lista med DistributedArticle-objekt för läkemedelsartiklarna med angivna NPLpackid:n nplPackIds.
Inparametrar
nplPackIds: string [ ]
flgCurrent: boolean
regionId: int
En lista med NPL-packid.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
DrugArticle [ ]
Lista med DrugArticle-objekt sorterade på drugId i första hand och
nplId i andra hand.
Exempel
Anropet:
getDrugArticlesByNplPackIdList (["19350101100016", "19670401100012"], False, -1)
returnerar information om alla läkemedelsartiklar med NPL-packid:n ”19350101100016”
och ”19670401100012” oavsett om de är tillgängliga och oavsett vilken rekommenderad
läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 54/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.7.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getHistoricalArticleNosByNplPackId
Returnerar en lista med historiska varunummer för läkemedelsartiklarna med angivet NPLpackid nplPackId.
Inparametrar
nplPackId: string
Ett NPL-packid.
Returtyp
string [ ]
Lista med historiska varunummer.
Exempel
Anropet:
getHistoricalArticleNosByNplPackId ("19350131000010")
returnerar en lista med historiska varunummer för läkemedelsartikeln med NPL-packid
”19350131000010”.
4.7.9
getNplPackIdsByDateAdded
Returnerar en lista med NPL-packid för läkemedelsartiklar som blivit tillgängliga fr.o.m.
angivet datum dateAdded.
Inparametrar
dateAdded: string
Ett sträng med tio (10) tecken som innehåller ett datum med
formatet ÅÅÅÅ-MM-DD.
Returtyp
string [ ]
Lista med NPL-packid.
Exempel
Anropet:
getNplPackIdsByDateAdded ("2014-01-01")
returnerar en lista med NPL-packid:n för läkemedelsartiklar som blivit tillgängliga fr.o.m.
2014-01-01.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 55/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.7.10
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getTlvExchangesByNplPackIdList
Returnerar en lista med TlvExchange-objekt med information om utbytbarhet och förmån för
läkemedelsartiklarna med angivna NPL-packid:n nplPackIds.
Inparametrar
nplPackIds: string [ ]
Ett lista med NPL-packid.
Returtyp
TlvExchange [ ]
Lista med TlvExchange-objekt.
Exempel
Anropet:
getTlvExchangesByNplPackIdList ("20130603106398")
returnerar en lista med TlvExchange-objekt med information om utbytbarhet och förmån
för läkemedelsartikeln med NPL-packid ”20130603106398”.
4.7.11
DrugArticle
Ett DrugArticle-objekt representerar en läkemedelsartikel.
Attribut
nplpackId: string
nplId: string
drugId: string
barcode: string
distributedTradeName: string
articleNo: string
aup: float
dddPerPackage: float
packSizeText: string
packSizeNumeric: string
packSizeNumericUnit: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
NPL-packid.
NPL-id.
SIL SOAP API id för att identifiera Drug-objekt.
Streckkod.
Handelsnamn.
Nordiskt varunummer. Det är en sträng med sex siffror
och alltid med inledande 0:or om det behövs.
Anger förmånspris på läkemedelsartikeln. Attributet
isReimbursed anger om läkemedelsartikeln ingår i
TLV:s förmån. Attributet packageNoteLfn anger om det
finns speciella villkor för att varan ska omfattas av
förmånen. OBS! Notera att licensläkemedel alltid ingår
i förmånen trots att det saknas prisuppgift för dem.
Antal definierade dygnsdoser (DDD) per
läkemedelsartikel.
Beskrivning på svenska av förpackningsstorlek.
Attributet kan användas istället för packSizeMultiplier1,
packSizeMultiplier2 och packSizeNumeric,
packSizeAlphanumeric och packSizeNumericUnit.
Numeriskt förpackningsantal. En läkemedelsartikel kan
innehålla förpackningar som gör att förpackningsantalet
uttrycks med två multipler och ett förpackningsantal
t.ex. 5x4x100, Numeriskt förpackningsantal är här 100.
Kombineras med packSizeNumericUnit
Enhet för packSizeNumeric.T.ex. ”tablett(er).
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 56/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
packSizeMultiplier1: int
packSizeMultiplier2: int
packageText: string
packageNoteInd: string
packageNoteLfn: string
packageTypeInnerCode: string
prescriberCodes: string [ ]
salesRestrictionCodes: string [ ]
otcFlag: string
marketedFlag: string
marketedFromDate: string
withdrawalDate: string
isRecommended: boolean
isAntiRecommended: boolean
interchangeableFlag: string
isReimbursed: boolean
salesstoppedFlag: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Förpackningsmultipel 1. En läkemedelsartikel kan
innehålla förpackningar som gör att förpackningsantalet
uttrycks med två multipler och ett förpackningsantal
t.ex. 5x4x100, Förpackningsmultipel 1 är här 4.
Förpackningsmultipel 2. En läkemedelsartikel kan
innehålla förpackningar som gör att förpackningsantalet
uttrycks med två multipler och ett förpackningsantal
t.ex. 5x4x100, Förpackningsmultipel 2 är här 5.
Beskrivning på svenska av läkemedelsartikelns
förpackning. T.ex. ”Amp.,10 x 10 ml”.
Företagets egen kommentar rörande enskild
förpackning. T.ex. ”Förpackningsstorleken
marknadsförs inte”.
Om läkemedelsartikeln ingår i TLV:s förmån, men bara
under vissa villkor, så anger denna kommentar villkoren
för att varan ska omfattas av förmånen.
Kod som anger typ av förpackning i läkemedelsartikeln.
Kod som anger vilka yrkeskategorier som har
förskrivningsrätt.
Lista av koder som anger vilka försäljningsrestriktioner
Läkemedelsverket definierat för läkemedelsartikeln.
Anger om Läkemedelsverket reglerat att läkemedelsartikeln är receptfri eller inte. Möjliga värden är ” Y” och
”N”.
Anger om läkemedelsartikeln är tillgängligt på svenska
marknaden. Möjliga värden är ” Y” och ”N”.
Anger datum för när läkemedelsartikeln ska finnas
tillgängligt på svenska marknaden.
Datum då läkemedelsartikelns läkemedelsprodukt
avregistrerades.
Anger om det finns rekommenderade läkemedelsartiklar i den rekommendationslista som angavs vid
anropet till tjänsten som returnerade detta
DistributedArticle-objekt.
Anger om det finns anti-rekommenderade läkemedelsartiklar i den rekommendationslista som angavs vid
anropet till tjänsten som returnerade detta
DistributedArticle-objekt.
Anger om läkemedelsartikeln är utbytbar. Möjliga
värden är ”Y” och ”N”.
Ingår i TLV:S förmån
Anger om läkemedelsprodukten är försäljningsstoppad.
Möjliga värden är ”Y” och ”N”.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 57/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.7.12
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
TlvExchange
Ett TlvExchange-objekt som innehåller information om en utbytbar läkemedelsartikel.
Attribut
nplpackId: string
exchangePeriods:
ExchangePeriod [ ]
4.7.13
NPL-packid
En lista med ExchangePeriod-objekt.
ExchangePeriod
Ett ExchangePeriod-objekt som innehåller information om en utbytbar läkemedelsartikel.
Attribut
startDate: string
stopDate: string
periodicArticleFlag: string
periodicArticleStartDate: string
orderStoppedDate: string
orderStoppedStartDate: string
aipPerUnit
aupPerUnit
rank
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Datum när utbytbarhetsperioden börjar.
Datum när utbytbarhetsperioden slutar.
Anger om denna läkemedelsartikel är, eller har varit,
periodens vara. Möjliga värden är ' Y' och 'N'.
Om denna läkemedelsartikel har periodicArticleFlag =
'Y', så anger detta datum från när denna läkemedelsartikel är periodens vara (fram till utbytbarhetsperiodens slutdatum).
Anger om denna läkemedelsartikel har blivit beställningsstoppad under utbytbarhetsperioden. Möjliga
värden är 'Y' och 'N'.
Om denna läkemedelsartikel har orderStoppedDate = 'Y',
så anger detta datum när denna läkemedelsartikel blev
beställningsstoppad.
Apotekens inköpspris per enhet.
Apotekens utköpspris per enhet.
Om denna läkemedelsartikel är periodens vara under
denna utbytbarhetsperiod, så anger detta vilken rang
denna läkemedelsartikel har.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 58/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Läkemedelsförvaring
Tjänsterna används för att hämta information om förvaring av läkemedelsartiklar.
4.8.1
getStoragesByNplPackId
Returnerar en lista med Storage-objekt med information om förvaring av läkemedelsartikeln
med angivet NPL-packid nplPackId.
Inparametrar
nplPackId: string
Ett NPL-packid.
Returtyp
Storage [ ]
Ett Storage-objekt med information om förvaring.
Exempel
Anropet:
getStoragesByNplPackId ("20130603106398")
returnerar en lista med Storage-objekt med information om förvaring av
läkemedelsartikeln med NPL-packid ”20130603106398”.
4.8.2
getStoragesByNplPackIdList
Returnerar en lista med Storage-objekt med information om förvaring av läkemedelsartiklarna
med angivna NPL-packid nplPackIds.
Inparametrar
nplPackIds: string [ ]
En lista av strängar med NPL-packid.
Returtyp
Storage [ ]
Ett Storage-objekt med information om förvaring.
Exempel
Anropet:
getStoragesByNplPackIdList (["20130603106398"])
returnerar en lista med Storage-objekt med information om förvaring av
läkemedelsartikeln med NPL-packid ”20130603106398”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 59/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.8.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Storage
Ett Storage-objekt innehåller information om förvaring av läkemedelsartiklar.
Attribut
nplPackId: string
packConditionCode: string
shelflife: int
shelfLifeUnitCode: string
storageConditionCode: string
storageTempCode: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
NPL-packid.
Kod som representerar förpackningstillståndet.
Hållbarhetstid.
Kod som representerar enhet för hållbarhet.
Kod som representerar förvaringsvillkor. För framtida
bruk, används ej i nuläget.
Kod som representerar förvaringstemperatur.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 60/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.9
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Läkemedelsformer
Tjänsterna används för att hämta information om läkemedelsform och dosering för läkemedel
baserat på läkemedelsformskod.
4.9.1
getDrugForms
Returnerar en lista med alla DrugForm-objekt med information om läkemedelsformer.
Inparametrar
Returtyp
DrugForm [ ]
En lista med DrugForm-objekt med information om
läkemedelsformer.
Exempel
Anropet:
getDrugForms ()
returnerar en lista med DrugForm-objekt med information om alla läkemedelsformer.
4.9.2
getDrugFormByDrugFormCode
Returnerar en lista med DrugForm-objekt med information om läkemedelsformen med angiven
kod drugFormCode.
Inparametrar
drugFormCode: string
En kod för en läkemedelsform.
Returtyp
DrugForm
Ett DrugForm-objekt med information om läkemedelsform.
Exempel
Anropet:
getDrugFormByDrugFormCode ("INHPOW")
returnerar ett DrugForm-objekt med information om läkemedelsformen med kod
”INHPOW”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 61/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.9.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
DrugForm
Ett DrugForm-objekt innehåller information om en läkemedelsform.
Attribut
drugFormCode: string
drugFormTextSv: string
dosages: Dosages [ ]
4.9.4
Kod för läkemedelsformen.
Beskrivning på svenska av läkemedelsformen.
En lista av Dosage-objekt som innehåller information
om doseringsformer.
Dosage
Ett Dosage-objekt innehåller information om en doseringsform.
Attribut
dosageUnit: string
dosageUnitPlural: string
dosageUnitIndefinite: int
administration: string
routeOfAdministration: string
patientInformation: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Doseringsenhet.
Pluralform av doseringsenheten.
Obestämd artikel som ska användas med
doseringsenheten.
Administreringssätt.
Administreringsväg. För framtida bruk, används ej i
nuläget.
Information om dosering avsedd för patienter. För
framtida bruk, används ej i nuläget.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 62/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.10 FASS-texter
Tjänsterna används för att hämta FASS-texter i XHTML-format.
4.10.1
getFassDocsByDrugId
Returnerar en lista med FassDoc-objekt med FASS-texter för parallellimporterna med angivet
drugId.
Inparametrar
drugId: string
Ett drugId.
Returtyp
FassDoc [ ]
Ett FassDoc-objekt med information om läkemedelsform.
Exempel
Anropet:
getFassDocsByDrugId ("20110823000065")
returnerar en lista med FassDoc-objekt med FASS-texter om parallellimporterna med
drugId ”20110823000065”.
4.10.2
getFassDocsByNplId
Returnerar en lista med FassDoc-objekt med FASS-texter för läkemedelsprodukten med angivet
NPL-id nplId.
Inparametrar
nplId: string
Ett NPL-id.
Returtyp
FassDoc [ ]
Ett FassDoc-objekt med information om läkemedelsform.
Exempel
Anropet:
getFassDocsByNplId ("19350131000010")
returnerar en lista med FassDoc-objekt med FASS-texter om läkemedelsprodukten med
NPL-id ”19350131000010”.
4.10.3
FassDoc
Ett FassDoc-objekt innehåller en FASS-text i XHTML-format.
Attribut
nplId: string
NPL-id.
FASS-text i XHTML.
XHtml: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
info[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 63/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.11 Interaktioner
Tjänsterna används för att hämta information om läkemedelsinteraktioner. Grundkällan för
denna information är Sfinx (Swedish Finnish Interaction X-referencing) som underhålls och
publiceras av SLL/JanusInfo.
I Sfinx klassificeras alla interaktioner efter klinisk signifikans och vilken dokumentation som
finns. Se avsnittet om DrugInteraction-objekt för en beskrivning av de klassificeringarna. I en del
tjänster kan man ange en klinisk signifikans för att ange vilka interaktioner man vill få
information om.
4.11.1
getInteractionsByDrugIdAgainstAll
Returnerar en lista med DrugInteraction-objekt med information om interaktioner med angiven
klinisk signifikans sevClassification mellan parallellimporten med angivet drugId och alla andra
läkemedelsprodukter.
Inparametrar
drugId: string
sevClassification:
string
Ett drugId.
Klinisk signifikans. Möjliga värden är ”A”, ”B”, ”C”, ”D” och ”-”
(alla kliniska signifikanser). Om ”-” anges och antalet objekt som
tjänsten kommer att returnera är mer än 200, så fås istället ett
SilException.
Returtyp
DrugInteraction [ ]
En lista med DrugInteraction-objekt med information om
interaktioner.
Exempel
Anropet:
getInteractionsByDrugIdAgainstAll (”19880406000037”, ”D”)
returnerar en lista med DrugInteraction-objekt med information om interaktioner med
klinisk signifikans ”D” mellan alla läkemedelsprodukter och parallellimporten drugId
”19880406000037”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 64/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.11.2
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getInteractionsByDrugIdAgainstList
Returnerar en lista med DrugInteraction-objekt med information om interaktioner mellan alla
läkemedelsprodukter och parallellimporten med angivet drugId.
Inparametrar
drugId: string
drugIds: string [ ]
Ett drugId.
En lista med drugId.
Returtyp
DrugInteraction [ ]
En lista med DrugInteraction-objekt med information om
interaktioner.
Exempel
Anropet:
getInteractionsByDrugIdAgainstList ("19880406000037", ["20040302000104",
"20040916001603"])
returnerar en lista med DrugInteraction-objekt med information om interaktioner mellan
parallellimporten med drugId ”19880406000037” och parallellimporterna med drugId
”20040302000104” och ”20040916001603”.
4.11.3
getInteractionsWithinDrugIdList
Returnerar en lista med DrugInteraction-objekt med information om interaktioner mellan alla
parallellimporterna med angivna drugIds.
Inparametrar
drugIds: string [ ]
En lista med drugId.
Returtyp
DrugInteraction [ ]
En lista med DrugInteraction-objekt med information om
interaktioner.
Exempel
Anropet:
getInteractionsWithinDrugIdList (["19880406000037", "20040302000104"])
returnerar en lista med DrugInteraction-objekt med information om interaktioner mellan
parallellimporterna med drugId ”19880406000037” och ”20040916001603”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 65/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.11.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getShortInteractionsByInteractionIdList
Returnerar en lista med DrugInteraction-objekt med kortfattad information om alla interaktioner
med angivna interactionIds.
Inparametrar
interactionIds: string [ ]
En lista med interactionIds.
Returtyp
ShortInteraction [ ]
En lista med ShortInteraction-objekt med kortfattad information
om interaktioner.
Exempel
Anropet:
getShortInteractionsByInteractionIdList (["4732", "5532"])
returnerar en lista med ShortInteraction-objekt med kortfattad information om alla
interaktioner med interactionId ”4732” och ”5532”.
4.11.5
getInteractionsByDrugIdAgainstListSevClassification
Returnerar en lista med DrugInteraction-objekt med information om interaktioner med klinisk
signifikans sevClassification mellan parallellimporten med angivet drugId och alla
parallellimporter med angivna drugIds.
Inparametrar
drugId: string
drugIds: string [ ]
sevClassification:
string
Ett drugId.
En lista med drugId.
Klinisk signifikans. Möjliga värden är ”A”, ”B”, ”C”, ”D”, ”AB”
(”A” eller ”B”) och ”CD” (”C” eller ”D”).
Returtyp
DrugInteraction [ ]
En lista med DrugInteraction-objekt med information om
interaktioner.
Exempel
Anropet:
getInteractionsByDrugIdAgainstListSevClassification ("19880406000037",
["20040302000104", "20040916001603"], ”D”)
returnerar en lista med drugInteraction-objekt med information om interaktioner med
klinisk signifikans ”D” mellan parallellimporten med drugId ”19880406000037” och
parallellimporterna med drugId ”20040302000104” och ”20040916001603”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 66/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.11.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getInteractionsWithinDrugIdListSevClassification
Returnerar en lista med DrugInteraction-objekt med information om interaktioner med klinisk
signifikans sevClassification mellan parallellimporterna med angivna drugIds.
Inparametrar
drugIds: string [ ]
sevClassification:
string
En lista med drugId.
Klinisk signifikans. Möjliga värden är ”A”, ”B”, ”C”, ”D”, ”AB”
(”A” eller ”B”) och ”CD” (”C” eller ”D”).
Returtyp
DrugInteraction [ ]
En lista med DrugInteraction-objekt med information om
interaktioner.
Exempel
Anropet:
getInteractionsWithinDrugIdListSevClassification (["20040302000104",
"19880406000037"], ”D”)
returnerar en lista med drugInteraction-objekt med information om interaktioner med
klinisk signifikans ”D” mellan parallellimporterna med drugId ”20040302000104” och
”19880406000037”.
4.11.7
getCompleteInteractionByInteractionId
Returnerar en lista med DrugInteraction-objekt med fullständig information om alla interaktioner
med allvarlighetsklass sevClassification mellan parallellimporterna med angivna drugIds.
Inparametrar
interactionId: int
Ett interactionId.
Returtyp
CompleteInteraction
Ett CompleteInteraction-objekt med fullständig information om en
interaktion.
Exempel
Anropet:
getCompleteInteractionByInteractionId ("4732")
returnerar ett CompleteInteraction-objekt med fullständig information om interaktionen
med interactionId ”4732”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 67/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.11.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
DrugInteraction
Ett DrugInteraction-objekt innehåller information om en interaktion.
Attribut
drugIds: string [ ]
sevClassification: string
docClassification: int
interactionId: string
4.11.9
En lista med drugId för de parallellimporter som denna
interaktion gäller för.
Klinisk betydelse. Möjliga värden är:
A = Interaktionen saknar klinisk betydelse.
B = Interaktionens kliniska betydelse är okänd och/eller
varierar.
C = Kliniskt betydelsefull interaktion som kan hanteras
med till exempel dosjustering.
D = Kliniskt betydelsefull interaktion som bör undvikas.
Dokumentationens art. Möjliga värden är:
0 = Data från studier av andra läkemedel med liknande
egenskaper.
1 = Data från ofullständiga fallrapporter och/eller in
vitro-studier.
2 = Data från väldokumenterade fallrapporter.
3 = Data från studier på friska försökspersoner och/eller
pilotstudier på patienter.
4 = Data från kontrollerade studier på relevant
patientpopulation.
SIL internt id. Det är ej tidsbeständigt och ska ej
användas för att identifiera interaktioner utanför SIL.
ShortInteraction
Ett ShortInteraction-objekt innehåller kortfattad information om en interaktion.
Attribut
interactionId: string
sections: InteractionSection [ ]
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
SIL internt id. Det är ej tidsbeständigt och ska ej
användas för att identifiera interaktioner utanför SIL.
Textavsnitt som beskriver interaktionen.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 68/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.11.10 InteractionSection
Ett InteractionSection-objekt är ett textavsnitt som beskriver en aspekt av en interaktion.
Attribut
sectionTitle: string
sectionText
Avsnittsrubrik
Textavsnitt som beskriver en aspekt av en interaktion.
Texten för avsnitten ”Medicinsk konsekvens” och
”Rekommendation” finns på svenska och är den
kortfattade text som är avsedd att en förskrivaren snabbt
skall ha tillgång till. Texten i avsnitten ”Mechanism”
och ”Background” finns på engelska och innehåller en
mer omfattande beskrivning av interaktionens
mekanism samt en bakgrund avseende de kliniska och
evidensbaserade studier som ligger till grund för
klassificeringen av interaktionen.
4.11.11 CompleteInteraction
Ett CompleteSection-objekt innehåller fullständig information om en interaktion.
Attribut
interactionId: string
SIL internt id. Det är ej tidsbeständigt och ska ej
användas för att identifiera interaktioner utanför SIL.
interactingParts: InteractingPart [ ] Interagerande parallellimporter.
sections: InteractionSection [ ]
Textavsnitt som beskriver interaktionen.
references: Reference [ ]
Litteraturreferenser.
4.11.12 InteractingPart
Ett CompleteSection-objekt representerar interagerande parallellimporter.
Attribut
name: string
drugIds: string [ ]
Namn.
En lista med drugId.
4.11.13 Reference
Ett Reference-objekt representerar en litteraturreferens i PubMed.
Attribut
pubmedId: int
Id i PubMed.
Titel på litteraturreferensen och dess författare.
text: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 69/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.12 Biverkningar
Tjänsterna används för att hämta information om läkemedelsbiverkningar.
Information om biverkningar baseras på extraktion och kvalitetssäkring av biverkningstabeller i
avsnitt 4.8 "Biverkningar" i Läkemedelsverkets produktresuméer. Arbete med utvärdering av
lösningen pågår och därför ska inte dessa tjänster användas i skarp drift.
Biverkningstabeller som finns i produktresuméerna omvandlas till en standardiserad tabellform
där biverkningar är kategoriserade i systemorganklasser (MedDRA) och indelade i standardiserade frekvenskategorier.
Här är ett exempel på hur en sådan standardiserad biverkningstabell kan visualiseras:
BIVERKNINGSTABELL
Frekvenskategori
Systemorganklass
(MedDRA)
Vanliga
Mindre vanlig
Immunsystemet
Överkänslighetsreaktion
Nervsystemet
Huvudvärk
Yrsel
GI
Esofagit, Gastrit,
Gastroesofageal
refluxsjukdom,
Dyspepsi, Diarré,
Buksmärta, Illamående
Esofagit inkluderande
esofagussår eller
esofagusstriktur och
dysfagi, Kräkningar,
Flatulens
Hud
Hudutslag
Muskuloskeletal
Artralgi, Myalgi,
Ryggsmärta
Muskuloskeletal smärta,
Muskelkramp,
Muskuloskeletal stelhet
Allmänna
Inera AB
Sällsynta
Duodenit
Angioödem, Ansiktsödem,
Urtikaria
Trötthet
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 70/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.12.1
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getSideEffectsByNplIdList
Returnerar en lista med SideEffects-objekt med information om biverkningar hos parallellimporterna med angivna drugIds för angiven systemorganklass soc och med angivna symptom
symptom.
Inparametrar
nplIds: string [ ]
soc: string
symptom: string
En lista med NPL-id.
Systemorganklass. Om detta är en tom sträng ”” sker ingen
filtrering på systemorganklass.
Symptom. Om detta är en tom sträng ”” sker ingen filtrering på
symptom.
Returtyp
SideEffects [ ]
En lista med SideEffects-objekt med information om biverkningar.
Exempel
Anropet:
getSideEffectsByNplIdList (["20130603106398"], "", "")
returnerar en lista med SideEffects-objekt med information om biverkningar för
parallellimporterna med drugId ”20130603106398”.
4.12.2
getSideEffectFrequencies
Returnerar en lista med alla frekvenskategorier för biverkningar som används.
Inparametrar
Returtyp
string [ ]
En lista med frekvenskategorier för biverkningar.
Exempel
Anropet:
getSideEffectFrequencies ()
returnerar en lista med frekvenskategorier för biverkningar.
4.12.3
getSideEffectSocs
Returnerar en lista med alla MedDRA systemorganklasser som används.
Inparametrar
Returtyp
string [ ]
En lista med MedDRA systemorganklasser för biverkningar.
Exempel
Anropet:
getSideEffectSocs ()
returnerar en lista med MedDRA systemorganklasser för biverkningar.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 71/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.12.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
SideEffects
Ett SideEffects-objekt innehåller en lista med alla biverkningar för en läkemedelsprodukt.
Attribut
nplId: string
sideEffects: SideEffect [ ]
SpcUpdated: string
4.12.5
NPL-id.
En biverkning.
Datum när produktresumén senast uppdaterades.
SideEffect
Ett SideEffect-objekt innehåller information om en biverkning.
Attribut
symptom: string
soc: string
frequency: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Textuell beskrivning av ett symptom.
MedDRA systemorganklass.
Frekvenskategori.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 72/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.13 Graviditets- och amningsvarningar
Tjänsterna används användas för att hämta information om läkemedel har dokumenterad negativ
effekt på foster hos gravida kvinnor eller på nyfödda som ammas.
I SIL finns tillgång till information om graviditets- och amningsvarningar från två olika
kunskapskällor; LIF/FASS och SLL/JanusInfo. Dessa källor har olika konventioner för att
klassificera varningar och dokumentationsgrad. I SIL sätts en läsrekommendation för varje
läkemedel beroende på vilken kombination av varningsklassificeringskoder som finns i de båda
källorna.
SIL läsrekommendation
Beskrivning
Hög
Nödvändigt att läsa vidare (baserat på varningsklassificering i minst en av
källorna).
?
Information saknas (i källorna).
Medel
Stark rekommendation att läsa vidare (baserat på varningsklassificering i
minst en av källorna).
Låg
Läs vidare (information finns i minst en av källorna).
Syftet med SIL läsrekommendationer är att de ska kunna användas för att signalera varningsnivåer i användargränssnitt tillsammans med länkar eller knappar som ger användaren möjlighet
att kunna läsa vidare om denne vill.
För en fullständig beskrivning om klassificeringskoderna i LIF/FASS och SLL/JanusInfo och
hur de mappas till SIL läsrekommendationer samt rekommendationer för att signalera läsrekommendationer och varningar i användargränssnitt hänvisas till SIL Verksamhetshandledning för Amning- och Graviditet-Fosterpåverkan.
4.13.1
getSILPregnancyLactationWarningsByNplIdList
Returnerar en lista med SILPregnancyLactationWarning-objekt med SIL läsrekommendationer
för graviditets- och amningsvarningar för läkemedelsprodukterna med angivna drugIds.
Inparametrar
nplIds: string [ ]
En lista med NPL-id.
Returtyp
SILPregnancyLactation
Warning [ ]
En lista med SILPregnancyLactationWarning-objekt med SIL
läsrekommendationer för graviditets- och amningsvarningar.
Exempel
Anropet:
getSILPregnancyLactationWarningsByNplIdList (["20111020000049"])
returnerar en lista med SILPregnancyLactationWarning-objekt med SIL läsrekommendationer för graviditets- och amningsvarningar för läkemedelsprodukterna med nplId
”20111020000049”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 73/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.13.2
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getWarningClassificationsByCode
Returnerar en lista med WarningClassification-objekt med information om varningsklassificeringar av den angivna typen av kunskapskälla type från den angivna kunskapskällan source.
Inparametrar
source: string
Kunskapskälla. Möjliga värden är ”fass”, ”janusinfo” och ”sil”.
Typ av kunskapskälla. Möjliga värden är ” pregnancy” och
”lactation”.
En hel eller en del av en varningsklassificering. Wildcard-tecken
'%' är tillåtet i strängen. Denna inparameter kan användas för att
filtrera vilka varningsklassificeringar som ska returneras.
type: string
code: string
Returtyp
WarningClassification [ ]
En lista med WarningClassification-objekt med SIL
läsrekommendationer för graviditets- och amningsvarningar.
Exempel
Anropet:
getWarningClassificationsByCode ("janusinfo", ”pregnancy”, ”%”)
returnerar en lista med SILPregnancyLactationWarning-objekt med information om
varningsklassificeringar för källtypen ”pregnancy” från kunskapskällan ”janusinfo”.
4.13.3
getJanusInfoLactationDocsByNplIdList
Returnerar en lista med JanusInfoLactationDoc-objekt med information om amningsvarningar
från SLL/Janusinfo.
Inparametrar
nplIds: string [ ]
En lista med NPL-id.
Returtyp
JanusInfoLactationDoc [ ]
En lista med JanusInfoLactationDoc-objekt med information
om amningsvarningar från kunskapskällan SLL/Janusinfo.
Exempel
Anropet:
getJanusInfoLactationDocsByNplIdList (["20111020000049"])
returnerar en lista med JanusInfoLactationDoc-objekt med information om amningsvarningar från kunskapskällan SLL/Janusinfo för läkemedelsprodukterna med nplId
”20111020000049”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 74/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.13.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getJanusInfoPregnancyDocsByNplIdList
Returnerar en lista med JanusInfoPregnancyDoc-objekt med information om
graviditetsvarningar kunskapskällan SLL/JanusInfo.
Inparametrar
nplIds: string [ ]
En lista med NPL-id.
Returtyp
JanusInfoPregnancyDoc [ ]
En lista med JanusInfoPregnancyDoc-objekt med information
om graviditetsvarningar från källan SLL/Janusinfo.
Exempel
Anropet:
getJanusInfoPregnancyDocsByNplIdList (["20111020000049"])
returnerar en lista med JanusInfoPregnancyDoc-objekt med information om graviditetsvarningar från kunskapskällan SLL/Janusinfo för läkemedelsprodukterna med nplId
”20111020000049”.
4.13.5
getFassLactationDocsByNplIdList
Returnerar en lista med FassLactationDoc-objekt med information om amningsvarningar från
kunskapskällan FASS.
Inparametrar
nplIds: string [ ]
En lista med NPL-id.
Returtyp
FassLactationDoc [ ]
En lista med FassLactationDoc-objekt med information om
amningsvarningar från kunskapskällan FASS.
Exempel
Anropet:
getFassLactationDocsByNplIdList (["20111020000049"])
returnerar en lista med FassLactationDoc-objekt med information om amningsvarningar
från kunskapskällan FASS för läkemedelsprodukterna med nplId ”20111020000049”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 75/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.13.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getFassPregnancyDocsByNplIdList
Returnerar en lista med FassPregnancyDoc-objekt med information om graviditetsvarningar
från kunskapskällan FASS.
Inparametrar
nplIds: string [ ]
En lista med NPL-id.
Returtyp
FassPregnancyDoc [ ]
En lista med FassPregnancyDoc-objekt med information om
graviditetsvarningar från kunskapskällan FASS.
Exempel
Anropet:
getFassPregnancyDocsByNplIdList (["20111020000049"])
returnerar en lista med FassPregnancyDoc-objekt med information om graviditetsvarningar från kunskapskällan FASS för läkemedelsprodukterna med nplId
”20111020000049”.
4.13.7
SILPregnancyLactationWarning
Ett SILPregnancyLactationWarning-objekt innehåller information om SIL läsrekommendationer
för graviditets- och amningsvarningar för en läkemedelsprodukt.
Attribut
nplId: string
silPregnancyWarningCode: string
silLactationWarningCode: string
sources: SourceWarning [ ]
4.13.8
NPL-id.
SIL läsrekommendation för graviditetsvarningar.
SIL läsrekommendation för amningsvarningar.
En lista med SourceWarning-objekt med information
om varningar från olika kunskapskällor.
SourceWarning
Ett SourceWarning-objekt innehåller information om en varningsklassificering från en
kunskapskälla.
Attribut
source: string
Kunskapskälla.
Typ av kunskapskälla. Möjliga värden är ”fass”,
”janusinfo” och ”sil”
Varningsklassificering.
type: string
code: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 76/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.13.9
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
WarningClassification
Ett WarningClassification-objekt innehåller information om en varningsklassificering från en
kunskapskälla.
Attribut
code: string
seriousnessLevel: string
text: string
Varningsklassificering.
Allvarlighetsnivå. Ju högre desto allvarligare.
Beskrivning av varningsklassificeringen.
4.13.10 JanusInfoLactationDoc
Ett JanusInfoLactationDoc-objekt innehåller information i form av ett semistrukturerat
dokument om en amningsvarning från SLL/JanusInfo.
Attribut
nplid: string
NPL-id.
documentTitle: string
Namn på dokumentet. Kan ändras. Oftast är
dokumentets namn samma som namnet på den
substans dokumentet handlar om, men det finns
undantag.
publishDate: string
Datum och tidpunkt då dokumentet publicerades.
classificationCode: string
Varningsklassificering.
classificationDescription: string
Beskrivning av varningsklassificeringen.
levelOfDocumentation: int
Dokumentationsnivå som anger hur väldokumenterad
varningen är.
levelOfDocumentationDescription: Beskrivning av dokumentationsnivå.
string
assessment: string
Text som beskriver vilken bedömning man har gjort.
Text som innehåller kommentar/kompletterande
information till bedömningen. Kan vara tom.
literatureSearchDate: string
Datum då litteratursökning gjordes.
references: JanusInfoReference [ ] Lista med litteraturreferenser.
links: JanusInfoLink [ ]
Lista med JanusInfoLink-objekt.
comment: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 77/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.13.11 JanusInfoPregnancyDoc
Ett JanusInfoPregnancyDoc-objekt innehåller information i form av ett semistrukturerat
dokument om en graviditetsvarning från SLL/JanusInfo.
Attribut
nplid: string
NPL-id.
Namn på dokumentet. Kan ändras. Oftast är
dokumentets namn samma som namnet på den
substans dokumentet handlar om, men det finns
undantag.
publishDate: string
Datum och tidpunkt då dokumentet publicerades.
classificationCode: string
Varningsklassificering.
classificationDescription: string
Beskrivning av varningsklassificeringen.
assessment: string
Text som beskriver vilken bedömning man har gjort.
summary: string
Sammanfattning.
birthDefectRegisterDate: string
Datum då Socialstyrelsens medicinska födelseregister
(MFR) konsulterades.
references: JanusInfoReference [ ] Lista med litteraturreferenser.
links: JanusInfoLink [ ]
Lista med JanusInfoLink-objekt.
documentTitle: string
4.13.12 JanusInfoReference
Ett JanusInfoReference-objekt innehåller information om en litteraturreferens för en amningseller graviditetsvarning från SLL/JanusInfo.
Attribut
text: string
pubMedId: string
style: string
link: JanusInfoLink
Beskrivning av litteraturreferensen.
PubMed id.
Referensstil.
Ett JanusInfoLink-objekt.
4.13.13 JanusInfoLink
Ett JanusInfoLink-objekt innehåller en hypermedia (URL) länk till en litteraturreferens för en
amnings- eller graviditetsvarning från SLL/JanusInfo.
Attribut
url: string
description: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
URL.
Beskrivning av litteraturreferensen.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 78/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.13.14 FassPregnancyDoc
Ett FassPregnancyDoc-objekt innehåller information om en graviditetsvarning från FASS.
Attribut
code: string
nplId: string
spcDate: string
text: string
Varningsklassificering
NPL-id.
Datum för den utgåva av läkemedelsproduktens produktresumé på
vilken FASS-texten och bedömningen av denna varningsklassificering
har baserats.
FASS-avsnittet om graviditet.
4.13.15 FassLactationDoc
Ett FassLactationDoc-objekt innehåller information om en amningsvarning från FASS.
Attribut
code: string
nplId: string
spcDate: string
text: string
Inera AB
Varningsklassificering
NPL-id.
Datum för den utgåva av läkemedelsproduktens produktresumé på
vilken FASS-texten och bedömningen av denna varningsklassificering
har baserats.
FASS-avsnittet om amning.
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 79/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.14 Rekommenderade läkemedel
Tjänsterna används för att hämta information om rekommenderade läkemedel. Informationen
om rekommenderade läkemedel underhålls av de regionala läkemedelskommittéerna.
Rekommenderade läkemedel organiseras i namngivna listor.
I varje rekommenderad läkemedelslista finns en terapigrupps- och indikationshierarki. I denna
hierarki är terapigrupper den övergripande klassificeringen på högsta nivån. Under varje
terapigrupp kan det sedan finnas ett antal olika nivåer av indikationer. Rekommendationer för
läkemedel kan sedan vara angivna på alla indikationsnivåer men aldrig på terapigruppsnivå.
I tjänsterna nedan identifieras en unik indikation av en så kallad indikationsgren. En
indikationsgren identifieras av en unik kombination av terapigrupp och underliggande
namngivna indikationer, ungefär som ett katalognamn i ett filsystem. Exempel:
"Endokrinologi" (Terapigrupp)
"Diabetes mellitus" (Indikation, nivå 1)
"Diabetes mellitus Typ 2" (Indikation, nivå 2)
Den unika indikationen "Diabetes mellitus Typ 2" ovan identifieras av hela indikationsgrenen:
"Endokrinologi", ["Diabetes mellitus", "Diabetes mellitus Typ 2"]
En indikationsgren består således av namnet på en terapigrupp samt en lista av indikationsnamn,
ordnade med högsta nivån först och lägsta nivån sist.
En rekommendation är alltid för en läkemedelsartikel (DrugArticle) och inte för en
läkemedelsprodukt (DistributedDrug). Varje rekommendation tilldelas en nivå 0-3 eller '-'. 1
anger högsta rekommendationsnivå och 3 lägsta. 0 anger icke-rekommenderad och '-' anger
obestämd rekommendationsnivå.
Eftersom stödet för rekommendationslistor i SIL ursprungligen avsågs enbart för för de
regionala läkemedelskommittéernas arbete med rekommendationslistor användes termen region
för rekommendationslistor.
4.14.1
getValidRegions
Returnerar en lista med alla regioner (landsting och landstingsregioner) för vilka det finns
rekommendationslistor. För nationella rekommendations- och anti-rekommendationslistor
används speciella regioner.
Inparametrar
Returtyp
Region [ ]
En lista med Region-objekt som var och en representerar en region.
Exempel
Anropet:
getValidRegions ()
returnerar en lista med Region-objekt.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 80/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.14.2
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getListTypes
Returnerar en lista med alla listtyper.
Inparametrar
Returtyp
ListType [ ]
En lista med ListType-objekt som innehåller information om en
listtyp.
Exempel
Anropet:
getListTypes ()
returnerar en lista med listtyper.
4.14.3
getTherapyGroups
Returnerar en lista med TherapyGroup-objekt med information om terapigrupper.
Inparametrar
regionId: int
Regionid. Använd getValidRegions för att se vilka värden
som kan användas.
listType: int
Listtyp. Använd getListTypes för att se vilka värden som kan
användas.
textFormat: string
Format på texten. Om ”HTML” returneras så XHTML och
om ”” (en tom sträng) så returneras text i ISO-8859-1
format.
retrieveDescription: boolean Anger om hela beskrivningen ska returneras (true) eller inte
(false).
Returtyp
TherapyGroup [ ]
En lista med TherapyGroup-objekt med information om
terapigrupper.
Exempel
Anropet:
getTherapyGroups (1, 1, ””, false)
returnerar en lista med TherapyGroup-objekt för region med regionId = 1 och av listtyp
listType = 1.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 81/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.14.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getIndicationPaths
Returnerar en lista med IndicationPath-objekt med information om indikationsgrenar för angiven
terapigrupp therapyGroup, regionid regionId och listtyp listType.
Inparametrar
therapyGroup: string
En terapigrupp.
Ett regionid.
listType: int
Listtyp
textFormat: string
Format på texten. Om ”HTML” returneras så XHTML och
om ”” (en tom sträng) så returneras text i ISO-8859-1
format.
retrieveDescription: boolean Anger om hela beskrivningen ska returneras (true) eller inte
(false).
regionId: int
Returtyp
IndicationPath
En lista med IndicationPath-objekt med information om
indikationsgrenar.
Exempel
Anropet:
getIndicationPaths (”Psykiatri”, 1, 1, ””, false)
returnerar en lista med IndicationPath-objekt för region med regionId = 1 , therapyGroup =
”Psykiatri” och listtyp listType = 1.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 82/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.14.5
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getIndicationPath
Returnerar ett IndicationPath-objekt med information om indikationsgrenen för angiven
terapigrupp therapyGorup, regionid regionId och listtyp listType.
Inparametrar
recommendedListName: string
therapyGroup: string
indicationsInPath: string []
regionId: int
listType: int
textFormat: string
retrieveDescription: boolean
Namn på en rekommendationslista.
En terapigrupp.
Indikationer som man vill filtrera på.
Ett regionid.
Listtyp
Format på texten. Om ”HTML” returneras så XHTML och
om ”” (en tom sträng) så returneras text i ISO-8859-1
format.
Anger om hela beskrivningen ska returneras ( true) eller
inte (false).
Returtyp
IndicationPath
En lista med IndicationPath-objekt med information om
indikationsgrenar.
Exempel
Anropet:
getIndicationPath("Kloka Listan 2014 maj 1_Baslista", "Endokrinologi",
["Tyroideasjukdomar", "Tyroideahormon"], 1, 1, "", True)
returnerar en lista med IndicationPath-objekt för rekommendationslistan ”Kloka Listan 2014
maj 1_Baslista” (i region med regionid med regionId 1 och med listtyp listType 1) i
terapigruppen ”Endokrinologi” och indikationerna ”Tyroideasjukdomar” och
”Tyroideahormon”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 83/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.14.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getRecommendationsByNplPackIdList
Returnerar ett Recommendation-objekt med information om läkemedelsrekommendationer för
läkemedelsartiklarna med angivna NPL-id nplIds i angiven regionid regionId.
Inparametrar
nplPackIds: string [ ]
regionId: int
listTypes: string [ ]
textFormat: string
retrieveDescription: boolean
En lista med NPL-packid.
Ett regionid.
En lista med listtyper för rekommenderade listor.
Format på texten. Om ”HTML” returneras så XHTML och
om ”” (en tom sträng) så returneras text i ISO-8859-1
format.
Anger om hela beskrivningen ska returneras ( true) eller
inte (false).
Returtyp
Recommendation [ ]
En lista med Recommendation-objekt med information
om en läkemedelsrekommendationer.
Exempel
Anropet:
getRecommendationsByNplPackIdList (["19350101100016", "19670401100012"], 1, 1,
””, false)
returnerar en lista med Recommendation-objekt för läkemedelsartiklarna med angivna
NPL-packid ”19350101100016” och ”19670401100012” i region med regionId = 1.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 84/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.14.7
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getRecommendationsByTherapyGroupIndicationName
Returnerar ett Recommendation-objekt med information om läkemedelsrekommendationer inom
angiven terapigrupp therapyGroup och med angiven indikation indicationName.
Inparametrar
therapyGroup: string
indicatioName: string
regionId: int
listTypes: int [ ]
textFormat: string
retrieveDescription: boolean
En terapigrupp.
En indikation
Ett regionid.
En lista med listtyper för rekommenderade listor.
Format på texten. Om ”HTML” returneras så XHTML och
om ”” (en tom sträng) så returneras text i ISO-8859-1
format.
Anger om hela beskrivningen ska returneras ( true) eller
inte (false).
Returtyp
Recommendation [ ]
En lista med Recommendation-objekt med information
om en läkemedelsrekommendationer.
Exempel
Anropet:
getRecommendationsByTherapyGroupIndicationName ("Endokrinologi",
”Tyroideasjukdomar”, 1, [1], ””, false)
returnerar en lista med Recommendation-objekt om läkemedelsrekommendationer inom
angiven terapigrupp ”Endokrinologi”och med angiven indikation ”Tyroideasjukdomar”.
4.14.8
Region
Ett Region-objekt innehåller information om en region (landsting eller landstingsregion).
Attribut
regionId: string
regionName: string
4.14.9
Regionid.
Regionnamn.
ListType
Ett ListType-objekt innehåller information om en typ av rekommendationslista.
Attribut
listType: string
listTypeText: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Kod för listtyp.
Beskrivning av listtypen.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 85/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.14.10 TherapyGroup
Ett ListType-objekt innehåller information om en terapigrupp.
Attribut
recommendedListName: string
therapyGroup: string
therapyGroupComment: string
therapyGroupDescription: string
therapyGroupLinks: string [ ]
Namn på rekommendationslistan som terapigruppen
ingår i.
Namn på terapigruppen.
Kortare kommentar om terapigruppen.
Längre beskrivning av terapigruppen.
Lista med länkar (URL:ar) till källor till den kortare
kommentaren och den längre beskrivningen av
terapigruppen.
4.14.11 IndicationPath
Ett IndicationPath-objekt innehåller information om indikationsgren.
Attribut
recommendedListName: string
therapyGroup: string
indications: string [ ]
Namn på rekommendationslistan som terapigruppen
ingår i.
Namn på terapigruppen
Lista med indikationer som är ordnade med indikation
som är på högsta nivån först och den indikation som är
på lägsta nivån sist.
4.14.12 Indication
Ett Indication-objekt innehåller information om indikation.
Attribut
indicationName: string
indicationLevel: int
indicationComment: string
indicationDescription: string
indicationLinks: string [ ]
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Indikationens namn.
Indikationens nivå.
Kortare kommentar om indikationen.
Längre beskrivning av indikationen.
Lista med länkar (URL:ar) till källor till den kortare
kommentaren och den längre beskrivningen av
indikationen.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 86/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.14.13 RecommendedListInfo
Ett RecommendedListInfo-objekt innehåller information om rekommenderad lista.
Attribut
listName: string
version: string
responsibleUnit: string
validFrom: string
validTo: string
listType: int
Listans namn.
Version på listan.
Ansvarig förvaltare av listan.
Giltig från datum.
Giltig till datum.
Listans listtypskod.
4.14.14 Recommendation
Ett Recommendation-objekt innehåller information om rekommendation.
Attribut
listName: string
Namn på rekommendationslistan som denna
rekommendation ingår i.
NplPackId: string
NPL-packid för den läkemedelsartikel
rekommendationen gäller.
listType: int
Listtyp för rekommendationslistan som denna
rekommendation ingår i.
comment: string
Kortare kommentar om rekommendationen.
description: string
Längre beskrivning av rekommendationen.
links: string [ ]
Lista med länkar (URL:ar) till källor till den kortare
kommentaren och den längre beskrivningen av
rekommendationen.
recommendationLevel: string
Rekommendationsnivå. Anger om läkemedelsartikeln
är rekommenderad i 1:a, 2:a eller 3:e hand för
angiven terapigrupp och/eller indikation. Giltiga
värden är ”-”, ”0”, ”1”, ”2” och ”3”. Tecknet ”-”
används i betydelsen odefinierad och siffran ”0” i
betydelsen icke-rekommenderad (s.k.
nollrekommendation).
alternatives: identifierValue [ ]
Lista med alternativa hänvisningar för denna
rekommendation speciellt för rekommendationer som
har nivå 0 (s.k. nollrekommendation.
therapyGroup: string
Terapigrupp som denna rekommendation är för.
shortIndications: ShortInteraction [ ] Lista med indikation som är ordnade med indikation
som är på högsta nivån först och den indikation som
är på lägsta nivån sist.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 87/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.14.15 IdentifierValue
Ett IdentifierValue-objekt innehåller information om alternativa klassificeringar av en
läkemedelsrekommendation.
Attribut
identifier: string
value: string
Klassificeringssystem. Giltiga värden är
"preferredAtcCode", "atcCode", "nplPackId", "nplId"
Värde på klassificeringen.
4.14.16 ShortIndication
Ett ShortIndication-objekt innehåller kortfattad information om en indikations namn och den
nivå den är på.
Attribut
indicationName: string
indicationLevel: int
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Namn på indikationen.
Nivå för indikationen.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 88/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.15 Utbytbarhet
Tjänsterna används för att hämta information kring ett läkemedels utbytbarhet.
För att läkemedel ska vara utbytbara ska de ha bedömts som medicinskt likvärdiga av
Läkemedelsverket vad gäller sammanvägd effekt och säkerhet.
Utbytbara läkemedel ska:
•
innehålla samma aktiva beståndsdel(ar) (i vissa fall kan dock olika salter accepteras),
•
ha samma läkemedelsform (undantag gäller för kapslar och tabletter om de har en snabb
upplösning i mag-tarmkanalen),
•
innehålla samma mängd av de aktiva beståndsdelarna och
•
ha motsvarande förpackningsstorlekar (dvs 100 st är utbytbart mot 98 st men 100 st är
inte utbytbart mot 14 st).
Man kan nu även se direkt på en läkemedelsartikel om den är utbytbar genom kontroll av värdet
på fältet interchangeableFlag i DrugArticle-objekt.
Information om läkemedels utbytbarhet finns också i Drug- och i DistributedDrug-objekten.
InterchangeableFlag i Drug-objektet visar övergripande om samtliga tillhörande DistributedDrug
är bedömda av Läkemedelsverket som utbytbara (Y), om ingen av de tillhörande DistributedDrug
är utbytbara (N) eller om enbart vissa är utbytbara (P). Om enbart vissa DistributedDrugs
tillhörande en och samma Drug är utbytbara (P) visar interchangeableFlag (Y/N) i
DistributedDrug-objektet vilka. Förutom interchangeableFlag finns även tre grupperingar för
utbytbarhet i Drug-objektet:
a) substansgrupp (SubstanceGroup).
b) läkemedelsformgrupp (PharmacuticalFormGroup).
c) styrkegrupp (StrengthGroup).
Observera att tjänsterna getDrugsBySubstanceGroupId, getDrugsByPharmaceuticalFormGroupId
och getDrugsByStrengthGroupId returnerar Drug-objekt innehållandes både InterchangeableFlag
Y och P.
De tre grupperna är hierarkiskt uppbyggda, så en viss läkemedelsformsgrupp relaterar endast till
en substansgrupp och en styrkegrupp relaterar endast till en läkemedelsformgrupp. Detta
innebär att styrkegruppen måste överensstämma för att läkemedel ska vara utbytbara.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 89/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.15.1
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getSubstanceGroups
Returnerar en lista med SubstanceGroup-objekt med information om alla substansgrupper.
Inparametrar
Returtyp
SubstanceGroup [ ]
En lista med SubstanceGroup-objekt med information om alla
substansgrupper.
Exempel
Anropet:
getSubstanceGroups ()
returnerar en lista med SubstanceGroup-objekt.
4.15.2
getSubstanceGroupBySubstanceGroupId
Returnerar ett SubstanceGroup-objekt med information om substansgruppen med angivet
substansgruppid substanceGroupId.
Inparametrar
substanceGroupId: string
Substansgruppid.
Returtyp
SubstanceGroup
Ett SubstanceGroup-objekt.
Exempel
Anropet:
getSubstanceGroupBySubstanceGroupId (”1871”)
returnerar en lista med SubstanceGroup-objekt med information om substansgruppen med
substansgruppid-id ”1871”.
4.15.3
getPharmaceuticalFormGroups
Returnerar en lista med PharmaceuticalFormGroup-objekt med information om alla farmaceutiska formgrupper.
Inparametrar
Returtyp
PharmaceuticalFormGroup [ ]
En lista med PharmaceuticalFormGroup-objekt.
Exempel
Anropet:
getPharmaceuticalFormGroups ()
returnerar en lista med PharmaceuticalFormGroup-objekt.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 90/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.15.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getPharmaceuticalFormGroupByPharmaceuticalFormGroupId
Returnerar ett PharmaceuticalFormGroup-objekt med information om den farmaceutiska
formgruppen med angivet farmaceutiskt formgruppid formGroupId.
Inparametrar
formGroupId: string
Farmaceutiskt formgruppid.
Returtyp
PharmaceuticalFormGroup
Ett PharmaceuticalFormGroup-objekt.
Exempel
Anropet:
getSubstanceGroupBySubstanceGroupId (”1871”)
returnerar en lista med PharmaceuticalFormGroup-objekt med information om den
farmaceutiska formgruppen med farmaceutiskt formgruppid ”1871”.
4.15.5
getStrengthGroups
Returnerar en lista med StrengthGroup-objekt med information om alla styrkegrupper.
Inparametrar
Returtyp
StrengthGroup [ ]
En lista med StrengthGroup-objekt.
Exempel
Anropet:
getStrengthGroups ()
returnerar en lista med StrengthGroup-objekt.
4.15.6
getStrengthGroupByStrengthGroupId
Returnerar ett StrengthGroup-objekt med information om den farmaceutiska formgruppen med
angivet farmaceutiskt formgruppid formGroupId.
Inparametrar
strengthGroupId: string
Styrkegruppid.
Returtyp
StrengthGroup
Ett StrengthGroup-objekt.
Exempel
Anropet:
getStrengthGroupByStrengthGroupId (”6450”)
returnerar en lista med StrengthGroup-objekt med information om den styrkegruppen med
styrkegruppid ”6450”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 91/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.15.7
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
SubstanceGroup
Ett SubstansGroup-objekt innehåller information om substansgrupp.
Attribut
substanceGroupId: string
substanceGroupName: string
4.15.8
Substansgruppid.
Substansgruppnamn.
PharmaceuticalFormGroup
Ett SubstansGroup-objekt innehåller information om substansgrupp.
Attribut
hharmaceuticalFormGroupId: string
hharmaceuticalFormGroupName:
string
4.15.9
Farmaceutiskt formgruppid.
Farmaceutiskt formgruppnamn.
StrengthGroup
Ett SubstansGroup-objekt innehåller information om substansgrupp.
Attribut
strengthGroupId: string
strengthGroupName: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Styrkegruppid.
Strykegruppnamn.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 92/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.16 Ingredienser och substanser
Dessa tjänster kan användas för att hämta information om ingredienser och substanser i
läkemedelsprodukter. Begreppet ingrediens avser en viss mängd av en substans i en viss
läkemedelsprodukt.
Varje läkemedelsprodukt (DistributedDrug) har en eller flera aktiva substanser. Information om
substanser i en läkemedelsprodukt (DistributedDrug) omfattar också vilken roll de namngivna
substanserna har i läkemedelsprodukten. Det finns två roller en namngiven substans kan ha;
aktiv (ACTI) och aktiv respondent (ARES). Alla läkemedelsprodukter har minst en namngiven
substans som har rollen aktiv (ACTI).
Substanser kan finnas i läkemedel i form av olika salter eller andra föreningar, t.ex. estrar,
hydrater och solvat. Man brukar beskriva relationen mellan en substans och samma substans i
en salt eller annan förening som en mor-dotter relation, där substansen i ren form kallas
modersubstans och substansen i form av ett salt kallas dottersubstans. En modersubstans kan ha
en eller flera dottersubstanser. En dottersubstans kan ha flera modersubstanser.
En substans som har rollen aktiv respondent (ARES) motsvarar oftast en så kallad
modersubstans och dottersubstans har oftast rollen aktiv (ACTI), men det finns undantag. I
kombinationspreparat (läkemedelsprodukter) kan det finnas flera modersubstanser och/eller
dottersubstanser angivna.
Både modersubstans och dottersubstans kan sägas vara verksamma ämnen i kroppen. Det är
dock oftast modersubstansen som är intressant ur ett medicinskt perspektiv. Ett exempel är:
fenoterol
som är modersubstans till dottersubstansen:
fenoterolhydrobromid
Denna senare substans, fenoterolhydrobromid, är alltså det ämne som ingår i läkemedelsprodukten Berotec® (denna produkt avregistrerades 1 maj 2009). Det är dock intressantare att
tala om substansen fenoterol som det verksamma ämnet i kroppen. Detta anges också för
produkten genom att dottersubstansen fenoterolhydrobromid anges som den aktiva (ACTI)
substansen men modersubstansen fenoterol anges som aktiv respondent (ARES).
I beslutsstödssystem inom vården är det oftast mest intressant att visa modersubstansen i en
läkemedelsprodukt, om det finns angivet, och inte dess dottersubstans. Alltså med exemplet
ovan; hellre visa att läkemedlet innehåller fenoterol än fenoterolhydrobromid. För vissa
läkemedelsprodukter finns bara en substans med rollen ACTI angivet och då är det givetvis den
substansen som är den intressanta att visa i beslutsstödsystem.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 93/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.16.1
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getSubstancesByNplSubstanceIdList
Returnerar en lista med Substance-objekt med information om substanserna med angivna NPLsubstansid nplSubstanceIds.
Inparametrar
nplSubstanceIds: string [ ]
En lista med NPL-substansid.
Returtyp
Substance [ ]
En lista med Substance-objekt.
Exempel
Anropet:
getSubstancesByNplSubstanceIdList ([”IDE4POEWUAJJEVERT1”,
”IDE4POEIUA926VERT1”])
returnerar en lista med Substance-objekt för substanserna med NPL-substansid
”IDE4POEWUAJJEVERT1” och ”IDE4POEIUA926VERT1”.
4.16.2
getSubstancesBySubstanceName
Returnerar en lista med Substance-objekt med information om substanserna med NPL
substansnamn som matchar substanceName.
Inparametrar
substanceName: string
En hel eller en del av ett substansnamn. Wildcard-tecken
'%' är tillåtet i strängen.
Returtyp
Substance [ ]
En lista med Substance-objekt.
Exempel
Anropet:
getSubstancesBySubstanceName (”Diklofenak%”)
returnerar en lista med Substance-objekt för substanser med substansnamn som börjar
med ”Diklofenak”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 94/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.16.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDistributedDrugContentsByNplIdList
Returnerar en lista med DistributedDrugContent-objekt med information om substanserna i
läkemedelsprodukterna med angivna NPL-id.
Inparametrar
nplIds: string [ ]
En lista med NPL-id.
Returtyp
DistributedDrugContent [ ]
En lista med DistributedDrugContent-objekt.
Exempel
Anropet:
getDistributedDrugContentsByNplIdList ([”19941017000028”])
returnerar en lista med DistributedDrugContent-objekt med information om substanserna i
läkemedelsprodukten med NPL-id ”19941017000028”.
4.16.4
getDistributedDrugContentsByNplIdListFiltered
Returnerar en lista med DistributedDrugContent-objekt med information om substanserna i
läkemedelsprodukterna med angivna NPL-id (med möjlighet att filtrera bort dottersubstanser).
Inparametrar
nplIds: string [ ]
parentSubstancesOnly: boolean
En lista med NPL-id.
Med denna inparameter kan man filtrera bort
dottersubstanser vars modersubstans ingår i produkten.
Denna tjänst är lämplig för system som i ett
användargränssnitt enbart vill visa information om
modersubstanser för en läkemedelsprodukt.
Returtyp
DistributedDrugContent [ ]
En lista med DistributedDrugContent-objekt.
Exempel
Anropet:
getDistributedDrugContentsByNplIdListFiltered ([”19941017000028”], False)
returnerar en lista med DistributedDrugContent-objekt med information om substanserna i
läkemedelsprodukten med NPL-id ”19941017000028”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 95/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.16.5
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Substance
Ett Substance-objekt representerar en substans.
Attribut
substanceName: string
nplSubstanceId: string
casNo: string
children: string [ ]
parents: string [ ]
4.16.6
Officiellt svenskt namn enligt NSL.
NPL substansid. Detta är en unikt och tidsbeständigt
identifierare för substanser och används både i NPL
och i NSL.
CAS nummer. Detta är substansens CAS nummer.
CAS nummer är unika numeriska identifierare för
substanser och de förvaltas av Chemical Abstracts
Service (CAS), en avdelning av The American
Chemical Society. De används ofta vid
litteratursökning på substansinformation. Se:
http://www.cas.org
Dottersubstanser. En tom lista innebär att det inte finns
några dottersubstanser till denna substans.
Modersubstanser. En tom lista innebär att det inte finns
några modersubstanser till denna substans.
DistributedDrugContent
Ett DistributedDrugContents-objekt innehåller information om beståndsdelar i en
läkemedelsprodukt.
Attribut
nplId: string
description: string
compRefQuantityCode: string
ingredients: Ingredient [ ]
4.16.7
NPL-id.
Beskrivning.
Kod som representerar den enhet till vilken
ingrediensens mängd refererar.
En lista med ingredient-objekt.
Ingredient
Ett Ingredient-objekt innehåller information om substanserna i en läkemedelsprodukt.
Attribut
nplSubstanceId: string
constituent: string
ingredientRoleCode: string
alternativeQuantityUnitCode: string
quantity: float
quantityUnitCode: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
NPL-substansid.
Substansnamn.
Kod som anger typ av beståndsdel.
Kod som representerar tillägg till mängdenhet.
Mängd.
Kod som representerar mängdenhet.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 96/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.17 Kortnotationer
Det finns en tjänst för kortnotationer och den används för att generera en doseringsanvisning
givet en viss doseringskortform och doseringsenhet.
4.17.1
getShortEncDosageTranslation
Returnerar en doseringsanvisning givet en kortnotation, en doseringsenhet i singular och plural
samt en obestämd artikel för doseringsenheten.
Inparametrar
shortEncDosage: string
dosageUnit: string
dosageUnitPlural: string
DosageUnitIndefinite: string
Kortnotation.
Doseringsenhet.
Pluralform av doseringsenhet.
Obestämd artikel för doseringsenhet.
Returtyp
string
Doseringsanvisning.
Exempel
Anropet:
getShortEncDosageTranslation (”1+1+1+2”, ”tablett”, ”tabletter”, ”en”)
returnerar en sträng med doseringsanvisningen ”1 tablett till frukost, 1 tablett till lunch, 1
tablett till middag, 2 tabletter till natten”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 97/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.18 Utsättningsorsaker
Det finns en tjänst och den används för att få tillgång till utsättningsorsaker. Detta är en mindre
datakälla som förvaltas av SIL och som innehåller ett antal etablerade och vanligt använda
utsättningsorsaker.
4.18.1
getTreatmentWithdrawalReasons
Returnerar en lista med TreatmentWithdrawalReason-objekt med information om alla
utsättningsorsaker.
Inparametrar
Returtyp
TreatmentWithdrawalReason [ ]
En lista med utsättningsorsaker.
Exempel
Anropet:
getTreatmentWithdrawalReasons ()
returnerar en lista med utsättningsorsaker.
4.18.2
TreatmentWithdrawalReason
Ett TreatmentWithdrawalReason-objekt representerar en utsättningsorsak.
Attribut
shortText: string
longText: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Kortfattad form av utsättningsorsak.
Längre beskrivning av utsättningsorsaken.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 98/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.19 Läkemedelsföretag
Dessa tjänster kan användas för att hämta information om läkemedelsföretag. T.ex. vilket
företag som innehar registreringsgodkännande (marketing authorization holder, MAH) eller
vilket företag som är försäljningsrepresentant för en läkemedelsprodukt.
4.19.1
getDistributedDrugOrganizationsByNplIdList
Returnerar en lista med DistributedDrugOrganizations-objekt som innehåller information om
företagen som är registrerade för läkemedelsprodukterna med angivna NPL-id nplIds.
Inparametrar
nplIds: string [ ]
Ett lista med NPL-id.
Returtyp
DistributedDrugOrganizations [ ]
En lista med DistributedDrugOrganizations-objekt.
Exempel
Anropet:
getDistributedDrugOrganizationsByNplIdList (["20130603014075"])
returnerar en lista med DistributedDrugOrganizations-objekt med information om företagen
som är registrerade för läkemedelsprodukten med NPL-id ”20130603014075”.
4.19.2
getDrugArticleOrganizationsByNplPackIdList
Returnerar en lista med DistributedDrugOrganizations-objekt som innehåller information om
företagen som är registrerade för läkemedelsartiklarna med angivna NPL-id nplPackIds.
Inparametrar
nplPackIds: string [ ]
Ett lista med NPL-packid.
Returtyp
DrugArticleOrganizations [ ]
En lista med DrugArticleOrganizations-objekt.
Exempel
Anropet:
getDrugArticleOrganizationsByNplPackIdList (["20110308100020"])
returnerar en lista med DrugArticleOrganizations-objekt med information om företagen
som är registrerade för läkemedelsartikeln med NPL-packid ”20110308100020”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 99/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.19.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
DistributedDrugOrganizations
Ett DistributedDrugOrganizations-objekt innehåller information om vilka företag är registrerade
för en viss läkemedelsprodukt.
Attribut
nplId: string
roleOrganizations:
RoleOrganizations [ ]
4.19.4
NPL-id.
En lista med information om företag och deras roller
DrugArticleOrganizations
Ett DrugArticleOrganizations-objekt innehåller information om vilka företag som är registrerade
för en viss läkemedelsartikel.
Attribut
nplPackId: string
roleOrganizations:
RoleOrganizations [ ]
4.19.5
NPL-packid.
En lista med information om företag och deras roller
RoleOrganization
Ett RoleOrganizations-objekt innehåller information om ett företag och dess roll och är alltid en
del av ett DistributedDrugOrganizations-objekt eller DrugArticleOrganizations-objekt.
Attribut
organization: Organization
roleCode: string
4.19.6
Företag.
Kod för företagets roll. Använd
getOrganizationRoleByCode för att en beskrivning av
rollen på svenska.
Organization
Ett organization-objekt innehåller information om ett företag.
Attribut
extId: string
Externt id för företaget. Detta är ej garanterat
tidsbeständigt.
Namn på företaget.
name: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 100/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.20 Handelsvaror (icke-läkemedel)
Tjänsterna används för att hämta information om handelsvaror som som inte är läkemedel, som
förbrukningsartiklar och prisnedsatta livsmedel, och som ingår i TLV:s förmån.
De flesta av tjänsterna nedan tar en inparametrar flgCurrent som har följande syfte.
flgCurrent: boolean
4.20.1
Anger att enbart information om handelsvaror som är tillgängliga för
förskrivning (true) eller inte (false) ska returneras.
getNonDrugArticlesByArticleName
Returnerar en lista med NonDrugArticle-objekt med angivet artikelnamn articleName.
Inparametrar
articleName: string
flgCurrent: boolean
En hel eller en del av ett artikelnamn. Wildcard-tecken
'%' är tillåtet i strängen.
Se kapitlets inledning.
Returtyp
NonDrugArticle [ ]
En lista med NonDrugArticle-objekt.
Exempel
Anropet:
getNonDrugArticlesByArticleName ("%silikon%", False)
returnerar en lista med NonDrugArticle-objekt för handelsvaror med artikelnamn som
innehåller ”silikon”.
4.20.2
getNonDrugArticlesByProductGroupCode
Returnerar en lista med NonDrugArticle-objekt med angiven produktgruppkod
productGroupCode.
Inparametrar
productGroupCode: string
flgCurrent: boolean
En produktgruppkod. Wildcard-tecken '%' är tillåtet i
strängen.
Se kapitlets inledning.
Returtyp
NonDrugArticle [ ]
En lista med NonDrugArticle-objekt.
Exempel
Anropet:
getNonDrugArticlesByProductGroupCode ("Y85AB%", False)
returnerar en lista med NonDrugArticle-objekt för handelsvaror med produktgruppkod
”Y82BB00”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 101/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.20.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getNonDrugArticlesByArticleNoList
Returnerar en lista med NonDrugArticle-objekt för handelsvaror med angivna artikelnummer
articleNos.
Inparametrar
articleNos: string []
flgCurrent: boolean
En lista med artikelnummer.
Se kapitlets inledning.
Returtyp
NonDrugArticle [ ]
En lista med NonDrugArticle-objekt.
Exempel
Anropet:
getNonDrugArticlesByArticleNoList (["733801", "733800"], False)
returnerar en lista med NonDrugArticle-objekt för handelsvaror med artikelnummer
”733801” och ”733800”.
4.20.4
NonDrugArticle
Ett NonDrugArticle-objekt innehåller information om en handelsvara.
Attribut
companySupplierName: string
articleNo: string
articleName: string
productDescription: string
sizeNum: float
sizeUnit: string
sizeText: string
strengthText: string
packDescription: string
expirationDate: string
isStopped: boolean
articleGroupCode: string
productGroupCode: string
assortmentCode: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Leverantör eller distributör.
Nordiskt varunummer. Det är en sträng med sex siffror
och alltid med inledande 0:or om det behövs.
Handelsvarans namn.
Beskrivning av handelsvaran.
Förpackningsantal.
Förpackningsenhet.
Förpackningsantal och enhet i klartext.
Alfanumerisk styrketext.
Beskrivning av förpackning.
Datum då handelsvaran utgår.
Anger om handelsvaran är orderstoppad.
Gruppkod för handelsvaruartikel. Detta är en klassificering i fem nivåer som TLV gör av handelsvaruartiklar. Sätts alltid till tom i nuläget.
Gruppkod för handelsvaruprodukt. Detta är en klassificering i fem nivåer som TLV gör av handelsvaruprodukter.
SIL kod som ersätter Apotekets gamla sortkod. Följande
koder finns:
AL = Teknisk sprit.
PL = Förskrivningsbara livsmedelsartiklar, 0-16 år.
FO = Annat förskrivningsbart.
TJ = Förskrivningsbara tjänster.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 102/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
isPrescriptionRequired: boolean
isReimbursed: boolean
aup: float
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
Anger om handelsvaran är receptbelagd.
Anger om handelsvaran ingår i förmånen.
Anger förmånspris på handelsvaran.
4.21 Söktjänster för läkemedelsidentifierare
Dessa tjänster möjliggör sökning baserat på olika läkemedelsidentifierare. Notera att de enda
läkemedelsidentifierare som är garanterat unika och tidsbeständiga är NPL-id och NPL-packid
som hanteras och publiceras av Läkemedelsverket via NPL. I SIL finns läkemedelsidentifieraren drug-id som baseras på NPL-id för originalläkemedelsprodukten för en grupp av
parallellimporter, men den ska inte användas som tidsbeständigt id i system utanför SIL.
4.21.1
getNplPackIdsByArticleNoList
Returnerar en lista med IdPair-objekt med NPL-packid:n för läkemedelsartiklarna med angivna
varunummer articleNos.
Inparametrar
articleNos: string []
En lista med artikelnummer.
Returtyp
IdPair [ ]
En lista med IdPair-objekt.
Exempel
Anropet:
getNplPackIdsByArticleNoList (["067680", "036700"])
returnerar en lista med IdPair-objekt med NPL-packid:n för läkemedelsartiklar med
varunummer ”067680” och ”036700”.
4.21.2
getNplIdsBySemanoList
Returnerar en lista med IdPair-objekt med NPL-packid:n för läkemedelsprodukterna med
angivna godkännandenummer semanos.
Inparametrar
semanos: string []
En lista med godkännandenummer för svenska
läkemedelsprodukter.
Returtyp
IdPair [ ]
En lista med IdPair-objekt.
Exempel
Anropet:
getNplIdsBySemanoList (["113760", "123610"])
returnerar en lista med IdPair-objekt med NPL-packid:n för läkemedelsprodukterna med
svenska godkännandenummer ”113760” och ”123610”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 103/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Senast ändrad
2015-04-14
Sid 104/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.21.3
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getDrugIdsBySemanoList
Returnerar en lista med IdPair-objekt med drugId för läkemedelsprodukterna med angivna
godkännandenummer för svenska läkemedelsprodukter semanos.
Inparametrar
semanos: string []
En lista med godkännandenummer för svenska
läkemedelsprodukter.
Returtyp
IdPair [ ]
En lista med IdPair-objekt.
Exempel
Anropet:
getDrugIdsBySemanoList (["113760", "123610"])
returnerar en lista med IdPair-objekt med drugId för läkemedelsprodukter med svenska
godkännandenummer ”113760” och ”123610”.
4.21.4
getSemanosByNplIdList
Returnerar en lista med IdPair-objekt med svenska godkännandenummer för läkemedelsprodukterna med angivna Npl-id nplIds.
Inparametrar
nplIds: string []
En lista med NPL-id.
Returtyp
IdPair [ ]
En lista med IdPair-objekt.
Exempel
Anropet:
getSemanosByNplIdList (["19941017000028", "19941017000028"])
returnerar en lista med IdPair-objekt med svenska godkännandenummer för
läkemedelsprodukter med NPL-id ”19941017000028” och ”19941017000028”.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 105/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.21.5
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getSemanosByDrugIdList
Returnerar en lista med IdPair-objekt med svenska godkännandenummer för läkemedelsprodukterna med angivna drugds.
Inparametrar
drugIds: string []
En lista med drugId.
Returtyp
IdPair [ ]
En lista med IdPair-objekt.
Exempel
Anropet:
getSemanosByNplIdList (["19941017000028", "19941017000028"])
returnerar en lista med IdPair-objekt med svenska godkännandenummer för
läkemedelsprodukter med drugId ”19941017000028” och ”19941017000028”.
4.21.6
IdPair
Ett IdPair-objekt innehåller information om två olika id.
Attribut
insertedId: string
returnedId: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Identifierar det id man sökt med i tjänsterna ovan.
Identifierar det id man sökt efter i tjänsterna ovan.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 106/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.22 Tjänster för samlad läkemedelsinformation (supertjänster)
Tjänsterna för samlad läkemedelsinformation utgörs av tjänster som kan användas för att hämta
all information som finns i Drug-, DistributedDrug- och DrugArticle-objekt om en eller flera
läkemedelsprodukter samtidigt och med ett anrop. Objekten som returneras kallas SuperDrugobjekt. Dessa tjänster syftar till att bespara klienter flera separata anrop mot andra tjänster i SIL
SOAP API.
De flesta av tjänsterna nedan tar två inparametrar; flgCurrent och regionId. De har följande syfte.
flgCurrent: boolean
regionId: int
4.22.1
Anger att information om enbart parallellimporterna som har minst
en läkemedelsartikel som är tillgänglig (true), eller om alla (false),
parallellimporter ska returneras.
Anger vilka rekommenderade läkemedelslistor sökningen ska ske
mot. Om regionId = -1 så sker sökningen mot alla parallellimporter
oavsett vilka rekommendationslistor de ingår i.
getSuperDrugsByDistributedDrugTradeName
Returnerar en lista med SuperDrug-objekt med information om läkemedelsprodukter som har
silProductGroupType = APPROVED och angivet handelsnamn tradeName.
Inparametrar
tradeName: string
flgCurrent: boolean
regionId: int
En hel eller en del av ett handelsnamn. Strängen får vara maximalt
åtta (8) tecken långt. Wildcard-tecken '%' är tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
getSuperDrugsByDistributedDrugTradeName ("Aspirin", False, -1)
returnerar all information om läkemedelsprodukten med handelsnamnet ”Aspirin” oavsett
om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 107/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.22.2
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getSuperDrugsByDrugIdList
Returnerar en lista med SuperDrug-objekt med information om läkemedelsprodukterna med
angivna drugIds.
Inparametrar
drugIds: string [ ]
flgCurrent: boolean
regionId: int
En lista av strängar med drugId.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
GetSuperDrugsByDrugIdList ("19350131000010", False, -1)
returnerar all information om läkemedelsprodukten med drugId ”19350131000010”
oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista de ingår i.
4.22.3
getSuperDrugsByNplIdList
Returnerar en lista med SuperDrug-objekt med information om läkemedelsprodukterna med
angivna NPL-id nplIds.
Inparametrar
nplIds: string [ ]
flgCurrent: boolean
regionId: int
En lista av strängar med NPL-id.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
getSuperDrugsByNplIdList (["19980320000080”, ”19911025000020"], False, -1)
returnerar all information om läkemedelsprodukten med NPL-id ”19980320000080” och
”19911025000020” oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken
rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 108/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.22.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getSuperDrugsByAtcCodeList
Returnerar en lista med SuperDrug-objekt med information om läkemedelsprodukter med
angivna ATC-koder atcCodes.
Inparametrar
atcCodes: string [ ]
flgCurrent: boolean
regionId: int
En lista av strängar med ATC-koder.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
getSuperDrugsByAtcCodeList (["C08CA02”, ”N02AB01"], False, -1)
returnerar all information om läkemedelsprodukterna med ATC-koderna ”C08CA02” och
”N02AB01” oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken
rekommenderad läkemedelslista de ingår i.
4.22.5
getSuperDrugsByAtcTextSv
Returnerar en lista med de SuperDrug-objekt med information om läkemedelsprodukter som har
en beskrivande ATC-text som matchar den angivna svenska texten atcTextSv.
Inparametrar
atcTextSv: string
flgCurrent: boolean
regionId: int
Textsträng på svenska. Wildcard-tecken '%' är tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
getSuperDrugsByAtcTextSv ("%receptorblockerare%", False, -1)
returnerar all information om läkemedelsprodukterna som har en ATC-text som innehåller
”receptorblockerare” oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken
rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 109/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.22.6
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getUnauthorisedSuperDrugsByDistributedDrugTradeName
Returnerar en lista med SuperDrug-objekt med information om icke-godkända
läkemedelsprodukter som har angivet handelsnamn tradeName.
Inparametrar
tradeName: string
flgCurrent: boolean
regionId: int
silProductTypeGroup:
string
En hel eller en del av ett handelsnamn. Strängen får vara maximalt
åtta (8) tecken långt. Wildcard-tecken '%' är tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
SIL produkttypsgrupp. Giltiga värden är ”NON_APPROVED”och
”TRADITIONAL ”.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
getUnauthorisedSuperDrugsByDistributedDrugTradeName (”Paracetamol”, False, -1,
”NON_APPROVED”)
returnerar all information om läkemedelsprodukten med handelsnamnet ”Paracetamol”
oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken rekommenderad
läkemedelslista de ingår i.
4.22.7
getUnauthorisedSuperDrugsByAtcCodeList
Returnerar en lista med SuperDrug-objekt med information om icke-godkända
läkemedelsprodukter som har angivna ATC-koder atcCodes.
Inparametrar
atcCodes: string [ ]
flgCurrent: boolean
regionId: int
silProductTypeGroup:
string
En lista med strängar som innehåller ATC-koder.
Se kapitlets inledning.
Se kapitlets inledning.
SIL produkttypsgrupp. Giltiga värden är ”NON_APPROVED”och
”TRADITIONAL ”.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
getUnauthorisedSuperDrugsByAtcCodeList ([”C08CA02”, ”N02AB01”], False, -1,
”NON_APPROVED”)
returnerar all information om läkemedelsprodukterna med ATC-koderna "C08CA02" och
"N02AB01" oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken
rekommenderad läkemedelslista de ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 110/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.22.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getUnauthorisedSuperDrugsByAtcTextSv
Returnerar en lista med de SuperDrug-objekt med information om icke-godkända
läkemedelsprodukter som har en beskrivande ATC-text som matchar den angivna svenska texten
atcTextSv.
Inparametrar
atcTextSv: string
flgCurrent: boolean
regionId: int
silProductTypeGroup:
string
Textsträng på svenska. Wildcard-tecken '%' är tillåtet i strängen.
Se kapitlets inledning.
Se kapitlets inledning.
SIL produkttypsgrupp. Giltiga värden är ”NON_APPROVED”och
”TRADITIONAL ”.
Returtyp
SuperDrug [ ]
Lista med SuperDrug-objekt.
Exempel
Anropet:
getUnauthorisedSuperDrugsByAtcTextSv (”%beta%”, False, -1, ”NON_APPROVED”)
returnerar all information om läkemedelsprodukterna med ATC-texter som innehåller
”beta” oavsett om de har tillgängliga läkemedelsartiklar och oavsett vilken
rekommenderad läkemedelslista de ingår i.
4.22.9
getSuperDrugArticlesByNplPackIdList
Returnerar en lista med de SuperDrug-objekt med information om icke-godkända
läkemedelsprodukter som har läkemedelsartiklar med angivna NPL-packid:n nplPackIds.
Inparametrar
nplPackIds: string [ ]
flgCurrent: boolean
regionId: int
Lista med strängar som innehåller NPL-packid.
Se kapitlets inledning.
Se kapitlets inledning.
Returtyp
SuperDrugArticle [ ]
Lista med SuperDrugArticle-objekt.
Exempel
Anropet:
getSuperDrugArticlesByNplPackIdList ([”20130603100150”], False, -1,
”NON_APPROVED”)
returnerar all information om läkemedelsprodukten med läkemedelsartikeln med NPLpackid ”20130603100150” oavsett om den är tillgänglig och oavsett vilken
rekommenderad läkemedelslista den ingår i.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 111/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.22.10 SuperDrug
En SuperDrug-objekt innehåller följande attribut.
Attribut
drug: Drug
distributedDrugs:
DistributedDrugs [ ]
atcs: Atc [ ]
Den generella och gemensamma informationen om en
grupp av parallellimporter.
Alla läkemedelsprodukter som ingår i gruppen av
parallellimporter.
Alla ATC-koder som är registrerade för
läkemedelsprodukterna.
4.22.11 SuperDrugArticle
En SuperDrugArticle-objekt innehåller följande attribut.
Attribut
drug: Drug
Den generella och gemensamma informationen om en
grupp av parallellimporter.
distributedDrug: DistributedDrug Läkemedelsprodukten i läkemedelsartikeln.
atcs: Atc [ ]
Alla ATC-koder som är registrerade för
läkemedelsprodukten.
DrugArticle: DrugArticle
Läkemedelsartikeln
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 112/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23 Referensdatatjänster
Tjänsterna används för att hämta information om olika koder och referensinformation i SIL
SOAP API. Samtliga objekt som returneras av dessa tjänster har följande attribut.
Attribut
code: string
Kod.
Beskrivande text på svenska.
Beskrivande text på engelska.
textSv: string
textEn: string
4.23.1
getDrugClassifications
Returnerar en lista av DrugClassification-objekt.
Inparametrar
Returtyp
DrugClassification [ ]
Lista med DrugClassification-objekt.
Exempel
4.23.2
getDrugClassificationByCode
Returnerar ett DrugClassification-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
DrugClassification
Ett DrugClassification-objekt.
Exempel
4.23.3
getControlClasses
Returnerar en lista av ControlClass-objekt.
Inparametrar
Returtyp
ControlClass [ ]
Lista med ControlClass-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 113/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.23.4
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getControlClassByCode
Returnerar ett ControlClass-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
ControlClass
Ett ControlClass-objekt.
Exempel
4.23.5
getRouteOfAdministrations
Returnerar en lista av RouteOfAdministration-objekt.
Inparametrar
Returtyp
RouteOfAdministration [ ]
Lista med RouteOfAdministration-objekt.
Exempel
4.23.6
getRouteOfAdministrationByCode
Returnerar ett RouteOfAdministration-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
RouteOfAdministration
Ett RouteOfAdministration-objekt.
Exempel
4.23.7
getPrescribers
Returnerar en lista av Prescriber-objekt.
Inparametrar
Returtyp
Prescriber [ ]
Lista med Prescriber-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 114/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
4.23.8
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
getPrescriberByCode
Returnerar ett Prescriber-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
Ett Prescriber-objekt.
Prescriber
Exempel
4.23.9
getProductTypes
Returnerar en lista av ProductType -objekt.
Inparametrar
Returtyp
ProductType [ ]
Lista med ProductType-objekt.
Exempel
4.23.10 getProductTypeByCode
Returnerar ett ProductType -objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
Ett ProductType -objekt.
ProductType
Exempel
4.23.11 getPrescriptions
Returnerar en lista av Prescription-objekt.
Inparametrar
Returtyp
Prescription [ ]
Lista med Prescription-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 115/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.12 getPrescriptionByCode
Returnerar ett Prescription-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
Ett Prescription-objekt.
Prescription
Exempel
4.23.13 getStrengthNumericUnits
Returnerar en lista av StrengthNumericUnit-objekt.
Inparametrar
Returtyp
StrengthNumericUnit [ ]
Lista med StrengthNumericUnit-objekt.
Exempel
4.23.14 getStrengthNumericUnitByCode
Returnerar ett StrengthNumericUnit-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
StrengthNumericUnit
Ett StrengthNumericUnit-objekt.
Exempel
4.23.15 getOrganizationRoles
Returnerar en lista av OrganizationRole-objekt.
Inparametrar
Returtyp
OrganizationRole [ ]
Lista med OrganizationRole-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 116/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.16 getOrganizationRoleByCode
Returnerar ett OrganizationRole-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
OrganizationRole
Ett OrganizationRole-objekt.
Exempel
4.23.17 getCountries
Returnerar en lista av Country-objekt.
Inparametrar
Returtyp
Country [ ]
Lista med Country-objekt.
Exempel
4.23.18 getCountryByCode
Returnerar ett Country-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
Ett Country-objekt.
Country
Exempel
4.23.19 getDosdispLifeUnits
Returnerar en lista av DosdispLifeUnit-objekt.
Inparametrar
Returtyp
DosdispLifeUnit [ ]
Lista med DosdispLifeUnit-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 117/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.20 getDosdispLifeUnitByCode
Returnerar ett DosdispLifeUnit-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
DosdispLifeUnit
Ett DosdispLifeUnit-objekt.
Exempel
4.23.21 getPackageTypeInners
Returnerar en lista av PackageTypeInner-objekt.
Inparametrar
Returtyp
PackageTypeInner [ ]
Lista med PackageTypeInner-objekt.
Exempel
4.23.22 getPackageTypeInnerByCode
Returnerar ett PackageTypeInner-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
PackageTypeInner
Ett PackageTypeInner-objekt.
Exempel
4.23.23 getPackConditions
Returnerar en lista av PackCondition-objekt.
Inparametrar
Returtyp
PackCondition [ ]
Lista med PackCondition-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 118/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.24 getPackConditionByCode
Returnerar ett PackCondition-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
Ett PackCondition-objekt.
PackCondition
Exempel
4.23.25 getStorageTemps
Returnerar en lista av StorageTemp-objekt.
Inparametrar
Returtyp
StorageTemp [ ]
Lista med StorageTemp-objekt.
Exempel
4.23.26 getStorageTempByCode
Returnerar ett StorageTemp-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
StorageTemp
Ett StorageTemp-objekt.
Exempel
4.23.27 getSalesRestrictions
Returnerar en lista av SalesRestriction-objekt.
Inparametrar
Returtyp
SalesRestriction [ ]
Lista med SalesRestriction-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 119/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.28 getSalesRestrictionByCode
Returnerar ett SalesRestriction-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
SalesRestriction
Ett SalesRestriction-objekt.
Exempel
4.23.29 getPackSizeNumericUnits
Returnerar en lista av PackSizeNumericUnit-objekt.
Inparametrar
Returtyp
PackSizeNumericUnit [ ]
Lista med PackSizeNumericUnit-objekt.
Exempel
4.23.30 getPackSizeNumericUnitByCode
Returnerar ett PackSizeNumericUnit-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
PackSizeNumericUnit
Ett PackSizeNumericUnit-objekt.
Exempel
4.23.31 getShelfLifeUnits
Returnerar en lista av ShelfLifeUnit-objekt.
Inparametrar
Returtyp
ShelfLifeUnit [ ]
Lista med ShelfLifeUnit-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 120/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.32 getShelfLifeUnitByCode
Returnerar ett ShelfLifeUnit-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
Ett ShelfLifeUnit-objekt.
ShelfLifeUnit
Exempel
4.23.33 getStorageConditions
Returnerar en lista av StorageCondition-objekt.
Inparametrar
Returtyp
StorageCondition [ ]
Lista med StorageCondition-objekt.
Exempel
4.23.34 getStorageConditionByCode
Returnerar ett StorageCondition-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
StorageCondition
Ett StorageCondition-objekt.
Exempel
4.23.35 getIngredientRoles
Returnerar en lista av IngredientRole-objekt.
Inparametrar
Returtyp
IngredientRole [ ]
Lista med IngredientRole-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 121/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.36 getIngredientRoleByCode
Returnerar ett IngredientRole-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
Ett IngredientRole-objekt.
IngredientRole
Exempel
4.23.37 getQuantityUnits
Returnerar en lista av QuantityUnit-objekt.
Inparametrar
Returtyp
QuantityUnit [ ]
Lista med QuantityUnit-objekt.
Exempel
4.23.38 getQuantityUnitByCode
Returnerar ett QuantityUnit-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
QuantityUnit
Ett QuantityUnit-objekt.
Exempel
4.23.39 getAlternativeQuantityUnits
Returnerar en lista av AlternativeQuantityUnit-objekt.
Inparametrar
Returtyp
AlternativeQuantityUnit [ ]
Lista med AlternativeQuantityUnit-objekt.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 122/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.40 getAlternativeQuantityUnitByCode
Returnerar ett AlternativeQuantityUnit-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
AlternativeQuantityUnit
Ett AlternativeQuantityUnit-objekt.
Exempel
4.23.41 getCompRefQuantities
Returnerar en lista av CompRefQuantity-objekt.
Inparametrar
Returtyp
CompRefQuantity [ ]
Lista med CompRefQuantity-objekt.
Exempel
4.23.42 getCompRefQuantityByCode
Returnerar ett CompRefQuantity-objekt med angiven kod code.
Inparametrar
code: string
En kod.
Returtyp
CompRefQuantity
Ett CompRefQuantity-objekt.
Exempel
4.23.43 getSILProductTypeGroups
Returnerar en lista av strängar med SIL:s produkttypsgrupper.
Inparametrar
Returtyp
string [ ]
Lista med strängar som innehåller SIL:s produkttypsgrupper.
Exempel
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 123/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.44 DrugClassification
Anger klassificering enligt receptkungörelsens klassifikation av särskilda läkemedel.
Se kapitlets inledning för attribut i detta objekt.
4.23.45 ControlClass
Anger narkotikaklassificering.
Se kapitlets inledning för attribut i detta objekt..
4.23.46 RouteOfAdministration
Beskriver vilken väg och på vilket sätt ett läkemedel är avsett att administreras.
Se kapitlets inledning för attribut i detta objekt.
4.23.47 Prescriber
Anger anger vem som har förskrivningsrätt.
Se kapitlets inledning för attribut i detta objekt.
4.23.48 ProductType
Anger produkttyp.
Se kapitlets inledning för attribut i detta objekt.
4.23.49 Prescription
Anger vilka receptföreskrifter som gäller.
Se kapitlets inledning för attribut i detta objekt.
4.23.50 StrengthNumericUnit
Anger numerisk styrkeenhet.
Se kapitlets inledning för attribut i detta objekt.
4.23.51 OrganizationRole
Den roll ett företag har för en läkemedelsprodukt.
Se kapitlets inledning för attribut i detta objekt.
4.23.52 Country
Anger ISO 3166-1 alpha-3 landskod.
Se kapitlets inledning för attribut i detta objekt.
4.23.53 DosdispLifeUnit
Anger enhet för hållbarhetstid vid dosdispensering.
Se kapitlets inledning för attribut i detta objekt.
4.23.54 PackageTypeInner
Anger förpackningstyp för en inre förpackning i en läkemedelsförpackning.
Se kapitlets inledning för attribut i detta objekt.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 124/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.23.55 PackCondition
Anger förpackningstillstånd.
Se kapitlets inledning för attribut i detta objekt.
4.23.56 StorageTemp
Anger förvaringstemperatur.
Se kapitlets inledning för attribut i detta objekt.
4.23.57 SalesRestriction
Anger försäljningsrestriktioner som Läkemedelsverket angivit för ett läkemedel.
Se kapitlets inledning för attribut i detta objekt.
4.23.58 PackSizeNumericUnit
Anger enhet för den numeriska förpackningsstorleken.
Se kapitlets inledning för attribut i detta objekt.
4.23.59 ShelfLifeUnit
Anger enhet för hållbarhetstid.
Se kapitlets inledning för attribut i detta objekt.
4.23.60 StorageCondition
Anger förvaringsvillkor.
Se kapitlets inledning för attribut i detta objekt.
4.23.61 IngredientRole
Anger roll för en beståndsdel.
Se kapitlets inledning för attribut i detta objekt.
4.23.62 QuantityUnit
Anger mängdenhet.
Se kapitlets inledning för attribut i detta objekt.
4.23.63 AlternativeQuantityUnit
Anger alternativ mängdenhet.
Se kapitlets inledning för attribut i detta objekt.
4.23.64 CompRefQuantity
Anger ”per vad” en ingrediens mängd är angivet. T.ex. ”per 10 gram” eller ”per angiven dos”.
Se kapitlets inledning för attribut i detta objekt.
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 125/126
sil-api-specifikation-4.0.pdf
Version: 1.3
Diarienummer: 201409-026
Författare: Paul Cohen
Dokumentägare: Erik Heneryd
Senast ändrad
2015-04-14
4.24 Versionsinformation
Tjänsterna används för att hämta information om versioner på bl.a. de olika källorna, databasens
sammansättning samt om API version.
4.24.1
getDataVersions
Returnerar versionsinformation om data i SIL databasen.
Inparametrar
Returtyp
DataVersion [ ]
Lista med DataVersion-objekt.
Exempel
4.24.2
getApiVersion
Returnerar versionsinformation om SIL SOAP API.
Inparametrar
Returtyp
ApiVersion [ ]
Lista med ApiVersion-objekt.
Exempel
4.24.3
DataVersion
Ett DataVersion-objekt innehåller versionsinformation om en datakälla.
Attribut
dataVersionId: int
dataVersionType: string
version: string
4.24.4
Internt SIL id för datakällan.
Datakälla.
Versionsbeteckning.
ApiVersion
Ett ApiVersion-objekt innehåller versionsinformation om SIL SOAP API.
Attribut
major: int
Huvudversionsnummer.
Delversionsnummer.
Patchversionsnummer.
minor: int
build: int
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 126/126