Dokumentation av XML-schema version 4.0
Här beskrivs XML-schemat för E-hälsomyndighetens VARA-exportfil version 4.0. Texten är inte en specifikation av export-formatet utan en kompletterande dokumentation. Vid användning av VARA-exportfil i system ska dokumentation av XML-schema användas tillsammans med VARA - nationellt produkt- och artikelregister.
1. Kort beskrivning
E-hälsomyndighetens VARA-register exporteras som XML-filer och strukturen för varje XML-fil specificeras i ett antal xml-scheman (xsd) som också bifogas vid varje export.
Tabell 1. VARA XML-fil och sftp.
DNS-namn sftp-server |
sftp.ehalsomyndigheten.se |
Protokoll |
sftp |
Filnamn |
vara-export-4_ÅÅMMDD.zip |
2. Informationsinnehåll i VARA
Sortimentet i VARA är det nationellt gemensamma, det vill säga samtliga läkemedel samt de förbrukningsartiklar och livsmedel som ingår i högkostnadsskyddet. Information om läkemedelsprodukter och artiklar som marknadsförs eller har marknadsförts sedan år 2005 är inkluderad i VARA.
För beskrivning av produkt- och artikelregistret VARA samt information om innehåll och regelverk, se avsnittet VARA - nationellt produkt- och artikelregister för mer information.
Observera att farmaceutisk verksamhetskompetens behövs för att avgöra informationsfältets/elementets betydelse för användaren av till exempel vårdsystem och expeditionssystem.
2.1. Förkortningar
Tabell 2. Förkortningar.
GIC |
Giftinformationscentralen. |
EMA |
European Medicines Agency. |
LV |
Läkemedelsverket. |
TLV |
Tandvårds- och läkemedelsförmånsverket. |
WHO |
World Health Organisation, WHO Collaborating Centre for Drug Statistics Methodology. |
NSL |
Nationellt substansregister för läkemedel. Förvaltas av Läkemedelsverket. |
3. Schemastruktur
Exportformatet är specificerat i ett antal inbördes beroende xml-scheman (xsd:er), med följande struktur.
Figur 1. Struktur för VARA exportformat.
Tabell 3. Beskrivning av schemastruktur.
Schema |
Beskrivning |
vara-export.xsd |
Huvud-schema, beskriver grundstrukturen på export-filen. |
asab-definitioner.xsd |
Innehåller alla typdefinitioner som används i export-filen, t.ex. lmprodukt, artikel, substans etc. |
asab-lexikon.xsd |
Samlar alla lexikon-scheman, innehåller inga egna definitioner. |
lexikon/lx-<lexikon-namn>.xsd |
Ett lexikon-schema, definierar tillåtna värden för ett visst element. T.ex. atc-koder, enheter, landskoder etc. |
4. Versionshantering
4.1. Grund-scheman
XML-schemat är versions-hanterat enligt version attributet på root-nivå, ex:
version="1.2"
Alla inbördes beroende scheman utom lexikon-scheman har detta attribut och ska ha samma versionsnummer.
4.2. Lexikon-scheman
Lexikon-scheman ligger under katalogen lexikon och har namn-standarden lx-<namn>.xsd . Dessa scheman innehåller definitioner av giltiga värden för olika koder som till exempel land, atc-kod samt enheter. Dessa scheman är inte versionshanterade enligt ovanstående princip utan anses vara mer eller mindre dynamiska och kan förändras utan att det i förväg annonseras, till exempel vid utökning med nya koder.
4.3. Produkt- och artikel-version
Varje produkt och artikel har ett attribut, ”version”, som betecknar produktens eller artikelns aktuella versionsnummer i VARA. Versionsnumret har formatet:
version="11.82"
4.3.1. Versionsuppstegning
Versionsattributet på produkter och artiklar reflekterar ändringar som skett i VARAs intagsprocess och innefattar bland annat uppdatering av information på enskilda fält, validering och godkännande. Med detta menas att versionen stegas upp varje gång den gått igenom intagsprocessen och inte enbart när ett eller flera fält ändras. En artikel får till exempel en ny version när produkten ändras eftersom beräkningar och valideringar görs om och den godkänns och publiceras på nytt i VARAs intagsprocess.
I princip så sker alltid en versionsuppstegning när något fält ändras på produkten eller artikeln men det finns några undantag:
- def:lmprodukt.utbytbar
- def:lmprodukt.utbytbarheter
- def:artikel.forman
- def:lmartikel.artikel_utbytbar
- def:artikel.pris
- def:artikel.tlv-substitution
Dessa fält som är härledda utifrån annan information kan dessutom vara beroende av aktuellt datum, till exempel så är flaggan ”utbytbar” beroende på om det finns en nu gällande utbytbarhet. Förutsättningar för dessa fält kan alltså ändras från dag till dag utan att produkten eller artikeln går igenom VARAs intagsprocess och därigenom får en ny version.
Notera att lexikon kan ändras utan att det sker någon uppstegning av versionsnummer på produkter eller artiklar. Om ett fält byter från ett lexikon-värde till ett annat sker alltid en versionsuppdatering men inte om endast texten på ett lexikon-värde i lexikon-schemat uppdateras. Detta gäller också intressenter och substanser som betraktas som lexikon även om dessa inte ligger i ett eget lexikon-schema utan inne i XML-filen.
Identifierare i filen som är av typen xs:IDREF och xs:ID garanteras inte att vara unika över tid. Det gäller farmaceutisk_produkt_ref, substans_ref, intressent_ref.
5. XML Grundstruktur
Figur 2. Grundstrukturen för VARA XML.
5.1. Fältbeskrivningar
Tabell 4. Fältbeskrivningar.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
envelope |
Rooten för xml-filen. |
1 |
Se nedan |
schemaVersion |
Aktuell schema-version som xml-filen följer. |
1 |
En sträng som motsvarar schemaversionen, t.ex. 3.0 |
timeStamp |
Tidsstämpel då filen skapades. |
1 |
Datum/tid av format: xs:dateTime |
info |
Behållare för allmän information om filen. |
1 |
|
antal_produkter |
Anger antalet produkter i filen. |
1 |
Ett positivt heltal |
leveransinfo |
Allmänna kommentarer om den aktuella exportfilen. |
0..1 |
Sträng (1..250 tecken) |
referenser |
Behållare för element som refereras till från andra element. |
1 |
Elementen intressenter och substanser |
intressenter |
Lista med alla intressenter, d.v.s. aktörer av olika typ, som förekommer i produktlistan. |
1 |
0 eller fler element av typen intressent |
substanser |
Lista med alla substanser som förekommer i produktlistan. |
1 |
0 eller fler element av typen substans |
produkter |
Produktlistan. |
1 |
0 eller fler element av typen lmprodukt alt. 0 eller fler element av typen hvprodukt |
6. Produkt
Produkt är en bastyp som innehåller gemensam information för läkemedelsprodukt och handelsvaruprodukt.
6.1. Fältbeskrivningar
E-hälsomyndigheten rekommenderar att urval av vilka element som ska visas i systemen ska ske i samarbete med personer som har farmaceutisk verksamhetskompetens. REKOMMENDATION
Tabell 5. Fältbeskrivningar för produkt.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
---|---|---|---|
version |
Produktens versionsnummer. |
1 |
Sträng enligt: X Y Z där X, Y och Z är nummerföljder i stigande ordning. |
produktnamn |
Gällande produktnamn. |
1 |
Sträng (1..100 tecken) |
tillagsnamn => produkt_namn |
Lista med produktnamn. |
1 |
1 eller fler produkt_namn-element |
produkt_namn |
Produktnamn med typ och giltighetsperiod. Kommentar: Gällande produktnamn utan varumärkessymbol (medprodnamelegal): Varumärkessymboler förekommer inte i alla produktnamn, vilket innebär att detta namn kan vara identiskt med gällande produktnamn (tradename). Tidigare produktnamn (historiskt-tradename) och tidigare produktnamn utan varumärkessymbol (historiskt-medprodnamelegal) har förutom ett från-och-med-datum även ett till-och-med-datum. |
1..* |
Attribut för typ och namn Se kap. 13.2 |
intressenter => intressent_ref |
Lista med referenser till intressenter. |
1 |
1 eller fler intressent_ref-element |
intressent_ref |
Organisation som har en roll i relation till en viss produkt. Kommentar: Referens till en intressent i listan med intressenter samt dess roll i relation till produkten. Exempelvis innehavare av försäljningstillstånd för produkten, eller dess ombud på den svenska marknaden. |
1..* |
Attribut för referens-id och definierad roll för organisation. Se kap 13.8 |
forsaljningsstopp |
Angivelse av om Läkemedelsverket tillfälligt har stoppat produkten från att ha ett försäljningstillstånd. |
1 |
Kod enligt lx-yesno.xsd |
forsaljningsstopp_kommentar_vara |
E-hälsomyndighetens kommentar vid försäljningsstoppad produkt. |
0..1 |
Sträng (1..80 tecken) |
innehaller_laktos |
Angivelse av om produkten innehåller laktos. Kommentar: Sätts automatiskt till Ja om produkten innehåller någon av substanserna laktosmonohydrat eller laktos vattenfri. Anges inte på licensläkemedel. |
0..1 |
Kod enligt lx-yesno.xsd |
innehaller_latex |
Anger om rester av latex kan förekomma i någon av artiklarna. Kommentar: Anges inte på licensläkemedel. |
0..1 |
Kod enligt lx-innehaller-latex.xsd |
gruppvarunummer |
Angivelse av om produkten är ett gruppvarunummer. |
1 |
Kod enligt lx-yesno.xsd |
receptbelagd |
Angivelse av om krav finns på recept för utlämnande av läkemedelsprodukten. Kommentar: Anger om produkten är receptbelagd eller ej, eller om vissa förpackningar kan tillhandahållas utan recept. |
1 |
Kod enligt lx-receptbelagd.xsd |
avregistreringsdatum |
Läkemedel: Datum för avregistrering av läkemedelsproduktens försäljningstillstånd. Handelsvaror: Datum för när handelsvaruprodukten utträder ur förmånen. Kommentar:
För handelsvaror gäller att handelsvaruprodukten ingår i förmånen till och med detta datum. |
0..1 |
Datum (ÅÅÅÅ-MM-DD) |
produkt_typ |
Kategori av läkemedelsprodukt utifrån vilken typ av godkännande eller registrering som krävs för ett försäljningstillstånd. Exempel: Växtbaserade läkemedel, licensläkemedel |
1 |
Kod enligt lx-produkt-typ.xsd |
lakemedel |
Angivelse av om produkten är ett läkemedel. |
1 |
Kod enligt lx-yesno.xsd |
7. Läkemedelsprodukt
Läkemedelsprodukt är en typ som innehåller information från bastypen Produkt och som utöver det innehåller information specifik för läkemedelsprodukter.
7.1. Fältbeskrivningar
Tabell 6. Fältbeskrivningar för läkemedelsprodukt.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
nplid |
Nationell unik identifierare av en läkemedelsprodukt. Kommentar: Format NPL-id: 14 siffror på formatet YYYYMMDD0NNNNN, där YYYY är år, MM är månad, DD är dag, NNNNN är ett produktnummer. Produktnamn, läkemedelsform och styrkebeteckning utgör tillsammans den unika kombination som representeras av ett NPL-id. För läkemedelsprodukter som skapats av E-hälsomyndigheten anges SB-id med formatet SBNNNNNNNNNNNN. |
1 |
Sträng (14 tecken) Exempel: NPL id: 20050721000081 SB id: SB991110000001 |
godkannandenr |
Svenskt godkännandenummer. |
0..1 |
Sträng (1..10 tecken) |
europeiskt_godkannandenr |
EU Marketing Authorization number, EU-gemensamt försäljningstillståndsnummer. Kommentar: Format EU/N/YY/NNN(N) där första siffran är 1 för humana läkemedel, 2 för veterinära, YY är år och de sista 3-4 siffrorna är ett produktnummer. Ej unikt nummer, eftersom produktbegreppet enligt EMA-definitionen och den svenska definitionen skiljer sig åt. |
0..1 |
Sträng (11..12 tecken)
|
antidot |
Angivelse av om produkten är klassad som en antidot av Giftinformationscentralen. |
1 |
Kod enligt lx-yesno.xsd |
avvikelse_parallell_import |
Beskrivning av skillnader i utseende mellan referensprodukt för godkännande och den produkt som är föremål för parallellimport/parallellhandel*. |
0..1 |
Sträng (1..500 tecken) |
ddd |
Definierad dygnsdos. Statistiskt mått som fastställs av WHO. Förmodad genomsnittlig dygnsdos då läkemedlet används av en vuxen vid läkemedlets huvudindikation. |
0..1 |
Decimal (högst 8 tecken varav 3 decimaler) |
enhet_ddd |
Enhet för DDD. |
0..1 |
Kod enligt lx-enhet-ddd.xsd |
doseringsenhet |
Anger i vilken enhet en läkemedelsprodukt avses doseras. AVRÅDD: Ingen information i detta fält, används inte. |
1 |
Kod enligt lx-doseringsenhet.xsd |
dos_bryttillstand |
Angivelse av om det finns ett tillstånd för att bryta läkemedelsförpackning inför maskinell dosdispensering. Kommentar: Brytningstillstånd beviljas av Läkemedelsverket. |
1 |
Kod enligt lx-yesno.xsd |
dos_bryttillstand_hallbar |
Hållbarhet vid öppen förvaring för läkemedelsprodukter som har brytningstillstånd för maskinell dosdispensering. Kommentar: Uttrycks i antal månader. |
0..1 |
Integer (2 tecken) |
godkannande_datum |
Datum för första godkännande eller registrering av läkemedelsproduktens försäljningstillstånd. Kommentar: Detta datum ändras ej även om produkten har fått ett förnyat godkännande eller förnyad registrering vid senare datum. |
0..1 |
Datum enligt ÅÅÅÅ-MM-DD |
styrka_klartext |
Uppgift om styrka. Kommentar: Styrkebeteckningen (styrka_klartext) beskriver läkemedelsproduktens styrka i textformat. Den är en del av identifikationen av en läkemedelsprodukt och används vid kommunikation om den. Kombinationsläkemedel med mer än en aktiv beståndsdel kan sakna styrkebeteckning. Styrkebeteckning används endast i undantagsfall för traditionella växtbaserade läkemedel och växtbaserade läkemedel. |
0..1 |
Sträng (1..200 tecken) |
marknadsfors |
Angivelse av om produkten marknadsförs i Sverige. Sätts till ja av då minst en förpackning marknadsförs. |
1 |
Kod enligt lx-yesno.xsd |
utbytbar |
Angivelse av om läkemedelsprodukten är bedömd som utbytbar mot andra likvärdiga produkter. Beslut om utbytbarhet fattas av Läkemedelsverket. |
1 |
Kod enligt lx-yesno.xsd |
vetrinarlakemedel |
Angivelse av om läkemedlet är ett veterinärläkemedel. |
1 |
Kod enligt lx-yesno.xsd |
atc_kod |
Läkemedelsproduktens klass i enlighet med Anatomic Therapeutic Chemical classification system, ATC. Kommentar: ATC-kod är en klassifikationskod för gruppering av läkemedel i fem nivåer. |
0..1 |
Kod enligt lx-atc-kod.xsd |
godkannande_procedur |
Vilken typ av procedur som har använts när läkemedelsprodukten fick ett försäljningstillstånd. Kommentar: Godkännandeprocedur inte tillämpligt för licensläkemedel och lagerberedningar. |
0..1 |
Kod enligt lx-godkannande-procedur.xsd |
lakemedelsform |
Form som läkemedel förekommer i. Kommentar: Varje läkemedelsform har en kod utfärdad av Läkemedelsverket, samt i de flesta fall en begreppsmappning till det externa kodverket EDQM Standard Terms, benämnt som "EDQM-kod”. I VARA finns Läkemedelsverkets kod i lx-lakemedelsform.xsd. Mappning till EDQM-koden finns i lexikon-data.xml. |
1 |
Kod enligt lx-lakemedelsform.xsd |
parallellimport_fran |
Land som en parallellimporterad/parallellhandlad* läkemedelsprodukt förs in från. Kommentar: Landet måste vara ett medlemsland inom det Europeiska ekonomiska samarbetsområdet (EES). |
0..1 |
Kod enligt lx-land-kod.xsd |
original_nplid |
Läkemedelsprodukt vars produktinformation utgör referens för parallellimporterad/parallellhandlad* läkemedelsprodukt. |
0..1 |
Sträng (14 tecken) |
narkotika_klass |
Kategori av läkemedelsprodukt utifrån om den innehåller narkotika. Kommentar: Narkotikaklass för en läkemedelsprodukt avgörs av om den innehåller en substans vilken i sin tur klassas som narkotika.
|
1 |
Kod enligt lx-narkotika-klass.xsd |
iterering |
Angivelse av om receptiterering är tillåten för en läkemedelsprodukt. Kommentar: Receptiterering innebär att ett recept är avsett att expedieras mer än en gång. Vilka läkemedel som är föremål för begränsningar vid receptiterering föreskrivs i HSLF-FS 2021:75. Anges bara på särskilda läkemedel. |
0..1 |
Kod enligt lx-iterering.xsd |
sarskilt_lakemedel |
Angivelse av om produkten klassas som särskilt läkemedel, för vilket receptförfalskningsrisk föreligger. Kommentar: Vilka läkemedel som avses som särskilda läkemedel föreskrivs i HSLF 2021:75. |
1 |
Kod enligt lx-yesno.xsd |
rikslicens |
Angivelse av om rikslicens är beviljad för en lagerberedning. Kommentar: Rikslicens krävs för lagerberedningar som tillhandahålls i mer än 1000 förpackningar per år, eller om Läkemedelsverket begär det. |
1 |
Kod enligt lx-yesno.xsd |
utokad_overvakning |
Angivelse av om produkten är föremål för utökad övervakning vilket innebär ett särskilt behov av att få in ny säkerhetsinformation. Kommentar: Orsaker till utökad övervakning kan till exempel vara ett läkemedel som innehåller en ny aktiv substans. |
1 |
Kod enligt lx-yesno.xsd |
utlamnandebegransning |
Angivelse av om produkten är föremål för begränsning av förordnande och utlämnande. Kommentar: Exempel på utlämnandebegränsning är att ett läkemedel ska vara förordnat av en läkare med viss specialistkompetens. Vilka läkemedel som är föremål för utlämnandebegränsning samt vilka specifika villkor som gäller föreskrivs i HSLF-FS 2017:74. |
0..1 |
Kod enligt lx-utlamnandebegransning.xsd |
utbytbarheter => utbytbarhet |
Lista med utbytbarhetsgrupper. |
1 |
0 till 2 utbytbarhet-element. |
utbytbarhet |
Uppgifter som beskriver om en läkemedelsprodukt är bedömd som utbytbar mot andra likvärdiga produkter. Kommentar: Utbytbara produkter kategoriseras i utbytbarhetsgrupper avseende styrkebeteckning, läkemedelsform och aktiva substanser. När en produkt avregistreras avpubliceras grupptillhörigheten. En produkt kan endast tillhöra en utbytbarhetsgrupp åt gången, men i samband med pågående byte till annan grupp fortsätter även tillhörigheten till den gamla utbytbarhetsgruppen att publiceras med ett till-och-med-datum. |
0..2 |
Information enligt utbytbarhet, se kap. 13.3 |
enhet_styrka |
Enhet för numerisk styrka. |
0..1 |
Kod enligt lx-enhet-styrka.xsd |
styrka |
Styrka uttryckt som numeriskt värde. |
0..1 |
Decimal (högst 12 tecken varav 3 decimaler) |
farmaceutiska_produkter => farmaceutisk_produkt |
Lista med farmaceutiska produkter. |
1 |
0 eller fler farmaceutisk_produkt-element |
farmaceutisk_produkt |
Fysiskt separerad del av en läkemedelsprodukt med en substans eller sammansättning av substanser. Kommentar: Många läkemedelsprodukter har endast en farmaceutisk produkt, men ibland förekommer två eller fler (till exempel en produkt med både ett pulver och en vätska eller en produkt med två olika slags tabletter). I Nationellt produktregister för läkemedel (NPL) benämns farmaceutisk produkt "tillverkad enhet" i enlighet med ISO-standard (IDMP) för läkemedel. |
0..* |
Information enligt farmaceutisk_produkt, se kap. 13.4 |
artiklar => lmartikel |
Lista med läkemedelsartiklar. |
1 |
1 eller fler lmartikel-element |
lmartikel |
Läkemedelsprodukt tillsammans med sin förpackning. Kommentar: Samma läkemedelsprodukt kan tillhandahållas som olika läkemedelsartiklar som skiljer sig åt vad gäller exempelvis förpackningsstorlek eller förpackningstyp. I Nationellt produktregister för läkemedel NPL benämns läkemedelsartikel "förpackad läkemedelsprodukt" i enlighet med ISO-standard (IDMP) för läkemedel. |
1..* |
Information enligt lmartikel, se kap. 9 och 10 |
*Parallellimport avser läkemedel för människa och parallellhandel läkemedel för djur.
8. Handelsvaruprodukt
Handelsvaruprodukt är en typ som innehåller information från bastypen Produkt och som utöver det innehåller information specifik för handelsvaruprodukter.
8.1. Fältbeskrivningar
Tabell 7. Fältbeskrivningar för handelsvaruprodukt.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
produkt_benamning |
Innehåller en utförlig beskrivning av produktens egenskaper. |
0..1 |
Sträng (1..250 tecken) |
produkt_beskrivning |
Allmän upplysning om produkten t.ex. uppgifter om ett specifikt material. |
0..1 |
Sträng (1..250 tecken) |
handelsvarugrupp |
Klassifikationskod för gruppering av handelsvaror i fem nivåer. |
1 |
Kod enligt lx-handelsvarugrupp.xsd |
artiklar => artikel eller tjanst |
Lista med artiklar eller tjänster, dvs försäljningsbara varor. |
1 |
1 eller fler handelsvara-element alt. 1 eller fler tjanst-element |
artikel eller tjanst |
Element som beskriver den information som finns på en artikel eller tjänst. |
1..* |
Information enligt tjanst eller handelsvara, se kap. 11och 12.
|
9. Artikel
Artikel är en bastyp som innehåller gemensam information för läkemedelsartikel, handelsvara och tjänst.
9.1. Fältbeskrivningar
Tabell 8. Fältbeskrivningar för artikel.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
|
version |
Artikelns versionsnummer. |
1 |
Sträng enligt: X Y där X och Y är nummerföljder i stigande ordning. |
|
varunummer |
Unik identifierare för handelsvaruartikel och icke-unik identifierare av läkemedelsartikel. Kommentar: Varunumret är 6-siffrigt. För handelsvaruartiklar (förbrukningsartiklar, teknisk sprit och livsmedel till barn under 16 år) är varunummer den unika identiteten och används därför som identifierare vid förskrivning. För läkemedel är varunummer inte alltid unikt. Samma varunummer kan förekomma för flera olika läkemedelsartiklar, till exempel vid parallellimport. Varunumret kan även ändras över tid. Vid förskrivning av läkemedel används därför NPL-id och NPL-pack-id som identifierare. |
0..1 |
Sträng (6 tecken) Alla sex tecken är siffror. Utfyllnad med 0:or i början. |
|
identitet => artikel_id |
Lista med id-begrepp kopplade till artikeln. |
1 |
1 eller fler artikel_id-element |
|
artikel_id |
Representerar ett id-begrepp, med typ och id-nummer. |
1..* |
Attribut för typ och id. |
|
forskrivningsratt => artikel_forskrivningsratt |
Lista med förskrivningsrätter. |
1 |
0 eller fler artikel_forskrivningsratt-element |
|
artikel_forskrivningsratt |
Yrkeskategori som har rätt att förskriva artikeln. Kommentar: För läkemedel innebär värdet "ospecificerad" att läkare och veterinärer har förskrivningsrätt. |
0..* |
Kod enligt lx-forskrivningsratt.xsd |
|
pris => pris_artikel |
Lista med priser kopplade till artikeln. |
1 |
0 eller max 2 pris_artikel-element |
|
pris_artikel |
Pris på artikel. |
0..2 |
Information enligt pris_artikel, se kap. 13.10 |
|
intressent_ref |
Organisation som har en roll i relation till artikeln. Kommentar: Referens till en intressent i listan med intressenter samt dess roll i relation till artikeln. |
0..1 |
Attribut för referens-id och definierad roll för organisation. Se kap 13.8 |
|
forvaring => forvaringsfall |
Lista med förvaringsfall. |
1 |
0 eller fler forvaringsfall-element |
|
forvaringsfall |
Omständigheter och betingelser för vilka uppgifter om hållbarhet gäller för en farmaceutisk produkt för en läkemedelsartikel. Kommentar: Endast generella förvaringsfall publiceras i nuläget. |
0..* |
Information enligt forvaringsfall, se kap. 13.11 |
|
antal_klartext |
Automatgenererad text som anger mängd i förpackning, uppdelad på eventuella inre förpackningar, samt tillhörande måttenhet. Exempel:
|
0..1 |
Sträng (1..50 tecken) |
|
antal_multipel_1 |
Förpackningsmultipel, del av beskrivning av förpackningsstorlek. Se kommentar på antal multipel 2. |
0..1 |
Decimal (högst 6 tecken varav 0 decimaler) |
|
antal_multipel_2 |
Förpackningsmultipel, del av beskrivning av förpackningsstorlek. Kommentar: I de fall förpackningen består av flera enheter kan dessa specificeras med förpackningsmultiplar. Exmpel: Ett injektionsläkemedel innehåller 60 ampuller förpackade som 6 stycken enheter med 10 ampuller i varje enhet. Varje ampull innehåller 5 ml. I dessa fall specificeras multipel 1 som 10 och multipel 2 som 6, antal numeriskt blir 5 och antal numerisk enhet blir milliliter. |
0..1 |
Decimal (högst 6 tecken varav 0 decimaler) |
|
antal_numeriskt |
Antal i förpackning. Se kommentar på antal multipel 2. |
0..1 |
Decimal (högst 9 tecken varav 3 decimaler) |
|
antal_numerisk_enhet |
Måttenhet för antal numeriskt. |
0..1 |
Kod enligt lx-antal-numerisk-enhet.xsd |
|
artikel_benamning |
Sammansatt beskrivning av artikel. Kommentar: Artikelbenämning för läkemedel innehåller produktnamn, läkemedelsform, styrkebeteckning (styrka_klartext) och i vissa fall intressent.
Förkortningar kan förekomma. Exempel:
|
0..1 |
Sträng (1..80 tecken) |
|
beskrivning |
Beskrivning av artikeln. Kommentar: Används bara för handelsvaror. |
0..1 |
Sträng (1..100 tecken) |
|
forman |
Angivelse av om artikeln ingår i förmånen. |
1 |
Kod enligt lx-yesno.xsd |
|
forpackning_text |
Beskrivning av läkemedelsartikeln. Kommentar: Kan beroende på läkemedelsartikel inkludera antal farmaceutiska produkter, total mängd per farmaceutisk produkt, beskrivning av ytterförpackning samt organisationsnamn för parallelldistributör. Innehåller viktiga detaljer för val av rätt artikel vid beställning och expediering. Exempel:
|
0..1 |
Sträng (1..255 tecken) |
|
forsaljningsstopp |
Angivelse av om artikeln är försäljningsstoppad av Läkemedelsverket. |
1 |
Kod enligt lx-yesno.xsd |
|
forsaljningsstopp_kommentar_vara |
E-hälsomyndighetens kommentar vid försäljningsstopp |
0..1 |
Sträng (80 tecken) |
|
forsaljnings_restriktion=> forsaljnings_restriktion |
Lista med försäljningsrestriktioner. |
1 |
0 eller fler forsaljnings_restriktion-element
|
|
forsaljnings_restriktion |
Angivelse av om läkemedelsartikeln är föremål för försäljningsrestriktion vid andra försäljningsställen än öppenvårdsapotek. Kommentar: Används endast för receptfria läkemedel. Försäljningsrestriktion föreskrivs i LVFS 2009:20. |
0..* |
Kod enligt lx-forsaljnings-restriktion.xsd |
|
innehaller_latex |
Angivelse av om en artikel innehåller latex. Kommentar: Anges inte på licensläkemedel. |
0..1 |
Kod enligt lx-yesno.xsd |
|
receptbelagd |
Angivelse av om artikeln kategoriseras som receptbelagd. |
1 |
Kod enligt lx-yesno.xsd |
|
avregistreringsdatum |
Läkemedel: Datum för avregistrering av läkemedelsartikelns försäljningstillstånd. Handelsvaror: Datum för när handelsvaruartikeln utträder ur förmånen. Kommentar:
För handelsvaror gäller att handelsvaruartikeln ingår i förmånen till och med detta datum. |
0..1 |
Datum enligt ÅÅÅÅ-MM-DD |
|
forpacknings_typ_inre |
Typ av förpackning. Exempel: blister, burk, dospåse |
0..1 |
Kod enligt lx-forpackningstyp-inre.xsd |
|
varutyp |
Artikelns varutyp. |
1 |
Kod enligt lx-produkt-varutyp.xsd |
|
tlv-substitution => tlv-utbytesperiod |
Lista med information om periodens vara-perioder (föregående, gällande och kommande period). |
1 |
0 till 3 st element av typen tlv-utbytesperiod |
|
tlv-utbytesperiod |
Information om periodens vara från TLV. |
0..3 |
Information enligt tlv-utbytesperiod, se kap. 13.12 |
|
streckkod |
Artikelns gällande streckkod. |
0..1 |
Sträng (14 tecken) |
10. Läkemedelsartikel
Läkemedelsartikel är en typ som innehåller information från bastypen Artikel och som utöver det innehåller information specifik för läkemedelsartiklar.
10.1. Fältbeskrivningar
Tabell 9. Fältbeskrivningar för läkemedelsartikel.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
nplpackid |
Nationell unik identifierare av en läkemedelsartikel. Kommentar: Format NPL-pack-id: 14 siffror på formatet YYYYMMDD1NNNNN, där YYYY är år, MM är månad, DD är dag, NNNNN är ett produktnummer. För läkemedelsartiklar som skapats av E-hälsomyndigheten anges SB-pack-id med formatet SBNNNNNNNNNNNN. |
1 |
Sträng (14 tecken) Exempel: NPLpack id 20070308100102 SBpack id SB050114100007 |
europeiskt_godkannandenr |
EU Marketing Authorization number, EU-gemensamt försäljningstillståndsnummer där identifiering av läkemedelsartikel är inkluderad. Kommentar: Format EU/N/YY/NNN(N)/NNN där första siffran är 1 för humana läkemedel, 2 för veterinära, YY är år, nästa de sista 3-4 siffror är ett produktnummer och de sista 3 siffrorna ett förpackningsnummer. Ej unikt nummer, eftersom produktbegreppet enligt EMA-definitionen och den svenska definitionen skiljer sig åt. |
0..1 |
Sträng (15..16 tecken) |
endast_dos |
Angivelse av om artikeln endast får användas för dosdispensering. |
1 |
Kod enligt lx-yesno.xsd |
endast_sjukhusbruk |
Angivelse av om artikeln endast får användas för sjukhusbruk. |
1 |
Kod enligt lx-yesno.xsd |
artikel_utbytbar |
Angivelse av om artikeln är utbytbar. Kommentar: Detta fält skall ärvas från produkten i normalfallet, men det finns artiklar som inte är utbytbara trots att produkten anger det. Om det avviker från produkten måste en orsak anges i artikel_utbytbar_orsak. |
1 |
Kod enligt lx-yesno.xsd |
artikel_utbytbar_orsak |
Anger orsak till om artikeln inte är utbytbar trots att produkten är det. |
0..1 |
Sträng (1..80 tecken) |
ddd_per_forpackning |
Anger hur många Definierade DygnsDoser (DDD) förpackningen innehåller. |
0..1 |
Decimal (högst 8 tecken, varav 3 decimaler) |
marknadsfors |
Angivelse av om artikeln marknadsförs i Sverige. |
1 |
Kod enligt lx-yesno.xsd |
sakerhetsdetaljer |
Angivelse av om läkemedelsartikeln skall förses med särskilda säkerhetsdetaljer på ytterförpackningen. Kommentar: Säkerhetsdetaljer beskrivs i EU-direktiv 2001/83/EC Artikel 54. |
1 |
Kod enligt lx-yesno.xsd |
11. Handelsvara
Handelsvara är en typ som innehåller information från bastypen artikel och som utöver det innehåller information specifik för handelsvaror.
11.1. Fältbeskrivningar
Tabell 10. Fältbeskrivning för handelsvara.
Element/Attribut |
Beskrivning |
Mult. |
Innehåller |
handelsvarugrupp |
Klassifikationskod för gruppering av handelsvaror i fem nivåer. Sätts alltid till – i nuläget. |
1 |
Kod enligt lx-handelsvarugrupp.xsd |
12. Tjanst
Tjänst är en typ som innehåller information från bastypen artikel.
13. Övriga typ-definitioner
13.1. artikel_id
Beskriver en artikels identifikations-begrepp.
Tabell 11. Typ-definitioner för artikel_id.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
artikel_id_typ |
Kod för artikelns identifikations-typ. |
1 |
Kod enligt lx-artikel-id-typ.xsd |
id_varde |
Identifikationsnummer eller kod. |
1 |
Sträng (1..70 tecken) |
gfrom_datum |
Giltigt från och med datum. |
1 |
Datum enligt ÅÅÅÅ-MM-DD |
tom_datum |
Giltigt till och med datum. |
0..1 |
Datum enligt ÅÅÅÅ-MM-DD |
13.2. produkt_namn
Beskriver ett namn för produkten.
Tabell 12. Typdefinitioner för produkt_namn.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
produkt_namn_typ |
Kod för produktens namn-typ. |
1 |
Kod enligt lx-produkt-namn-typ.xsd |
namn |
Produktens namn. |
1 |
Sträng (1..100 tecken) |
gfrom_datum |
Giltigt från och med datum. |
1 |
Datum enligt ÅÅÅÅ-MM-DD |
tom_datum |
Giltigt till och med datum. |
0..1 |
Datum enligt ÅÅÅÅ-MM-DD |
13.3. utbytbarhet
Uppgifter som beskriver om en läkemedelsprodukt är bedömd som utbytbar mot andra likvärdiga produkter.
Tabell 13. Typ-definitioner för utbytbarhet.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
utbytbarhet_form_grupp |
Utbytbarhetsgrupp avseende läkemedelsform som läkemedelsprodukten tillhör. |
1 |
Kod enligt lx-utbytbarhet-form-grupp.xsd |
utbytbarhet_styrka_grupp |
Utbytbarhetsgrupp avseende styrkebeteckning som läkemedelsprodukten tillhör. |
1 |
Kod enligt lx-utbytbarhet-styrka-grupp.xsd |
utbytbarhet_substans_grupp |
Utbytbarhetsgrupp avseende aktiva substanser som läkemedelsprodukten tillhör. |
1 |
Kod enligt lx-utbytbarhet-substans-grupp.xsd |
gfrom_datum |
Datum från och med vilket en läkemedelsprodukt tillhör en utbytbarhetsgrupp. |
1 |
Datum enligt ÅÅÅÅ-MM-DD |
tom_datum |
Datum till och med vilket en läkemedelsprodukt tillhör en utbytbarhetsgrupp. |
0..1 |
Datum enligt ÅÅÅÅ-MM-DD |
13.4. farmaceutisk_produkt
Fysiskt separerad del av en läkemedelsprodukt med en substans eller sammansättning av substanser.
Tabell 14. Typ-definitioner för farmaceutisk_produkt.
Element/Attribut |
Beskrivning |
Mult. |
Innehåller |
beskrivning |
Benämning på den farmaceutiska produkten. Kommentar: Kan till exempel inkludera färg (”Blå tablett”, ”Gul tablett”). Används främst för läkemedelsprodukter med fler än en farmaceutisk produkt. |
0..1 |
Sträng (1..40 tecken) |
refererande_mangd |
Måttenhet i nämnaren för mängden av varje beståndsdel i den farmaceutiska produkten. Kommentar: Mängden av varje beståndsdel uttrycks som en fraktion, till exempel ”10 mg per ml”, ”20 mikrog per tillverkad enhet”. Täljarenheten (bestandsdel_enhet) kan skilja sig mellan olika beståndsdelar medan nämnarenheten (refererande_mängd) alltid är densamma för alla beståndsdelar i den farmaceutiska produkten. |
1 |
Kod enligt lx-refererande-mangd.xsd |
pharmaceutical_product_id_npl |
Unik identifierare för en farmaceutisk produkt. |
1 |
Sträng (1..18 tecken) |
bestandsdelar => bestandsdel |
Lista med beståndsdelar. |
1 |
0 eller fler bestandsdel-element |
bestandsdel |
Beskriver en beståndsdel eller en referenssubstans.
Kommentar: Beståndsdelsrollen avgör om det är en beståndsdel eller en referenssubstans. Referenssubstanser har rollen ”aktiv motsvarande” i relation till en aktiv beståndsdel eller rollen ”adjuvant motsvarande” i relation till en adjuvans. För en utförlig beskrivning av hur beståndsdelar och referenser förhåller sig till varandra, se informationspsspecifikationen för NPL, bilaga 1. |
0..* |
Information enligt bestandsdel, se kap. 13.5 |
13.5. bestandsdel
Beskriver en beståndsdel eller en referenssubstans.
Tabell 15. Typ-definitioner för bestandsdel.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
bestandsdel_id_ext |
Unik identifierare av en beståndsdel/referenssubstans. |
1 |
Sträng (1..18 tecken) |
bestandsdels_id_relation |
Beståndsdel som en referenssubstans refererar till. Kommentar: Förekommer endast för referenssubstanser. |
0..1 |
Sträng (1..18 tecken) |
bestandsdel_mangd |
Täljarvärde för mängden av en beståndsdel/referenssubstans. Kommentar: Den kompletta mängdangivelsen för substansen ges av mängd (bestandsdel_mangd) och täljarenhet (bestandsdel_enhet) tillsammans med nämnarenhet (refererande_mangd) för den farmaceutiska produkten. |
0..1 |
Decimal (Högst 12 tecken varav 3 decimaler) |
bestandsdel_enhet |
Måttenhet i täljaren för mängden. |
0..1 |
Kod enligt lx-bestandsdel-enhet.xsd |
bestandsdel_roll |
Roll en beståndsdel/referenssubstans antar i relation till en farmaceutisk produkt. Kommentar: Beståndsdelsrollen avgör om det är en beståndsdel eller en referenssubstans. Referenssubstanser har rollen ”aktiv motsvarande” i relation till en aktiv beståndsdel eller rollen ”adjuvant motsvarande” i relation till en adjuvans. För en utförlig beskrivning av hur beståndsdelar och referenser förhåller sig till varandra, se Informationspsspecifikation NPL, bilaga 1. |
1 |
Kod enligt lx-bestandsdel-roll.xsd |
bestandsdel_tillaggsenhet |
Ytterligare information om mängden. Kommentar: Används exempelvis för att visa när värdet är ungefärligt (”ca 10 mg”) eller i de fall där ett värde saknas helt (”tillsätts i behövlig mängd”). Används även för att indikera att en beståndsdel kan ingå i produkten, men inte behöver göra det. |
0..1 |
Kod enligt lx-bestandsdel-tillagsenhet.xsd |
substans_ref |
Element som representerar en referens till en substans i listan med substanser. |
1 |
Attribut ref med strängkod enligt xs:IDREF Se kap 13.6 |
13.6. substans
Den substans vilken antar rollen som beståndsdel eller referenssubstans i den farmaceutiska produkten.
Tabell 16. Typ-definitioner för substans.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältländ) |
svenskt_namn |
Rekommenderat svenskt namn på substans (från NSL). |
1 |
Sträng (1..1000 tecken) |
cas_nummer |
Identifikationsnummer enligt Chemical Abstract Service Number. |
0..1 |
Sträng (1..12 tecken) |
nplsubstansid |
Substansens unika id. |
1 |
Sträng (1..18 tecken) |
relationer=> relation |
Lista med substansens mor-dotterrelationer. |
1 |
0 eller fler relation-element |
relation |
Beskriver vilka substanser som den aktuella substansen har en relation till. |
0..* |
Information enligt relation, se kap. 13.7 |
id |
XML-id för referens från andra element. |
|
Strängkod enligt xs:ID |
13.7. relation
Beskriver relationen mellan två substanser.
Tabell 17. Typ-definitioner för relation.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältländ) |
substans_id_relation |
Substans-id för den substans som det finns en relation till. |
1 |
Sträng (1..18 tecken) |
relationstyp |
Beskriver relationen mellan två substanser. Kan vara "Child" eller "Parent". "Child" innebär att denna substans är dotter, "Parent" innebär att att substansen är moder. Ex. klopidogrelhydroklorid är Child (i relation med klopidogrel). |
1 |
Kod enligt lx-substansrelation |
13.8. intressent
Organisation som har en roll i relation till en viss produkt.
Tabell 18. Typ-definitioner för intressent.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
namn |
Namn på organisationen. |
1 |
Sträng (1..160 tecken) |
intressent_id_ext |
Unik identifierare av en intressent. |
1 |
Sträng (1..18 tecken) |
momsnummer |
Momsregistreringsnummer, unikt serienummer som tilldelas alla som registreras för redovisning av moms. Kommentar: Utfärdas av Skatteverket. |
0..1 |
Sträng (1..20 tecken) |
adress |
Postadress till organisationen. Kommentar: Adressen består av upp till fyra adressrader, där formatet varierar för olika organisationer (postnummer och postort kan till exempel vara sammanslaget på en adressrad eller uppdelat på två olika). |
0..1 |
Information enligt adress, se kap. 13.9 |
id |
Unik identifierare för referens inom XML-filen. |
1 |
Strängkod enligt xs:ID |
13.9. adress
Beskriver en organisations adress.
Tabell 19. Typ-definitioner för adress.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
adress_1 |
Adressrad 1. |
0..1 |
Sträng (1..60 tecken) |
adress_2 |
Adressrad 2. |
0..1 |
Sträng (1..60 tecken) |
adress_3 |
Adressrad 3. |
0..1 |
Sträng (1..60 tecken) |
adress_4 |
Adressrad 4. |
0..1 |
Sträng (1..60 tecken) |
land_kod |
Land där adressen är belägen. Kommentar: Trebokstaviga landskoder enligt ISO 3166-1 alpha-3. |
1 |
Kod enligt lx-land-kod.xsd |
13.10. pris_artikel
Beskriver ett pris för en förpackning/artikel.
Tabell 20. Typ-definitioner för pris_artikel.
Element/Attribut |
Beskrivning |
Mult. |
Innehåller |
aip |
Apotekens inköpspris (AIP) som beslutats av TLV för artiklar som ingår i förmånssystemet. |
1 |
Decimal (högst 9 tecken varav 2 decimaler) |
aup |
Apotekens utförsäljningspris (AUP) som beslutas av TLV för artiklar som ingår i förmånssystemet. För mer information om t.ex. moms hänvisas till TLV. |
1 |
Decimal (högst 9 tecken varav 2 decimaler) |
gfrom_datum |
Giltigt från och med datum. |
1 |
Datum enligt ÅÅÅÅ-MM-DD |
gtom_datum |
Giltigt till och med datum. |
0..1 |
Datum enligt ÅÅÅÅ-MM-DD |
pristyp |
Anger TLVs pristyp för artikeln. |
0..1 |
Kod enligt lx-pristyp.xsd |
begransad_subvention |
Eventuell begränsning av förmånen beslutad av TLV. Exempel: För diabetes typ2 patienter måste BMI vara minst 28 för subvention. För övriga ska BMI vara minst 35. |
0..1 |
Sträng (1..2000 tecken) |
13.11. forvaringsfall
Omständigheter och betingelser för vilka uppgifter om hållbarhet gäller för en farmaceutisk produkt för en läkemedelsartikel.
Tabell 21. Typ-definitioner för forvaringsfall.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
forvaringsfall_typ |
Typ av förvaringsfall. |
1 |
Kod enligt lx-forvaringsfall.xsd |
forvaringsfallkod_ext |
Unik identifierare av ett förvaringsfall. |
0..1 |
Sträng (1..18 tecken) |
farmaceutisk_produkt_id |
Farmaceutisk produkt som förvaringsfallet gäller för. Kommentar: Refererar till identifieraren för den farmaceutiska produkten. |
0..1 |
Sträng (1..18 tecken) |
hallbarhet_enhet |
Måttenhet för hållbarhetstiden. |
1 |
Kod enligt lx-hallbarhet-enhet.xsd |
forvarings_temperatur |
Temperaturbetingelser för att hållbarhetstiden ska gälla. |
1 |
Kod enligt lx-forvaringsfall-temperaturt.xsd |
hallbarhet |
Den tidsperiod från tillverkningstillfället som en farmcautisk produkt för en läkemedelsartikel vid rätt förvaring givet förvaringsfallet är lämplig för användning. |
0..1 |
Integer (9 tecken) |
13.12. tlv-utbytesperiod
Beskriver en artikels medverkan i en utbytesperiod från TLV.
Tabell 22. Typ-definitioner för tlv-utbytesperiod.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
klusterid |
Id för storlekskluster. |
1 |
Sträng (8 tecken) |
periodens-vara=> flagga-med-datum och flagga-med-datum-rang |
Anger om artikeln är eller har varit periodens vara. |
1 |
Y eller N och ett datum samt rang enligt flagga-med-datum-rang se kap. 13.13 och 13.14 |
Bestallningsstopp => flagga-med-datum och flagga-med-datum-rang |
Anger om artikeln har blivit beställningsstoppad under perioden. |
1 |
Y eller N och ett datum samt historisk rang enligt flagga-med-datum-rang, se kap. 13.13 och 13.14 |
aipperenhet |
Artikelns aip per enhet. |
0..1 |
Decimal (högst 9 tecken varav 2 decimaler) |
aupperenhet |
Artikelns aip per enhet. |
0..1 |
Decimal (högst 9 tecken varav 2 decimaler) |
start_datum |
Periodens startdatum. |
1 |
Datum enligt ÅÅÅÅ-MM-DD |
stopp_datum |
Periodens stoppdatum. |
1 |
Datum enligt ÅÅÅÅ-MM-DD |
13.13. flagga-med-datum
Beskriver en flagga tillsammans med ett datum då flaggan sattes.
Tabell 23. Typ-definitioner för flagga-med-datum.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
start_datum |
Startdatum för när flaggan börjar gälla. |
0..1 |
Datum enligt ÅÅÅÅ-MM-DD |
flagga |
|
1 |
Y eller N |
13.14. flagga-med-datum-rang
Utökning av typen flagga-med-datum.
Tabell 24. Typdefinitioner för flagga-med-datum-rang.
Element/Attribut |
Beskrivning |
Mult. |
Typ (fältlängd) |
rang |
Attribut som beskriver artikelns rang (Synligt om flagga = Y). |
0..1 |
Integer (får endast anta värde 0,1,2 eller 3) |
historisk-rang |
Attribut som beskriver artikelns historiska rang (Synligt om flagga = Y). |
0..1 |
Integer (får endast anta värde 0,1,2 eller 3) |
Versionshistorik
Version |
Datum |
Release |
Kommentar |
---|---|---|---|
1.0 | 2021-11-27 |
|
Ny handbok vård- och apotekstjänster |
1.1 | 2022-02-02 |
|
Rättning av stavfel. Lagt tabelltext över tabeller. |
1.2 | 2022-05-18 |
|
Korrigerat 13.11 forvarings_temperatur |
1.3 | 2022-03-23 |
|
Tabell 1. Uppdaterat DNS-namn sftp-server |
1.4 | 2025-08-28 | 21.14 | Justering av beskrivningar, huvudsakligen för att harmonisera med Nationellt produktregister för läkemedel (NPL) hos Läkemedelsverket. |