SIL SOAP API 4.1
prerelease
Nyheter och förändringar gentemot SIL SOAP API 4.0
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Innehåll
1. Generellt ................................................................................................................................ 4
2. Bakåtkompatiblitet ............................................................................................................... 4
3. Driftmiljö ................................................................................................................................ 4
4. Ansökan om tillgång till demoserver .................................................................................. 5
5. Interaktioner .......................................................................................................................... 5
6. In- och utträde ur högkostnadsskyddet ............................................................................. 5
7. Logghantering ...................................................................................................................... 5
8. Rimlighetskontroll ................................................................................................................ 6
8.1 Nya objekt ......................................................................................................................... 6
8.1.1 DoseRange ................................................................................................................................. 6
8.1.2 DoseWeightRange ...................................................................................................................... 7
8.2 Nya tjänster ...................................................................................................................... 7
8.2.1 getDoseRangesByNplId ............................................................................................................. 7
8.2.2 getDoseRangesByNplSubstanceId ............................................................................................ 7
8.2.3 getDoseWeightRanges ............................................................................................................... 8
8.2.4 isWithinDoseRangeForNplId ...................................................................................................... 8
8.2.5 isWithinDoseRangeForNplSubstanceId ..................................................................................... 9
8.2.6 isWithinDoseWeightRange ....................................................................................................... 10
9. Läkemedelsinstruktioner ................................................................................................... 10
9.1 Nya objekt ....................................................................................................................... 10
9.1.1 DrugInstruction ......................................................................................................................... 10
9.1.2 HealthCareUnit ......................................................................................................................... 11
9.2 Nya tjänster ..................................................................................................................... 11
9.2.1 getDrugInstructionHealthCareUnits .......................................................................................... 11
9.2.2 getDrugInstructions ................................................................................................................... 11
9.2.3 getDrugInstructionsByDrugInstructionId ................................................................................... 12
9.2.4 getDrugInstructionsByHealthCareUnit ...................................................................................... 12
9.2.5 getDrugInstructionsByNplId ...................................................................................................... 12
9.2.6 getHealthCareUnitById ............................................................................................................. 13
10. Administreringssätt .......................................................................................................... 13
10.1 Nya objekt ..................................................................................................................... 13
10.1.1 DrugAdministration ................................................................................................................. 13
10.1.2 Term ........................................................................................................................................ 13
10.2 Nya tjänster .................................................................................................................. 14
10.2.1 getDrugAdministrationMethods .............................................................................................. 14
10.2.2 getDrugAdministrationRoutes ................................................................................................. 14
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
10.2.3 getDrugAdministrationSites .................................................................................................... 14
10.2.4 getDrugAdminisationsByCodes .............................................................................................. 14
10.2.5 getDrugAdminisationsByTerms ............................................................................................... 15
11. Handelsvaror ..................................................................................................................... 15
11.1 Nytt objekt ..................................................................................................................... 16
11.1.1 NonDrugGroup ........................................................................................................................ 16
11.2 Nya tjänster ................................................................................................................... 16
11.2.1 getNonDrugGroupByCode ...................................................................................................... 16
11.2.2 getNonDrugGroupParentsByCode ......................................................................................... 16
11.2.3 getNonDrugGroups ................................................................................................................. 17
11.2.4 getNonDrugGroupsByCode .................................................................................................... 17
11.2.5 getNonDrugGroupsByCodeList .............................................................................................. 17
11.2.6 getNonDrugGroupsByTextSv .................................................................................................. 18
12. Graviditetsvarningar ......................................................................................................... 18
12.1 Nytt attribut ................................................................................................................... 18
13. Utsättningsorsaker ........................................................................................................... 19
13.1 Nytt attribut ................................................................................................................... 19
13.2 Ny tjänst ........................................................................................................................ 19
13.2.1 getTreatmentWithdrawalReasonById ..................................................................................... 19
14. Kortnotationer ................................................................................................................... 19
15. Biverkningar ...................................................................................................................... 19
16. Tillgänglighet .................................................................................................................... 20
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
1. Generellt
Detta dokument beskriver nyheter och förändringar i SIL SOAP API 4.1 gentemot SIL SOAP
API 4.0. Det förutsätts att läsaren är bekant med denna tidigare version och har läst
dokumentationen för denna - "Tjänstegränssnittsbeskrivning - SIL SOAP API 4.0" - då endast
skillnaderna beskrivs.
Bortsett från att inte vara fullständigt är detta dokument för närvarande ej heller slutgiltigt. Det
beskriver den prerelease Sil gör innan sommaren (i år 11:e juni) som en service till sina
användare, så de kan få ett hum om vad de kan förvänta sig i den skarpa versionen i utgången av
Q3 (i år planerad till 30:e september).
Med det sagt så brukar prereleasen, som innefattar denna dokumentation och en hos Sil
åtkomlig demoserver, vara ganska nära den skarpa Q3-leveransen featuremässigt
2. Bakåtkompatiblitet
SIL SOAP API 4.1 är tekniskt bakåtkompatibelt med SIL SOAP API 4.0. Med detta menas att i
ingenting som fanns i den tidigare versionen har tagit bort eller förändrats, utan skillnaden
handlar uteslutande om saker som lagts till (24 tjänster, 7 objekt och 2 attribut).
Detta till trots kan det, speciellt om man använder teknik som inte hanterar wsdl:er dynamiskt,
behövas en mindre översyn för att lägga till de nya objekten/tjänsterna/attributen. Även om man
tänkt ignorera dem. I vilket fall som helst rekommenderas nya systemtest vid migrering från 4.0
till 4.1.
De små förändringar som ändå gjorts jämfört med 4.0 handlar om:
•
Biverkningar, där man med ett förtydligande av tidigare API-specifikation kan skilja på
fallen att det 1) inte finns någon information om biverkningar och 2) det inte finns några
(kända) biverkningar. Se avsnitt 15.
•
Kortnotationer, där ett par termer ändrats. Se avsnitt 14.
3. Driftmiljö
För att underlätta för de som migrerar från 4.0 är målmiljön (versioner osv) för Sil SOAP API
4.1 i huvudsak densamma som för 4.0. Tomcat uppdateras till version 8, men i övrigt lika:
•
Windows Server 2012
•
Microsoft SQL Server 2012
•
Java 8.
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
4. Ansökan om tillgång till demoserver
Från och med den 11:e juni kommer Sil blockera publik tillgång till sina externa demoservrar.
Detta gäller samtliga versioner, inklusive denna prerelease. Ingen Sil-data, inte ens för
teständamål, kommer vara direkt tillgänglig utan det krävs först en godkänd ansökan (hittas på
Ineras hemsida).
5. Interaktioner
Interaktioner är ett område som är oförändrat i denna prerelease. Vi jobbar dock på några
nyheter som är planerade för slutgiltiga leveransen. Exakt hur detta kommer se ut i form av
tillagda/förändrade tjänster och/eller objekt är dock ännu inte helt klarlagt.
Vad det rör sig om är dock:
•
läkemedel utan interaktioner (till skillnad från läkemedel man inte har någon info om).
Detta finns redan förberett genom ett treställigt attribut interactionStatus på Drugobjektet. Detta attribut används dock inte fullt ut idag, men när vi får ordning på den
underliggande källintegrationen kan detta eventuellt införas även i de tidigare
versionerna 3.1 och 4.0.
•
licensläkemedel med interaktioner. På samma vis som läkemedel utan interaktioner kan
detta eventuellt införas även i 3.1 och 4.0.
•
interaktioner med icke-läkemedel. Eller i vart fall sådant som saknar nplid, vilket kan
innebära införandet av nya tjänster. Exempel på icke-läkemedel som saknar nplid är
hypericum perforatum (johannesört) eller grapefruktjuice.
6. In- och utträde ur högkostnadsskyddet
eHälsomyndigheten kommer hösten 2016 börja leverera datum för in- och utträde ur
högkostnadsskyddet (förmånen). Detta planerar Sil att anpassa sig för Sil SOAP API 4.1. Exakt
hur detta kommer se ut i form av tillagda/förändrade tjänster och/eller objekt är dock inte helt
klarlagt ännu och finns inte med i prereleasen.
7. Logghantering
Det kommer till den skarpa leveransen tas fram rutiner för att i samband av nedladdning av
färska 4.1-databaser även ladda upp serverloggar till Inera. Detta i syfte att ge Inera en bättre
överblick av Sil-användandet och kommer utgöra underlag för förbättringar av API:et, både
avseende tjänster och prestanda.
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
8. Rimlighetskontroll
Från denna version är ePeds (Erfarenhets & Evidensbaserad Databas för Barnläkemedel) källa
för rimlig dosering tillgänglig via Sil. Även om tjänsterna har fått generella namn finns det idag
bara data från ePed och funktionaliteten är därför begränsad till barn.
Rimlighetskontrollen innebär att doseringen för vissa läkemedel kan kontrolleras när vissa
inparametrar (barnets ålder, vikt, läkemedelsdosering och administreringsväg) finns tillgängliga.
Kontrollen sker för den totala dygnsdosen och för enstaka doseringstillfällen och varnar för
över- och underdosering.
Rimlighetskontrollen kan användas på två sätt. Dels kan man fråga om en tänkt dosering är
rimlig och dels kan man hämta ut rimlighetsintervall för att själv implementera en motsvarande
algoritm (eller visualisera informationen på något sätt).
Det finns även en tjänst för rimlig ordinationsvikt (patientvikt).
8.1
Nya objekt
8.1.1
DoseRange
Attribut
ageFrom: double
ageTo: double
ageUnit: string
dailyDoseBase: string
dailyDoseMax: double
dailyDoseUnit: string
doseBase: string
doseMax: double
doseMin: double
doseUnit: string
dosingInfo: string
gestationalAgeFrom: double
gestationalAgeTo: double
gestationalAgeUnit: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Lägsta ålder för vilket doseringsintervallet gäller.
Högsta ålder för vilket doseringsintervallet gäller.
Enhet för ålder. Kan bara vara ”year”.
Anger vad den maximala dygnsdoseringen är
beräknad för. Kan vara ”PER_PATIENT” eller
”PER_KG_BODYWEIGHT”.
Maximal dygnsdos.
Enhet för maximal dygnsdos.
Anger vad den minimal och maximal dosering är
beräknad för. Kan vara ”PER_PATIENT” eller
”PER_KG_BODYWEIGHT”.
Maximal dos.
Minimal dos.
Enhet för dos.
En kortfattad doseringsanvisning för den terapeutiska
situation för vilket detta doseringsintervall är
lämpligt.
Lägsta gestationsålder för vilket doseringsintervallet
gäller.
Högsta gestationsålder för vilket doseringsintervallet
gäller.
Enhet för gestationsålder. Kan bara vara ”week”.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 6/20
sil-api-prerelease-4.1.pdf
Version: 1.4
nplSubstanceId: string
routeOfAdministrationCode: string
weightFrom: double
weightTo: double
weightUnit: string
8.1.2
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
NPL-substansid för den substans för vilket
doseringsintervallet gäller.
Kod för den administreringsväg för vilket
doseringsintervallet gäller.
Minimal ordinationsvikt för vilket
doseringsintervallet gäller.
Maximal ordinationsvikt för vilket
doseringsintervallet gäller.
Enhet för ordinationsvikt. Kan bara vara ”kg”.
DoseWeightRange
Attribut
ageFrom: double
ageTo: double
ageUnit: string
weightMax: double
weightMin: double
weightUnit: string
8.2
Lägsta ålder för vilket viktintervallet gäller.
Högsta ålder för vilket viktintervallet gäller.
Enhet för ålder. Kan bara vara ”year”.
Maximal vikt för angivet åldersintervall.
Minimal vikt för angivet åldersintervall.
Enhet för vikt. Kan bara vara ”kg”.
Nya tjänster
8.2.1
getDoseRangesByNplId
Hämtar DoseRange objekt som matchar dom angivna inparametrarna. Om en parameter har
värdet null så matchar den på alla, för attributet som parametern motsvarar. Ålder måste vara
angiven om gestationsålder är angiven. Om alla parametrar är angivna så returneras det
doseringsintervall som isWithinDoseRangeForNplId tjänsten använder.
Inparametrar
nplId: string
routeOfAdministrationCode: string
age: double
gestionalAge: double
weight: double
NPL-id eller null.
Administreringsvägskod eller null.
Ålder eller null.
Gestationsålder eller null.
Ordinationsvikt eller null.
Returtyp
DoseRange[]
Lista med DoseRange-objekt.
Exempel
Anropet:
getDoseRangesByNplId(”19551128000024”, ”SAKR-0007”, 7.0, null, 20.0)
returnerar matchande doseringsintervall.
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
8.2.2
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
getDoseRangesByNplSubstanceId
Hämtar DoseRange objekt som matchar dom angivna inparametrarna. Om en parameter har
värdet null så matchar den på alla, för attributet som parametern motsvarar. Ålder måste vara
angiven om gestationsålder är angiven. Om alla parametrar är angivna så returneras det
doseringsintervall som isWithinDoseRangeForNplSubstanceId tjänsten använder.
Inparametrar
nplSubstanceId: string
routeOfAdministrationCode: string
age: double
gestionalAge: double
weight: double
NPL-substansid eller null.
Administreringsvägskod eller null.
Ålder eller null.
Gestationsålder eller null.
Ordinationsvikt eller null.
Returtyp
DoseRange[]
Lista med DoseRange-objekt.
Exempel
Anropet:
getDoseRangesBySubstanceId(”IDE4POBVU926KVERT1”, ”SAKR-0007”, 7.0, null,
20.0)
returnerar matchande doseringsintervall.
8.2.3
getDoseWeightRanges
Inga inparametrar
Returtyp
DoseWeightRange[]
Lista med alla DoseWeightRange-objekt.
Exempel
Anropet:
getDoseWeightRanges()
returnerar alla DoseWeightRange-objekt.
8.2.4
isWithinDoseRangeForNplId
Testar om dosen och dagliga dosen är rimlig. Möjliga returvärden är:
DOSE_OK: Angiven dos och dygnsdos är rimlig.
NO_DOSE_INFO: Finns ingen rimlighetsinformation som matchar angiven NPL-id,
administreringsväg, ålder, gestationsålder, och ordinationsvikt.
DOSE_HIGH: Angiven dos är över rimlig dos.
DOSE_LOW: Angiven dos är under rimlig dos.
DAILY_DOSE_HIGH: Angiven dygnsdos är över rimlig dygnsdos.
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Inparametrar
nplId: string
routeOfAdministrationCode: string
age: double
gestionalAge: double
weight: double
dose: double
dailyDose: double
NPL-id.
Administreringsvägskod.
Ålder.
Gestationsålder eller null.
Ordinationsvikt.
Dos.
Dygnsdos.
Returtyp
string
Något av värderna: ”DOSE_OK”,
”NO_DOSE_INFO”, ”DOSE_HIGH”,
”DOSE_LOW”, ”DAILY_DOSE_HIGH”.
Exempel
Anropet:
isWithinDoseRangeForNplId(”19551128000024”, ”SAKR-0007”, 7.0, null, 20.0, 200.0,
300.0)
returnerar om dosen eller dyngsdosen är rimlig. I detta fall DOSE_HIGH.
8.2.5
isWithinDoseRangeForNplSubstanceId
Testar om dosen och dagliga dosen är rimlig. Möjliga returvärden är:
DOSE_OK: Angiven dos och dygnsdos är rimlig.
NO_DOSE_INFO: Finns ingen rimlighetsinformation som matchar angiven NPL-substansid,
administreringsväg, ålder, gestationsålder, och ordinationsvikt.
DOSE_HIGH: Angiven dos är över rimlig dos.
DOSE_LOW: Angiven dos är under rimlig dos.
DAILY_DOSE_HIGH: Angiven dygnsdos är över rimlig dygnsdos.
Inparametrar
nplSubstanceId: string
routeOfAdministrationCode: string
age: double
gestionalAge: double
weight: double
dose: double
dailyDose: double
NPL-substansid.
Administreringsvägskod.
Ålder.
Gestationsålder eller null.
Ordinationsvikt.
Dos.
Dygnsdos.
Returtyp
string
Något av värderna: ”DOSE_OK”,
”NO_DOSE_INFO”, ”DOSE_HIGH”,
”DOSE_LOW”, ”DAILY_DOSE_HIGH”.
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 9/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Anropet:
isWithinDoseRangeForNplSubstanceId(”IDE4POBVU926KVERT1”, ”SAKR-0007”, 7.0,
null, 20.0, 150.0, 300.0)
returnerar om dosen eller dyngsdosen är rimlig. I detta fall DOSE_OK.
8.2.6
isWithinDoseWeightRange
Testar om ordinationsvikten är rimlig för en viss ålder.
WEIGHT_OK: Ordinationsvikten är rimlig.
NO_WEIGHT_INFO: Finns ingen rimlighetsinformation som matchar angiven ålder.
WEIGHT_HIGH: Angiven ordinationsvikt är över rimlig vikt .
WEIGHT_LOW: Angiven ordinationsvikt är under rimlig vikt.
Inparametrar
age: double
Ålder
Ordinationsvikt
weight: double
Returtyp
string
Något av värderna: ”WEIGHT_OK”,
”NO_WEIGHT_INFO”, ”WEIGHT_HIGH”,
”WEIGHT_LOW”.
Exempel
Anropet:
isWithinDoseWeightRange(8.0, 15.0)
returnerar om vikten är rimlig. I detta fall WEIGHT_LOW.
9. Läkemedelsinstruktioner
Från denna version är ePeds (Erfarenhets & Evidensbaserad Databas för Barnläkemedel) källa
för läkemedelsinstruktioner tillgänglig via Sil. Precis som för rimlighetskontroll har tjänsterna
fått generella namn även om det idag handlar om data från ePed (oftast spädningsschema, men
även doserings- och administreringsrutiner).
Dessa läkemedelsinstruktioner underhålls idag inom ePed genom expertguppen på Astrid
Lindgrens sjukhus, men i framtiden även av experter på andra barnsjukhus i Sverige.
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
9.1
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Nya objekt
9.1.1
DrugInstruction
Attribut
created: string
drugInstructionId: string
modified: string
nplIds: string[]
source: string
title: string
url: string
version: string
9.1.2
Datum då läkemedelsinstruktionen först skapades.
Unikt id för läkemedelsinstruktionen inom den källa
som läkemedelsinstruktionen kommer ifrån.
Datum då läkemedelsinstruktionen senast
uppdaterades .
En lista med NPL-id för läkemedelsprodukter som
läkemedelsinstruktionen är baserad på.
Källa (huvudman) för läkemedelsinstruktionen.
Läkemedelsinstruktionens titel.
URL till läkemedelsinstruktionen.
Version på läkemedelsinstruktionen.
HealthCareUnit
Attribut
hsaId: string
hsaName: string
id: string
name: string
9.2
HSA-id på vårdenheten.
HSA-namn på vårdenheten.
Unikt id för vårdenheten.
Namnet på vårdenheten.
Nya tjänster
9.2.1
getDrugInstructionHealthCareUnits
Inga inparametrar
Returtyp
HealthCareUnit[]
Exempel
Anropet:
getDrugInstructionHealthCareUnits()
returnerar alla vårdenheter som har minst en beslutad läkemedelsinstruktion.
9.2.2
getDrugInstructions
Inparametrar
source: string
Källa för läkemedelsinstruktionen.
Returtyp
DrugInstruction[]
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Exempel
Anropet:
getDrugInstructions(”eped”)
returnerar alla läkemedelsinstruktioner för källan ”eped”.
9.2.3
getDrugInstructionsByDrugInstructionId
Inparametrar
source: string
drugInstructionId: string
version: string
Källa för läkemedelsinstruktionen.
Id för läkemedelsinstruktionen.
Version för läkemedelsinstruktionen eller null.
Returtyp
DrugInstruction[]
Exempel
Anropet:
getDrugInstructionsByDrugInstructionId(”eped”, ”1234”, ”1.2”)
returnerar läkemedelsinstruktionen från källan ”eped” som har id ”1234” och version
”1.2”.
9.2.4
getDrugInstructionsByHealthCareUnit
Inparametrar
source: string
healthCareUnitId: string
Källa för läkemedelsinstruktionen.
Vårdenhet.
Returtyp
DrugInstruction[]
Exempel
Anropet:
getDrugInstructionsByHealthCareUnit(”eped”, ”3”)
returnerar läkemedelsinstruktioner för källan ”eped” beslutade för vårdenheten med id ”3”
.
9.2.5
getDrugInstructionsByNplId
Inparametrar
source: string
nplId: string
healthCareUnitId: string
Källa för läkemedelsinstruktionen.
NPL-id som läkemedelsinstruktionen är baserad på.
Vårdenhet eller null.
Returtyp
DrugInstruction[]
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Exempel
Anropet:
getDrugInstructionsByNplId(”eped”, ”19551128000024”, null)
returnerar alla läkemedelsinstruktioner från källan ”eped” och som är baserade på den
givna NPL-idt. Null som vårdenhet betyder att vi inte vill filtrera på endast dom som är
beslutade i en viss vårdenhet.
9.2.6
getHealthCareUnitById
Inparametrar
healthCareUnitId: string
Id för vårdenheten.
Returtyp
HealthCareUnit
Exempel
Anropet:
getHealthCareUnitById(”3”)
returnerar vårdenheten med id ”3”.
10.Administreringssätt
En ny källa för administreringssätt (väg/ställe/metod), som har sin upprinnelse i behovet av
strukturerad information för detta inom ePed.
10.1 Nya objekt
10.1.1 DrugAdministration
Attribut
route: Term
Term-objekt för administreringsväg.
Term-objekt för administreringsställe.
Term-objekt för administreringsmetod.
site: Term
method: Term
10.1.2 Term
Attribut
code: string
descriptionEn: string
Inera AB
Box 177 03
Östgötagatan 12
118 93 Stockholm
Kod.
Beskrivning på engelska.
Tel 08 452 71 60
[email protected]
www.inera.se
Organisationsnummer
556559-4230
Sid 13/20
sil-api-prerelease-4.1.pdf
Version: 1.4
descriptionSv: string
textEn: string
textSv: string
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Beskrivning på svenska.
Term på engelska.
Term på svenska.
10.2 Nya tjänster
10.2.1 getDrugAdministrationMethods
Hämtar alla Term-objekt för administrerings metoder.
Inga inparametrar
Returtyp
Term[]
Lista med Term-objekt.
Exempel
Anropet:
getDrugAdministrationMethods()
En lista med Term-objekt som representerar administreringsmetoder.
10.2.2 getDrugAdministrationRoutes
Hämtar alla Term-objekt för administreringsvägar.
Inga inparametrar
Returtyp
Term[]
Lista med Term-objekt.
Exempel
Anropet:
getDrugAdministrationRoutes()
Alla Term-objekt som representerar administreringsvägar.
10.2.3 getDrugAdministrationSites
Hämtar alla Term-objekt för administreringsställen.
Inga inparametrar
Returtyp
Term[]
Lista med Term-objekt.
Exempel
Anropet:
getDrugAdministrationSites()
Alla Term-objekt som representerar administreringsställen.
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 14/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
10.2.4 getDrugAdminisationsByCodes
Lorem ipsum.
Inparametrar
routeCode: string
siteCode: string
methodCode: string
Kod för administreringsväg eller null.
Kod för administreringsställe eller null.
Kod för administreringsmetod eller null.
Returtyp
DrugAdministration[]
Exempel
Anropet:
getDrugAdministrationsByCodes(”SAKR-0001”, ”SAKS-0002”, null)
returnerar alla administreringar med de angivna koderna för administreringsväg och
administreringssätt. Null för administreringsmetod betyder att vi vill ha alla
administreringsmetoder kopplade till givna administreringsvägen och
administreringssättet.
10.2.5 getDrugAdminisationsByTerms
Inparametrar
routeTerm: string
siteTerm: string
methodTerm: string
Svensk term för administreringsväg eller null.
Wildcard tillåtet.
Svensk term för administreringsställe eller null.
Wildcard tillåtet.
Svensk term för administreringsmetod eller null.
Wildcard tillåtet.
Returtyp
DrugAdministration[]
Exempel
Anropet:
getDrugAdministrationsByTerms(”Intravenöst”, ”Central%”, ”Infusion”)
returnerar administreringar där den svenska termen för administreringsväg är ”Intraveöst”,
där den svenska termen för administreringssätt börjar med ”Central” och där den svenska
termen för administreringsmetod är ”Infusion”.
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 15/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
11.Handelsvaror
Sil innehåller sedan tidigare information om s k förbrukningsartiklar inom förmånen, även
kallade "handelsvaror". Vi tillgängliggör nu varugrupperingskoder för dessa, som levereras av
eHälsomyndigheten och underhålls av TLV och eHälsomyndigheten.
11.1 Nytt objekt
11.1.1 NonDrugGroup
Attribut
code: string
Kod.
Beskrivande text på svenska.
Beskrivande text på engelska.
textEn: string
textSv: string
11.2 Nya tjänster
11.2.1 getNonDrugGroupByCode
Kan användas för att hämta informationen för en enskild NonDrugGroup.
Se även getNonDrugGroupParentsByCode
Inparametrar
code: string
En kod
Returtyp
NonDrugGroup
Ett DrugGroup-objekt
Exempel
Anropet:
getNonDrugGroupByCode(”Y75BB”)
returnerar
(NonDrugGroup) {code: ”Y75BB”, textEn: null, textSv: ”Sondnäringar”}
11.2.2 getNonDrugGroupParentsByCode
Ger tillbaka informationen för alla koder på vägen fram till och med en enskild NonDrugGroup.
Om man för en handelsvara vill ge tillbaka komplett information om vad dess
productGroupCode innebär så kan denna tjänst vara att föredra framför
getNonDrugGroupByCode
Inparametrar
code: string
En kod
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 16/20
sil-api-prerelease-4.1.pdf
Version: 1.4
NonDrugGroup[]
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Lista med DrugGroup-objekt
Exempel
Anropet:
getNonDrugGroupParentsByCode(”Y75BB30”)
returnerar
[(NonDrugGroup) {code: ”Y”, textEn null, TextSv: ”Handelsvaror inom förmånen”},
(NonDrugGroup) {code: ”Y75”, textEn null, TextSv: ”Livsmedel för särskilda
näringsändamål (Förmån)”},
(NonDrugGroup) {code: ”Y75B”, textEn null, TextSv: ”Livsmedel för speciella
medicinska ändamål, med standardiserat näringsinnehåll”},
(NonDrugGroup) {code: ”Y75BB”, textEn null, TextSv: ”Sondnäringar”},
(NonDrugGroup) {code: ”Y75BB30”, textEn null, TextSv: ”Protein”}]
11.2.3 getNonDrugGroups
Ger tillbaka alla NonDrugGroups. Kan användas för att skapa ett temporärt lexikon att bläddra
i.
Inga inparametrar
Returtyp
NonDrugGroup[]
Lista med DrugGroup-objekt
Exempel
Anropet:
getNonDrugGroups()
Ger tillbaka alla NonDrugGroup-objekt
11.2.4 getNonDrugGroupsByCode
Ger tillbaka flera NonDrugGroup-objekt basearat på deras koder. Skillnaden mellan denna tjänst
och getNonDrugGroupByCode är att wildcard-tecken tillåts i koden som skickas i denna tjänst.
Denna tjänst kan exempelvis användas till att hitta alla underkategorier för en viss kod.
Inparametrar
code: string
En kod. Wildcard-tecken är tillåtet i strängen
Returtyp
NonDrugGroup[]
Exempel
Anropet:
getNonDrugGroupByCode(”Y75BB%”)
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
returnerar NonDrugGroup-objekt för koderna ”Y75BB”, ”Y75BB10”... ”Y75BB60”
11.2.5 getNonDrugGroupsByCodeList
Inparametrar
code: string[]
Lista med koder.
Returtyp
NonDrugGroup[]
Exempel
Anropet:
getNonDrugGroupByCodeList([”Y75BB10”, ”Y75BB20”])
returnerar NonDrugGroup-objekt för koderna ”Y75BB10” och ”Y75BB20”
11.2.6 getNonDrugGroupsByTextSv
Hämtar NonDrugGroup-objekt baserat på dess beskrivande text. Kan användas när man
kommer ihåg på ett ungefär vad koden man söker efter har för beskrivning och vill få reda på
koden.
Inparametrar
textSv: string
Textsträng på svenska. Wildcard-tecken '%' är tillåtet
i strängen.
Returtyp
NonDrugGroup[]
Exempel
Anropet:
getNonDrugGroupByTextSv(”%livsmedel””)
returnerar alla NonDrugGroup-objekt som innehåller strängen livsmedel i sin beskrivande
text.
12.Fosterpåverkan
Vi återinför ett nygammalt attribut som togs bort i 4.0.
12.1 Nytt attribut
På objektet JanusInfoPregnancyDoc har attributet authors återkommit. Det är precis som i 3.1
en lista med strängar en lista med författare för amningsvarningen (strängar). Precis som i 3.1 är
listan ordnad så att dokumentets primära författare kommer först, följd av sekundära osv.
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/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
13.Utsättningsorsaker
En utsättningsorsak har tidigare bara varit en kort respektive lång beskrivning av varför ett
läkemedel sätts ut. Nu tillkommer en kod/id för att göra utsättningsorsakerna identifierbara och
dessa är också tidsbeständiga. Om texten för en utsättningsorsak justeras skall man kunna
avgöra att/om det är samma orsak som tidigare.
13.1 Nytt attribut
På objektet TreatmentWithdrawalReason har attributet id tillkommit. Det är den tidsbeständiga
koden i form av en sträng.
13.2 Ny tjänst
13.2.1 getTreatmentWithdrawalReasonById
Inparametrar
treatmentWithdrawalReasonId: string
Id för utsättningsorsak.
Returtyp
TreatmentWithdrawalReason
Exempel
Anropet:
getTreatmentWithdrawalReasonById(”10”)
Returnerar utsättningsorsaken med id ”10”.
14.Kortnotationer
Det har framkommit att det finns vissa problem att schablonmässigt ordinera tf/tm - "till
frukost/middag" för läkemedel som ska tas på morgonen/kvällen då en del läkemedel inte skall
tas i samband med måltid.
Därför har ett beslut tagits att ändra i kortnotationerna. Termen "tf" som tidigare expanderats till
"till frukost" tas bort och slutar fungera och ersätts istället med "pm", vilket kommer expandera
till "på morgonen". På samma sätt ersätts "tm" ("till middag") med "tk" ("till kvällen").
15.Biverkningar
Det har tidigare inte funnits något ordentligt sätt att skilja på fallen att det 1) inte finns någon
information om biverkningar och 2) det inte finns några (kända) 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 19/20
sil-api-prerelease-4.1.pdf
Version: 1.4
Författare: Erik Heneryd
Dokumentägare: Erik Heneryd
Senast ändrad
2015-06-10
Sil inför nu den möjligheten genom att förtydliga definitionen av attributet SideEffects på
objektet SideEffects, en lista med bieffekter för ett visst läkemedel. Är denna lista tom betyder
det att det inte finns några (kända) bieffekter.
Det andra fallet, det där det inte finns någon information öht, hanteras genom att att de tjänster
som returnerar listor med SideEffects-objekt (i dagsläget bara getSideEffectsByNplIdList) inte
returnerar något SideEffects-objekt alls för läkemedel det inte finns någon information om.
16.Tillgänglighet
I tidigare versioner av Sil SOAP API beräknades ett läkemedels tillgänglighet (om det
marknadsförs) statiskt, dvs vid Ineras produktion av en ny databas. I version 4.1 beräknas detta
dynamiskt, i tjänsteanropsögonblicket. Detta ger mer exakta uppgifter om vilka läkemedel som
marknadsförs eller ej.
Påverkar alla läkemedelstjänster med flgCurrent som filter.
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/20