VARA Export

Bilaga till handboken för apoteksaktörer och vårdaktörer djur

Dokumentation av XML Schema version 2.0

 

 

 

 

1 Inledning

Dokumentet beskriver XML-schemat för eHälsomyndighetens VARA-exportfil. Dokumentet är alltså i sig inte en specifikation av export-formatet utan en kompletterande dokumentation. Vid användning av VARA-exportfil ska xml-specifikationen användas tillsammans med dokumentet VARA - bilaga till handboken för vård- och apoteksaktörer, för att användaren ska få vetskap om eHälsomyndighetens krav vid användande av VARA i system.

Detta dokuments version överensstämmer inte med xml-schemats version, istället står det uttryckligen i dokumentets huvudrubrik vilken version av XML-schemat som dokumentet gäller för.

1.1 Kort beskrivning

eHälsomyndighetens VARA-register exporteras som tre stycken XML-filer och strukturen för denna specificeras i ett antal xml-scheman (xsd) som också bifogas vid varje export.

DNS-namn sftp-server	sftp.receptpartner.se
Protokoll	sftp
Filnamn	vara-export.zip

Tabell med teknisk information för VARA-exportfil

2 Informationsinnehåll i VARA

Sortimentet i VARA är det nationellt gemensamma, det vill säga samtliga läkemedel och handelsvaror inom förmånen. 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 dokumentet VARA - bilaga till handboken för vård- och apoteksaktörer 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 Definitioner och 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

3 Schemastruktur

Exportformatet är specificerat i ett antal inbördes beroende xml-scheman (xsd:er), med följande struktur

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, definerar tillåtna värden för ett visst element. T.ex. atc-koder, enheter lands-koder 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 skall 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 t.ex. 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, t.ex. 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 bl.a. 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 t.ex. 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 och beroende dessutom på aktuellt datum, t.ex. 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.

Det bör också noteras 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

5.1 Fältbeskrivningar

Element/Attribut	Beskrivning	Innehåller
envelope	Rooten för xml-filen	Se nedan
schemaVersion	Aktuell schema-version som xml-filen följer	En sträng som motsvarar schemaversionen, t.ex. 0.85-draft
timeStamp	Tidsstämpel då filen skapades	Datum/tid av format: xs:dateTime
info	Behållare för allmän information om filen
antal_produkter	Anger antalet produkter i filen	Ett positivt heltal
leveransinfo	Allmänna kommentarer om den aktuella exportfilen	Sträng om max 250 tecken.
referenser	Behållare för element som refereras till från andra element.	Elementen: intressenter och substanser
intressenter	Lista med alla intressenter, d.v.s. aktörer av olika typ, som förekommer i produktlistan.	0 eller fler element av typen def:intressent
substanser	Lista med alla substanser som förekommer i produktlistan.	0 eller fler element av typen def:substans
produkter	Produktlistan	0 eller fler element av typen def:lmprodukt alt. 0 eller fler element av typen def:hvprodukt

6 Produkt

Produkt är en bastyp som innehåller gemensam information för läkemedelsprodukt och handelsvaruprodukt.

6.1 Fältbeskrivningar

I kolumnen "Beskrivning" framgår vilken källägaren är till elementet till exempel myndighet eller företag. Det kan ha betydelse för vilka informationsfält som är relevanta att visa i systemen. eHälsomyndigheten rekommenderar att urval av vilka element som ska visas i systemen ska ske i samarbete med personer som har farmaceutisk verksamhetskompetens.

Element/Attribut	Beskrivning	Innehåller
version	Produktens versionsnummer	Sträng enligt: X.YZ där X, Y och Z är nummerföljder i stigande ordning.
produktnamn	Produktens aktuella handelsnamn. Informationen ägs av företaget som marknadsför produkten.	Sträng om max 100 tecken
identitet => produkt_id	Lista med tilläggsidentiteter för produkten	0 eller fler produkt_id element
produkt_id	Element som beskriver ett identitetbegrepp med tillhörande typ	Attribut för typ och id.
tillagsnamn => produkt_namn	Lista med produktens övriga namn samt historiska namn	1 eller fler produkt_namn element
produkt_namn	Element som beskriver ett produktnamn med tillhörande typ.	Attribut för typ och namn
intressenter => intressent_ref	Lista med referenser till intressenter.	1 eller fler intressent_ref element
intressent_ref	Element som representerar en referens till en intressent i listan med intressenter. Se kap 13.10	Attribut för referens-id och definierad ansvarsroll (roll) för legal organisation. Endast MAH (Marketing Authorisation Holder), Ombud, Tillverkare, Ompackare eller Registreringsinnehavare används i NPL.
forsaljningsstopp	Anger om produkten är försäljningsstoppad av LV.	Ja (Y), Nej (N) eller Ospecificerat (-)
forsaljningsstopp_kommentar_vara	eHälsomyndigheten kommentar vid försäljningsstoppad produkt	Sträng om max 80 tecken
innehaller_laktos	Anger om produkten innehåller laktos	Ja (Y), Nej (N) eller Ospecificerat (-)
innehaller_latex	Anger om produkten innehåller latex	Strängkod enligt lx-innehaller-latexd.xsd
gruppvarunummer	Anger om produkten tillhör ett gruppvarunummer	Y (Ja), N (Nej)
produkt_kommentar	Fritext element för företaget att ge kommentarer som gäller för produkten inklusive samtliga förpackningar.	Sträng om högst 250 tecken
asab_kommentar	Fritext element för eHälsomyndigheten att ange kommentar som gäller produkten inklusive samtliga förpackningar.	Sträng om max 80 tecken
receptbelagd	Anger om produktens alla artiklar är receptbelagd eller inte. Kan förekomma att vissa artiklar är undantagna receptbeläggning. Informationen ägs av LV.	Strängkod enligt lx-receptbelagd.xsd
avregistreringsdatum	Produktens avregistreringsdatum. Informationen ägs av LV.	Datum (ÅÅÅÅ-MM-DD)
produkt_typ	Produktens klassificering. Informationen ägs av LV.	Sträng-kod enligt lx-produkt-typ.xsd
lakemedel	Flagga för om produkten är ett läkemedel	Y (Ja), N (Nej) eller - (ospecificerat)

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

Element/Attribut	Beskrivning	Innehåller
nplid	Innehåller antingen Läke­medels­produktens unika identitet i NPL, alternativt, för läkemedel som ej finns i NPL, innehåller fältet ett unikt SB-id. NPLId ägs av LV och SBId ägs av eHälsomyndigheten.	Sträng om 14 tecken Exempel NPLID: 20050721000081 SBID: SB991110000001
godkannandenr	Godkännandenummer från LV.	Nummer om 6 st siffror utan decimaler.
antidot	Anger om produkten är klassad som en antidot av GIC. Informationen ägs av GIC.	Y (Ja), N (Nej) eller - (ospecificerat)
avvikelse_parallell_import	Beskrivande text från LV som anger eventuella avvikelser i utseende för parallellimporterat läkemedel i jämförelse med originalläkemedel. Informationen ägs av LV.	Text om högst 250 tecken
ddd	Statistiskt mått som fastställs av WHO. Förmodad genomsnittlig dygnsdos då läkemedlet används av en vuxen vid läkemedlets huvudindikation.	Nummer om högst 8 siffror och 3 stycken decimaler.
enhet_ddd	Enheten till ddd elementet	Kod enligt lx-enhet-ddd.xsd
doseringsenhet	Anger i vilken enhet en läkemedels­produkt avses doseras	Kod enligt lx-doseringsenhet.xsd
dos_bryttillstand	Anger om LV har beviljat bryttillstånd för dosdispensering.	Y (Ja), N (Nej) eller - (ospecificerat)
dos_bryttillstand_hallbar	Anger hållbarheten (i månader) vid dosdispensering. Informationen ägs av LV	Heltal om högst 6 siffror
godkannande_datum	Datum då LV alternativt EMEA godkände läkemedlet	Datum enligt ÅÅÅÅ-MM-DD
styrka_klartext	Produktens styrka i fritext t.ex. 500 mg. Vissa läkemedel som t.ex. kombinationsläkemedel kan sakna styrka. Informationen ägs av LV	Text om högst 80 tecken
marknadsfors	Anger om produkten marknadsförs. Informationen ägs av företaget som marknadsför produkten.	Y (Ja), N (Nej) eller - (ospecificerat)
marknadsfors_from	I de fall produkten inte marknadsförs kan företaget ange ett datum då produkten åter marknadsförs. Informationen ägs av företaget som marknadsför produkten.	Datum enligt ÅÅÅÅ-MM-DD
utbytbar	Anger om läkemedlet är utbytbart mot annat läkemedel enligt beslut av LV.	Y (Ja), N (Nej) eller - (ospecificerat)
vetrinarlakemedel	Anger om läkemedlet är ett veterinärläkemedel.	Y (Ja), N (Nej) eller - (ospecificerat)
atc_kod	Klassifikationskod för gruppering av läkemedel i fem nivåer. Fastställs av WHO.	Sträng-kod enligt lx-atc-kod.xsd
godkannande_procedur	Anger godkännandeprocedur t.ex. decentraliserad procedur. Informationen ägs av LV	Kod enligt lx-godkannande-procedur.xsd
lakemedelsform	Produktens läkemedelsform. Informationen ägs av LV	Sträng-kod enligt lx-lakemedelsform.xsd
lakemedelsform_grupp	Kod för Läkemedelsform grupp. LV gruppering av läkemedelsformer	Sträng-kod enligt lx-lakemedelsform-grupp.xsd
parallellimport_fran	Landskod för parallellimporterat läkemedel Informationen ägs av LV	Landskod enligt lx-land-kod.xsd
original_nplid	Ett parallellimporterat läkemedels originalNPLid Informationen ägs av LV	Sträng-kod om 14 tecken
narkotika_klass	Anger läkemedlets eventuella narkotikaklassificering. Informationen ägs av LV	Sträng-kod enligt lx-narkotika-klass.xsd
sarskilda_lakemedel	Anger läkemedlets eventuella klassning som särskilt läkemedel t.ex. Särskild receptblankett krävs. Recepten får itereras i enlighet med HSLF-FS 2016:34	Sträng-kod enligt lx-sarskilda-lakemedel.xsd
utbytbarheter => utbytbarhet	Lista med utbarhetsgrupper. Se kap 13.5.	0 till 2 utbytbarhet element
enhet_styrka	Kod för enhet på produktens styrka	Strängkod enligt lx-enhet-styrka.xsd
styrka	Styrka angett som numeriskt värde Informationen ägs av företaget som marknadsför produkten.	Nummer om högst 12 siffror och 3 decimaler
farmaceutiska_produkter => farmaceutisk_produkt	Lista med farmaceutiska produkter, exempelvis ampull a och ampull b. En farmaceutisk produkt består i sin tur av en eller flera beståndsdelar Se kap. 13.6 Informationen ägs av LV	0 eller fler farmaceutisk_produkt element
artiklar => lmartikel	Lista med läkemedelsartiklar, d.v.s. försäljningsbara varor. Se kap 9 och 10.	1 eller fler lmartikel element

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

Element/Attribut	Beskrivning	Innehåller
produkt_benamning	Innehåller en utförlig beskrivning av framförallt handelsvarors egenskaper.	Text om högst 250 tecken.
produkt_beskrivning	Allmän upplysning om formen t.ex. uppgifter om ett specifikt material som akryl.	Text om högst 250 tecken
handelsvarugrupp	Klassifikationskod för gruppering av handelsvaror i fem nivåer. Informationen ägs av TLV	Sträng-kod enligt lx-handelsvarugrupp.xsd
artiklar => artikel | tjanst	Lista med artiklar eller tjänster, dvs försäljningsbara varor. Se kap 9 och 11.	1 eller fler handelsvara element alt. 1 eller fler tjanst element

 

9 Artikel

Artikel är en bastyp som innehåller gemensam information för läkemedelsartikel, handelsvara och tjänst.

9.1 Fältbeskrivningar

Element/Attribut	Beskrivning	Innehåller
Version	Produktens versionsnummer	Sträng enligt: X.Y där X och Y är nummerföljder i stigande ordning.
varunummer	Nordiskt varunummer för en förpackning Informationen ägs av företaget som marknadsför produkten för läkemedel. Informationen ägs av TLV för handelsvara och tjänst.	Sträng om 6 tecken varav alla är siffror. Utfyllnad med 0:or i början.
identitet => artikel_id	Lista med id-begrepp kopplade till artikeln	1 eller fler artikel_id element
artikel_id	Representerar ett id-begrepp, med typ och id-nummer	Attribut för typ och id.
forskrivningsratt => artikel_forskrivningsratt	Lista med förskrivningsrätter	0 eller fler artikel_forskrivningsratt element
artikel_forskrivningsratt	Anger vilka kategorier av förskrivare som har rätt att förskriva artikeln. Informationen ägs av LV	Strängkod enligt lx-forskrivningsratt.xsd
pris => pris_artikel	List med priser kopplade till artikeln	0 eller max 2st pris_artikel element
pris_artikel	Prisuppgift om artikel Informationen ägs av TLV	Information enligt def:pris_artikel
intressenter => intressent_ref	Lista med referenser till intressenter för artikeln	0 eller fler intressent_ref element
intressent_ref	Referens till en intressent med roll och elementets xml-id. Se kap 13.10	Attribut för referens-id och definierad ansvarsroll (roll) för legal organisation.
forvaring => forvaringsfall	Lista med förvaringsfall	0 eller fler forvaringsfall element
forvaringsfall	Beskriver de omständigheter och betingelser för vilka hållbarhet, temperatur och förvaringssätt gäller för en förpackning	Information enligt def:forvaringsfall
antal_klartext	Termen används för att beskriva en förpackningsstorlek och samman­fattar därför innehållet i multiplar, antal och enhet (se beskrivning av respektive fält, nedan)	Text om högst 50 tecken.
antal_multipel_1	Denna term innehåller en förpackningsmultipel. En förpackningsstorlek kan bestå av två multiplar och ett förpackningsantal, t.ex. 5x4x100. Termen Antal multipel 1 är i detta fallet 4. Informationen ägs av företaget som marknadsför produkten för läkemedel.	Heltal om högst 6 siffror
antal_multipel_2	Denna term innehåller en förpackningsmultipel. En förpackningsstorlek kan bestå av två multiplar och ett förpackningsantal, t.ex. 5x4x100. Termen Antal multipel 2 är i detta fallet 5. Informationen ägs av företaget som marknadsför produkten för läkemedel.	Heltal om högst 6 siffror
antal_numeriskt	Denna term innehåller förpackningsantal när det kan uttryckas numeriskt. I exemplet 5x4x100 st, är Antal numerisk 100. Informationen ägs av företaget som marknadsför produkten för läkemedel.	Nummer om högst 9 siffror och 3 decimaler
antal_numerisk_enhet	Anger enheten för antal_numeriskt	Sträng-kod enligt lx-antal-numerisk-enhet.xsd
artikel_benamning	Artikelbenämning Innehåller uppgifter om namn, produkt­benämning, beskrivning och i före­kommande fall leverantör t.ex. Alvedon, filmdragerad tablett 500 mg Informationen ägs av eHälsomyndigheten.	Text om högst 80 tecken
artikel_kommentar	Fritext element för företag att ge egna kommentarer som endast gäller för en enskild artikel	Text om högst 250 tecken
artikel_kommentar_tlv	Eventuell begränsning av förmånen beslutad av TLV t.ex. För diabetes typ2 patienter måste BMI vara minst 28 för subvention. För övriga ska BMI vara minst 35	Text om högst 2000 tecken
beskrivning	Beskrivning av artikeln	Text om högst 100 tecken
forman	Anger om artikeln ingår i förmånen Informationen ägs av TLV	Y (Ja), N (Nej) eller - (ospecificerat)
forpackning_text	Beskrivande förpackningstext från LV som innehåller viktiga detaljer för val av rätt artikel vid beställning och expedition t.ex. Tvåkammarcylinderampull för GenotropinPen 12 , 1 x (I+II) OBS! Elementet ska visas för användaren vid tjänsteanrop HämtaSubstitution, se VARA - bilaga till handboken för vård- och apoteksaktörer för mer information.	Text om högst 160 tecken
forsaljningsstopp	Anger om artikeln är försäljningsstoppad av LV	Y (Ja), N (Nej) eller - (ospecificerat)
forsaljningsstopp_kommentar_vara	eHälsomyndigheten kommentar vid försäljningsstopp	Sträng om max 80 tecken
asab_kommentar	Eventuell kommentar från eHälsomyndigheten..	Sträng om max 80 tecken
forsaljnings_restriktion	Anger eventuella försäljningsrestriktioner t.ex. Fri försäljning i detaljhandel Informationen ägs av LV.	Sträng-kod enligt lx-forsaljnings-restriktion.xsd
innehaller_latex	Anger om en artikel innehåller latex. Detta gäller endast parenterala läkemedelsprodukter.	Strängkod enligt lx-innehaller-latex.xsd
receptbelagd	Definierar om enskild artikel får tillhandahållas utan recept. Informationen ägs av LV	Y (Ja) eller N (Nej)
avregistreringsdatum	Avregistreringsdatum för artikeln. Informationen ägs av LV	Datum enligt ÅÅÅÅ-MM-DD
forpacknings_typ_inre	Anger förpackningstyp på den inre förpackningen. Informationen ägs av företaget som marknadsför produkten för läkemedel.	Strängkod enligt lx-forpackningstyp-inre.xsd
varutyp	Artikelns varutyp	Sträng-kod enligt lx-produkt-varutyp.xsd
pristyp	Anger TLVs pristyp för artikeln.	Sträng-kod enligt lx-pristyp.xsd
tlv-substitution => tlv-utbytesperiod	Substitutions-information från TLV	0 till 3 st element av typen def:tlv-utbytesperiod

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

Element/Attribut	Beskrivning	Innehåller
nplpackid	Innehåller antingen läkemedels- förpackningens unika identitet i NPL alternativt, för läkemedel som ej finns i NPL, innehåller fältet ett unikt SBpackid. NPLId ägs av LV och SBId ägs av eHälsomyndigheten.	Sträng om max 14 tecken Exempel NPLPackId: 20070308100102 SBPackId: SB050114100007
farmaceutisk_prod_forp => antal_farmaceutisk_prod_forp	Lista med antal_farmaceutisk_prod_forp	0 eller fler antal_farmaceutisk_prod_forp element
antal_farmaceutisk_prod_forp	Beskriver antalet av de olika innehållen i en förpackning	Information enligt def:antal_farmaceutisk_prod_forp
artikel_utbytbar	Anger om artikeln är utbytbar. 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. Informationen ägs av LV	Y (Ja), N (Nej) eller - (ospecificerat)
artikel_utbytbar_orsak	Anger orsak till om artikeln inte är utbytbar trots att produkten är det	Text om högst 80 tecken
ddd_per_forpackning	Anger hur många Definierade DygnsDoser (DDD) förpackningen innehåller.	Nummer om högst 7 siffror och 2 decimaler
marknadsfors	Anger om artikeln marknadsförs eller inte. Informationen ägs av företaget som marknadsför produkten för läkemedel.	Y (Ja), N (Nej) eller - (ospecificerat)
marknadsfors_from	Anger eventuellt datum då artikeln åter marknadsförs. Informationen ägs av företaget som marknadsför produkten för läkemedel.	Datum enligt ÅÅÅÅ-MM-DD
kopplingar => tjanst_ref	Innehåller ev. koppling som läkemedelsartikeln har till tjänster. Används för medicinsk gas och tjänster som t.ex. hyra av gasflaska eller transport av gasflaska	0 eller fler tjanst_ref element av typen def:varunummer_ref

11 Tjänst

Beskriver en tjänst som ärver alla fält från artikel och lägger till möjligheten att koppla referenser till läkemedel på varunummer. Tjänster används främst på gas-tjänster som t.ex. hyra eller transport av gasflaskor.

11.1 Fältbeskrivningar

Element/Attribut	Beskrivning	Innehåller
Kopplingar => lmartikel_ref	Lista med referenser till läkemedelsartiklar.	0 eller fler lmartikel_ref element av typen def:varunummer_ref

12 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.

12.1 Fältbeskrivningar

Element/Attribut	Beskrivning	Innehåller
handelsvarugrupp	Klassifikationskod för gruppering av handelsvaror i fem nivåer. Sätts alltid till - i nuläget.	Sträng-kod enligt lx-handelsvarugrupp.xsd

13 Övriga typ-definitioner

13.1 varunummer_ref

Beskriver en referens till en artikel på varunummer

Element/Attribut	Beskrivning	Innehåller
varunummer	Varunumret på den refererade artikeln	Sträng om 6 tecken varav alla är siffror och utfylld med 0:or i början.

 

13.2 produkt_id

Beskriver en produkts identifikations-begrepp

Element/Attribut	Beskrivning	Innehåller
produkt_id_typ	Kod för produktens identifikations-typ	Strängkod enligt lx-produkt-id-typ.xsd
id_varde	Identifikationsnummer eller kod	Strängkod om högst 70 tecken
gfrom_datum	Giltigt från och med datum	Datum enligt ÅÅÅÅ-MM-DD
tom_datum	Giltigt till och med datum	Datum enligt ÅÅÅÅ-MM-DD

13.3 artikel_id

Beskriver en artikels identifikations-begrepp

Element/Attribut	Beskrivning	Innehåller
artikel_id_typ	Kod för artikelns identifikations-typ	Strängkod enligt lx-artikel-id-typ.xsd
id_varde	Identifikationsnummer eller kod	Strängkod om högst 70 tecken
gfrom_datum	Giltigt från och med datum	Datum enligt ÅÅÅÅ-MM-DD
tom_datum	Giltigt till och med datum	Datum enligt ÅÅÅÅ-MM-DD

13.4 produkt_namn

Beskriver ett namn för produkten

Element/Attribut	Beskrivning	Innehåller
produkt_namn_typ	Kod för produktens namn-typ	Strängkod enligt lx-produkt-namn-typ.xsd
namn	Produktens namn	Sträng om högst 150 tecken
gfrom_datum	Giltigt från och med datum	Datum enligt ÅÅÅÅ-MM-DD
tom_datum	Giltigt till och med datum	Datum enligt ÅÅÅÅ-MM-DD

13.5 utbytbarhet

Beskriver en utbytbarhetsgrupp för produkten

Element/Attribut	Beskrivning	Innehåller
utbytbarhet_form_grupp	Kod för beredningsformgrupp (Id) till vilket ett läkemedel hör i de fall läkemedlet ingår i en utbytbarhetsgrupp och är utbytbart mot annat läkemedel enligt beslut från LV	Strängkod enligt lx-utbytbarhet-form-grupp.xsd
utbytbarhet_styrka_grupp	Kod för den styrkagrupp (Id) till vilket ett läkemedel hör i de fall läkemedlet ingår i en utbytbarhetsgrupp och är utbytbart mot annat läkemedel enligt beslut från LV	Strängkod enligt lx-utbytbarhet-styrka-grupp.xsd
utbytbarhet_substans_grupp	Kod för den substansgrupp (Id) till vilket ett läkemedel hör i de fall läkemedlet ingår i en utbytbarhetsgrupp och är utbytbart mot annat läkemedel enligt beslut från LV	Strängkod enligt lx-utbytbarhet-substans-grupp.xsd
gfrom_datum	Giltigt från och med datum	Datum enligt ÅÅÅÅ-MM-DD
tom_datum	Giltigt till och med datum	Datum enligt ÅÅÅÅ-MM-DD

 

13.6 farmaceutisk_produkt

Beskriver de olika farmaceutiska produkterna.

Element/Attribut	Beskrivning	Innehåller
beskrivning	Namnger de olika farmacevtiska produkterna som ingår i en läkemedelsprodukt, exempelvis ampull a, ampull b osv.	Sträng om max 100 tecken
refererande_mangd	Anger hur mängdangivelser av enskilda beståndsdelar specificerats. Ex per ml, per 100 gram, per dos	Strängkod enligt lx-refererande-mangd.xsd
pharmaceutical_product_id_npl	NPLs interna id för denna produkt. Används för att hålla ihop extra antalet för kombinationsförpackningar.	Sträng om max 20 tecken
bestandsdelar => bestandsdel	Lista med beståndsdelar	0 eller fler bestandsdel element
bestandsdel	Beskriver en beståndsdel i en produkt. Se kap 13.8	Information enligt def:bestandsdel
id	Ett unikt id för referens inom xml-filen	En sträng enligt xs:ID

13.7 antal_farmaceutisk_prod_forp

Beskriver antalet av de olika innehållen i en förpackning.

Element/Attribut	Beskrivning	Innehåller
antal_multipel_1	Anger förpackningsmultipel. En förpackningsstorlek kan bestå av två multiplar och ett förpackningsantal, t.ex. 5x4x100. Termen Antal multipel 1 är i detta fallet 4	Heltal om max 6 siffror
antal_multipel_2	Anger förpackningsmultipel. En förpackningsstorlek kan bestå av två multiplar och ett förpackningsantal, t.ex. 5x4x100. Termen Antal multipel 2 är i detta fall 5	Heltal om max 6 siffror
antal_numeriskt	Anger förpackningsantal när det kan uttryckas numeriskt. I exemplet 5x4x100 st, är Antal numerisk 100.	Nummer om högst 9 siffror och 3 decimaler
antal_numerisk_enhet	Anger enheten för förpackningsantal	Strängkod enligt lx-antal-numerisk-enhet.xsd
farmaceutisk_produkt_ref => farmaceutisk_produkt	XML-referens till en farmaceutisk produkt. Se kap 13.6	Strängkod enligt xs:IDREF

  

13.8 Bestandsdel

Beskriver en beståndsdel för en farmaceutisk produkt. Informationen ägs av LV

Element/Attribut	Beskrivning	Innehåller
bestandsdel_id_ext	NPLs unika id.	Sträng om max 20 tecken.
bestandsdel_mangd	Beståndsdelens mängd	Nummer enligt xs:decimal
bestandsdel_enhet	Beståndsdelens enhet	Strängkod enligt lx-bestandsdel-enhet.xsd
bestandsdel_roll	Beståndsdelens roll	Strängkod enligt lx-bestandsdel-roll.xsd
bestandsdel_tillagsenhet	Tilläggsenhet för beståndsdelen	Strängkod enligt lx-bestandsdel-tillagsenhet.xsd
substans_ref => substans	Referens till en substans. Se kap 13.9.	Attribut ref med strängkod enligt xs:IDREF

 

13.9 substans

Beskriver en kemisk substans. Informationen ägs av LV

Element/Attribut	Beskrivning	Innehåller
inn_namn	Substansnamn. Engelskt INN namn i klartext.	Sträng om max 240 tecken
cas_nummer	Identifikationsnummer enligt Chemical Abstract Service Number.	Strängkod om max 12 tecken
nplsubstansid	Substansens id från NPL	Sträng om max 20 tecken
id	XML-id för referens från andra element.	Strängkod enligt xs:ID

13.10 Intressent

Beskriver en legal organisation med definierat ansvar för läkemedel i enlighet med organisationens roll.

Element/Attribut	Beskrivning	Innehåller
namn	Namnet på intressenten/organisationen	Sträng om max 160 tecken
intressent_id_ext	Unikt id.	Sträng om max 18 tecken.
adresser => intressent_adress	Lista med adresser	0 eller fler intressent_adress element
intressent_adress	Beskriver en adress
adress_1	Del 1 av adressen	Sträng om max 60 tecken
adress_2	Del 2 av adressen	Sträng om max 60 tecken
adress_3	Del 3 av adressen	Sträng om max 60 tecken
adress_4	Del 4 av adressen	Sträng om max 60 tecken
land_kod	Landskod	Strängkod enligt lx-land-kod.xsd
id	Ett unikt id för referens inom xml-filen	Strängkod enligt xs:ID

13.11 pris_artikel

Beskriver ett pris för en förpackning/artikel.

Element/Attribut	Beskrivning	Innehåller
aip	Apotekens inköpspris (AIP) som beslutats av TLV för artiklar som ingår i förmånssystemet.	Nummer om max 9st siffor och 2st 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.	Nummer om max 9st siffror och 2st decimaler.
gfrom_datum	Giltigt från och med datum.	Datum enligt ÅÅÅÅ-MM-DD

13.12 forvaringsfall

Beskriver de omständigheter och betingelser för vilka hållbarhet, temperatur och förvaringssätt gäller för en förpackning. Informationen ägs av LV

Element/Attribut	Beskrivning	Innehåller
forvaringsfall_typ	Kod för typen för förvaringsfallet.	Strängkod enligt lx-forvaringsfall.xsd
hallbarhet_enhet	Kod för enheten för hållbarhet	Strängkod enligt lx-hallbarhet-enhet.xsd
forvaringsfall_temperatur	Beskriver de temperatur­betingelser som gäller en förpackning vid förvaringsfallet	Strängkod enligt lx-forvaringsfall-temperaturt.xsd
forvaringssatt	Anger hur förpacknings skall förvaras för angivet förvaringsfall	Strängkod enligt lx-forvaringssatt.xsd
hallbarhet	Hållbarhet för gällande förvaringsfall	Heltal om max 9 siffror

13.13 tlv-utbytesperiod

Beskriver en artikels medverkan i en utbytesperiod från TLV

Element/Attribut	Beskrivning	Innehåller
klusterid	ID för storlekskluster	Sträng om max 8 tecken.
periodens-vara	Anger om artikeln är eller har varit periodens vara.	Y eller N och ett datum samt rang enligt def:flagga-med-datum-rang
bestallningsstopp	Anger om artikeln har blivit beställningsstoppad under perioden.	Y eller N och ett datum samt historisk rang enligt def:flagga-med-datum-rang
aipperenhet	Artikelns aip per enhet.	Nummer om max 9st siffor och 2st decimaler
aupperenhet	Artikelns aip per enhet.	Nummer om max 9st siffor och 2st decimaler
start_datum	Periodens startdatum	Datum enligt ÅÅÅÅ-MM-DD
stopp_datum	Periodens stoppdatum	Datum enligt ÅÅÅÅ-MM-DD

13.14 flagga-med-datum

Beskriver en flagga tillsammans med ett datum då flaggan sattes.

Element/Attribut	Beskrivning	Innehåller
start_datum	Startdatum för när flaggan börjar gälla	Datum enligt ÅÅÅÅ-MM-DD
Flagga		Y eller N

13.15 flagga-med-datum-rang

Utökning av typen def:flagga-med-datum.

Element/Attribut	Beskrivning	Innehåller
rang	Attribut som beskriver artikelns rang (Synligt om flagga = Y)	Integer 0-3
historisk-rang	Attribut som beskriver artikelns historiska rang (Synligt om flagga = Y)	Integer 0-3

 

Versionshistorik

Utgåva	Datum	Kommentar
3.0	2013-01-18	Lagt till information om källägare i kolumnen beskrivning. Reviderat text om informationsinnehåll i VARA samt hänvisning till VARA - bilaga till handboken för vård- och apoteksaktörer.
4.0	2014-04-04	Inlagd i ny mall. Apotekens Service har ersatts med eHälsomyndigheten. 1, allmänna förtydliganden 1.1, tagit bort inaktuell information 4.3, layoutmässig justering (infogat punktlista) Korrigerat fältlängder, · 9.1 Fältbeskrivningar - artikel_kommentar_tlv · 13.9 Substans - cas_nummer och inn_namn Observera att fältlängden inte har ändrats i filen utan att textbeskrivningen har varit fel.
5.0	2014-09-29	1, 2.1, 7.1, 11 och 13.7, Små textuella rättningar. 9.1 artikel_kommentar_tlv, nytt värde i fältlängden från och med 14.2-releasen är 2000 tecken.
​6.0	​2016-11-17	​7.1 Rättat beskrivning till sarskilda_lakemedel
​​7.0	​2017-12-19	​​​​7.1 Uppdaterat hänvisning till föreskrift