Dokumentation av XML-schema version 5.0


Här beskrivs XML-schemat för E-hälsomyndighetens VARA-exportfil version 5.0. Texten är inte en specifikation av export-formatet utan en kompletterande dokumentation. Vid användning av VARA-exportfil i system ska dokumentation av XLM-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-5_ÅÅMMDD.zip

2. Informationsinnehåll i VARA

Sortimentet i VARA är det nationellt gemensamma, det vill säga alla läkemedel samt de förbrukningsartiklar och livsmedel som ingår i högkostnadsskyddet. Information om läkemedelsprodukter och artiklar som någon gång har marknadsförts sedan år 2005 är inkluderade i VARA.

För beskrivning av produkt- och artikelregistret VARA samt information om innehåll och regelverk, läs 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 expedieringssystem.

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-lexikondata.xsd

Innehåller definitioner för detaljerad information om lexikon och kopplingar mellan lexikon.

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å, exempelvis:

                      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.

Lexikondata (asab-lexikondata.xsd) innehåller en beskrivning av strukturen för en xml-fil (lexikon-data.xml). Xml-filen innehåller, utöver den information som finns i alla lexikonfilerna i 4.2.1, även eventuella edqm-idn för lexikon samt kopplingar mellan lexikon. Till exempel koppling mellan lakemedelsform och administreringsmetod.

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 på 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.

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

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

0..1

0 eller fler element av typen lmprodukt alt.

0 eller fler element av typen hvprodukt

lexikondata

Lista med alla lexikon och kopplingar mellan lexikon.

0..1

1 element av typen lexikonlista

1 element av typen lexikonkopplingslista

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

Produktens aktuella handelsnamn.

1

Sträng (1..100 tecken)

tillagsnamn => produkt_namn

Lista med produktens övriga namn samt historiska namn.

1

1 eller fler produkt_namn-element

produkt_namn

Element som beskriver ett produktnamn med tillhörande typ.

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

Element som representerar en referens till en intressent i listan med intressenter.

1..*

Attribut för referens-id och definierad roll för legal organisation. Se kap 13.8

forsaljningsstopp

Anger om produkten är försäljningsstoppad av Läkemedelsverket.

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

Anger om produkten innehåller laktos.

Sätts automatiskt till Ja om produkten innehåller någon av substanserna laktosmonohydrat eller laktos vattenfri.

0..1

Kod enligt lx-yesno.xsd

innehaller_latex

Anger om rester av latex kan förekomma i någon av artiklarna.

0..1

Kod enligt lx-innehaller-latex.xsd

gruppvarunummer

Anger om produkten är ett gruppvarunummer.

1

Kod enligt lx-yesno.xsd

receptbelagd

Anger om produkten är receptbelagd eller ej, eller om vissa förpackningar kan tillhandahållas utan recept.

1

Kod enligt lx-receptbelagd.xsd

avregistreringsdatum

Produktens avregistreringsdatum.

0..1

Datum (ÅÅÅÅ-MM-DD)

produkt_typ

Typ av läkemedel, ex. licensläkemedel.

1

Kod enligt lx-produkt-typ.xsd

lakemedel

Anger om produkten är ett läkemedel eller inte.

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

Innehåller antingen läke­medels­produktens unika identitet ifrån LV (NPL id), alternativt, för läkemedel som skapats i VARA, innehåller fältet ett unikt SB id.

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

Europeiskt godkännandenummer. Anges på centralt godkända produkter.

0..1

Sträng (11..12 tecken)

EU/1/YY/NNN alternativt EU/1/YY/NNNN

(EU/1/ = läkemedel för humant bruk. EU/2/ = läkemedel för djur)

antidot

Anger om produkten är klassad som en antidot av GIC.

1

Kod enligt lx-yesno.xsd

avvikelse_parallell_import

Beskrivande text som anger eventuella avvikelser i utseende för parallellimporterat läkemedel i jämförelse med referensläkemedel.

0..1

Sträng (1..500 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.

0..1

Decimal (högst 8 tecken varav 3 decimaler)

enhet_ddd

Enheten till ddd-elementet.

0..1

Kod enligt lx-enhet-ddd.xsd

doseringsenhet

Anger i vilken enhet en läkemedels­produkt avses doseras.

Ingen information i detta fält, källägare saknas.

1

Kod enligt lx-doseringsenhet.xsd

dos_bryttillstand

Anger om LV har beviljat bryttillstånd för dosdispensering.

1

Kod enligt lx-yesno.xsd

dos_bryttillstand_hallbar

Anger hållbarheten (i månader) vid dosdispensering.

0..1

Integer (2 tecken)

godkannande_datum

Datum då produkten första gången godkändes för försäljning.

0..1

Datum enligt ÅÅÅÅ-MM-DD

styrka_klartext

Produktens styrka i fritext t.ex. 500 mg.

0..1

Sträng (1..200 tecken)

marknadsfors

Anger om produkten marknadsförs. Sätts till ja av då minst en förpackning marknadsförs.

1

Kod enligt lx-yesno.xsd

utbytbar

Anger om läkemedlet är utbytbart mot annat läkemedel enligt beslut av LV.

1

Kod enligt lx-yesno.xsd

vetrinarlakemedel

Anger om läkemedlet är ett veterinärläkemedel.

1

Kod enligt lx-yesno.xsd

atc_kod

Klassifikationskod för gruppering av läkemedel i fem nivåer.

0..1

Kod enligt lx-atc-kod.xsd

godkannande_procedur

Anger godkännandeprocedur t.ex. decentraliserad procedur.

0..1

Kod enligt lx-godkannande-procedur.xsd

lakemedelsform

Produktens läkemedelsform.

1

Kod enligt lx-lakemedelsform.xsd

parallellimport_fran

Anger vilket land produkten är parallellimporterad från.

0..1

Kod enligt lx-land-kod.xsd

original_nplid

Parallellimporterade produkter har ett Original NPL id som är det NPL id som den svenska referensprodukten har.

0..1

Sträng (14 tecken)

narkotika_klass

Anger läkemedlets eventuella narkotikaklassificering.

1

Kod enligt lx-narkotika-klass.xsd

iterering      

Anger om recept på denna produkt får förskrivas flera gånger (=itereras).

Anges bara på särskilda läkemedel.

0..1

Kod enligt lx-iterering.xsd

sarskilt_lakemedel

Anger om produkten är ett särskilt läkemedel.

1

Kod enligt lx-yesno.xsd

rikslicens

Anger om produkten är en rikslicens.

1

Kod enligt lx-yesno.xsd

utokad_overvakning

Anger om läkemedlet står under utökad övervakning.

1

Kod enligt lx-yesno.xsd

utlamnandebegransning

Anger om produkten får utlämnas från apotek endast om den har förskrivits av en läkare med viss specialistkompetens.

0..1

Kod enligt lx-utlamnandebegransning.xsd

utbytbarheter => utbytbarhet

Lista med utbytbarhetsgrupper.

1

0 till 2 utbytbarhet-element.

utbytbarhet

Element som beskriver utbytbarhetsgruppen som produkten ingår i (form, styrka och substans).

0..2

Information enligt utbytbarhet, se kap. 13.3

enhet_styrka

Enhet på 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

Element som beskriver de farmaceutiska produkter (delar) som ingår i produkten. Ex. vätska och pulver. En farmaceutisk produkt består i sin tur av en eller flera beståndsdelar.

0..*

Information enligt farmaceutisk_produkt, se kap. 13.4

artiklar => lmartikel

Lista med läkemedelsartiklar, d.v.s. försäljningsbara varor.

1

1 eller fler lmartikel-element

lmartikel

Element som beskriver den information som finns på en läkemedelsartikel.

1..*

Information enligt lmartikel, se kap. 9 och 10

biologiskt_lakemedel

Anger om det är ett biologiskt läkemedel (ska biverkningsrapporteras).

0..1

Kod enligt lx-yesno.xsd

ursprungsid_licens

Godkännandenummer för licensläkemedlet i godkännandelandet.

0..1

Sträng (1-20 tecken)

godkannandeland_licens

Landet läkemedlet på licens är godkänt i av den nationella myndigheten.

0..1

Kod enligt lx-land-kod.xsd

administreringsvagar => administreringsvag

Lista med administreringsvägar.

1

0 eller flera administreringsvag-element

administreringsvag

Administreringsväg som indikerar den kroppsdel som läkemedlet ska administreras på, genom eller in i.

0..*

Kod enligt lx-administreringsvag.xsd

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. 11 och 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

Produktens versionsnummer.

1

Sträng enligt: X Y där X och Y är nummerföljder i stigande ordning.

varunummer

Varunummer, ett id-begrepp som inte är unikt eller tidsbeständigt.

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

Anger vilka kategorier av förskrivare som har rätt att förskriva artikeln.

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

Referens till en intressent med roll och elementets xml-id.

0..1

Attribut för referens-id och definierad ansvarsroll (roll) för legal organisation. Se kap 13.8

forvaring => forvaringsfall

Lista med förvaringsfall.

1

0 eller fler forvaringsfall-element

forvaringsfall

Information om förvaring och hållbarhet för en artikel.

0..*

Information enligt forvaringsfall, se kap. 13.11

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

0..1

Sträng (1..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.

0..1

Decimal (högst 6 tecken varav 0 decimaler)

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.

0..1

Decimal (högst 6 tecken varav 0 decimaler)

antal_numeriskt

Denna term innehåller förpackningsantal. I exemplet 5x4x100 st, är Antal numerisk 100.

0..1

Decimal (högst 9 tecken varav 3 decimaler)

antal_numerisk_enhet

Anger enheten för antal_numeriskt.

0..1

Kod enligt lx-antal-numerisk-enhet.xsd

artikel_benamning

Fält som är sammansatt av flera attribut som beskriver artikeln. På läkemedel är det produktnamn, läkemedelsform, styrka klartext och vid behov intressent t.ex. Alvedon, filmdragerad tablett 500 mg.

0..1

Sträng (1..80 tecken)

beskrivning

Beskrivning av artikeln.

0..1

Sträng (1..100 tecken)

forman

Anger om artikeln ingår i förmånen.

1

Kod enligt lx-yesno.xsd

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.

0..1

Sträng (1..255 tecken)

forsaljningsstopp

Anger om artikeln är försäljningsstoppad av LV.

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

Information om regler kring försäljning av artikeln.

Exempel: Fri försäljning i detaljhandel.

0..*

Kod enligt lx-forsaljnings-restriktion.xsd

innehaller_latex

Anger om en artikel innehåller latex.

Anges ej på licensläkemedel.

0..1

Kod enligt lx-yesno.xsd

receptbelagd

Anger om artikeln är receptbelagd eller inte.

1

Kod enligt lx-yesno.xsd

avregistreringsdatum

Avregistreringsdatum för artikeln.

0..1

Datum enligt ÅÅÅÅ-MM-DD

forpacknings_typ_inre

Anger typ av förpackning ex. blister

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

Innehåller antingen läke­medels­produktens unika identitet ifrån LV (NPLpack id), alternativt, för läkemedel som skapats i VARA, innehåller fältet ett unikt SBpack id.

1

Sträng (14 tecken)

Exempel:

NPLpack id 20070308100102

SBpack id   SB050114100007

europeiskt_godkannandenr

Europeiskt godkännandenummer. Finns på centralt godkända produkter.


0..1

Sträng (15..16 tecken)

EU/1/YY/NNN/NNN alternativt EU/1/YY/NNNN/NNN

(EU/1/ = läkemedel för humant bruk. EU/2/ = läkemedel för djur)

endast_dos

Anger om artikeln endast får användas för dosdispensering.

1

Kod enligt lx-yesno.xsd

endast_sjukhusbruk

Anger om artikeln endast får användas för sjukhusbruk.

1

Kod enligt lx-yesno.xsd

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.

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

Anger om artikeln marknadsförs eller inte.

1

Kod enligt lx-yesno.xsd

sakerhetsdetaljer

Anger med Ja/Nej om förpackningen ska ha säkerhetsdetaljer eller inte enligt Artikel 54a(1) direktiv 2001/83/EU.

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. Tjänst

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. Typ-definitioner 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

Beskriver en utbytbarhetsgrupp för produkten.

Tabell 13. Typ-definitioner för utbytbarhet.

Element/Attribut

Beskrivning

Mult.

Typ (fältlängd)

utbytbarhet_form_grupp

Kod för läkemedlesformgrupp (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.

1

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

1

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

1

Kod enligt lx-utbytbarhet-substans-grupp.xsd

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.4. farmaceutisk_produkt

Beskriver de olika farmaceutiska produkterna.

Tabell 14. Typ-definitioner för farmaceutisk_produkt.

Element/Attribut

Beskrivning

Mult.

Innehåller

beskrivning

Namnger de olika farmaceutiska produkterna som ingår i en läkemedelsprodukt, exempelvis vätska, pulver.

0..1

Sträng (1..40 tecken)

refererande_mangd

Anger hur mängdangivelser av enskilda beståndsdelar specificerats. Ex. per ml, per 100 gram, per dos.

1

Kod enligt lx-refererande-mangd.xsd

pharmaceutical_product_id_npl

Id för 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 i en produkt.

0..*

Information enligt bestandsdel, se kap. 13.5

administreringsvagar => administreringsvag

Lista med administreringsvägar.

1

0 eller flera administreringsvag-element

administreringsvag

Administreringsväg som indikerar den kroppsdel som läkemedlet ska administreras på, genom eller in i.

0..*

Kod enligt lx-administreringsvag.xsd

13.5. bestandsdel

Beskriver en beståndsdel för en farmaceutisk produkt.

Tabell 15. Typ-definitioner för bestandsdel.

Element/Attribut

Beskrivning

Mult.

Typ (fältlängd)

bestandsdel_id_ext

Unikt id för beståndsdel.

1

Sträng (1..18 tecken)

bestandsdels_id_relation

Pekar ut vilken beståndsdel (beståndsdels-id) som hör ihop med den aktuella beståndsdelen.

0..1

Sträng (1..18 tecken)

bestandsdel_mangd

Beståndsdelens mängd.

0..1

Decimal (Högst 12 tecken varav 3 decimaler)

bestandsdel_enhet

Beståndsdelens enhet.

0..1

Kod enligt lx-bestandsdel-enhet.xsd

bestandsdel_roll

Beståndsdelens roll.

1

Kod enligt lx-bestandsdel-roll.xsd

bestandsdel_tillaggsenhet

Tilläggsenhet för beståndsdelen.

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

presentationsnamn

Attribut som pekar ut vilken form av varje aktiv substans som har det namn som kan visas ex. i läkemedelslistan.

OBS! Denna parameter får inte användas till beräkningar eller beslutsstöd.

0..1

Kod enligt lx-yesno.xsd

referens_styrka

Attribut som pekar ut vilken form av varje aktiv substans som hör ihop med läkemedlets styrkeangivelse (styrka klartext).

0..1

Kod enligt lx-yesno.xsd

13.6. substans

Beskriver en kemisk substans.

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

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

Tabell 18. Typ-definitioner för intressent.

Element/Attribut

Beskrivning

Mult.

Typ (fältlängd)

namn

Namnet på intressenten.

1

Sträng (1..160 tecken)

intressent_id_ext

Unikt id.

1

Sträng (1..18 tecken)

momsnummer

Intressentens momsnummer.

0..1

Sträng (1..20 tecken)

adress

Intressentens adress.

0..1

Information enligt adress, se kap. 13.9

id

Ett unikt id för referens inom xml-filen.

1

Strängkod enligt xs:ID

13.9. adress

Beskriver en intressents adress.

Tabell 19. Typ-definitioner för adress.

Element/Attribut

Beskrivning

Mult.

Typ (fältlängd)

adress_1

Del 1 av adressen.

0..1

Sträng (1..60 tecken)

adress_2

Del 2 av adressen.

0..1

Sträng (1..60 tecken)

adress_3

Del 3 av adressen.

0..1

Sträng (1..60 tecken)

adress_4

Del 4 av adressen.

0..1

Sträng (1..60 tecken)

land_kod

Landskod.

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

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.

Tabell 21. Typ-definitioner för forvaringsfall.

Element/Attribut

Beskrivning

Mult.

Typ (fältlängd)

forvaringsfall_typ

Kod för typen för förvaringsfallet.

1

Kod enligt lx-forvaringsfall.xsd

forvaringsfallkod_ext

Unikt id för förvaringsfallet.

0..1

Sträng (1..18 tecken)

farmaceutisk_produkt_id

Referens till den farmaceutiska produkt som förvaringsfallet avser.

0..1

Sträng (1..18 tecken)

hallbarhet_enhet

Kod för enheten för hållbarhet.

1

Kod enligt lx-hallbarhet-enhet.xsd

forvarings_temperatur

Beskriver de temperatur­betingelser som gäller en förpackning vid förvaringsfallet.

1

Kod enligt lx-forvaringsfall-temperaturt.xsd

hallbarhet

Hållbarhet för gällande förvaringsfall.

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. Typ-definitioner 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)

14. Lexikondata

Beskriver fördjupad information kring lexikon.

Figur 3. Struktur för lexikon.

Tabell 25. Typ-definitioner för lexikondata.

Element/Attribut

Beskrivning

Mult.

Typ (fältlängd)

lexikondata

Roten för XML filen.

1


lexikonlista

En lista över lexikon.

1


lexikonkopplingslista

En lista över relationer mellan lexikon.

1


lexikon

Definitionen av ett lexikon.

0..*

Innehåller lexikonreferens. Kan även innehålla text och edqmid

lexikonkoppling

Relation mellan två lexikon.

0..*

Innehåller lexikonreferenser.

lexikonreferens

Nyckel för ett lexikon.


Innehåller typ och kod

typ

Lexikontyp.

1

Sträng

kod

Lexikonkod.

1

Sträng

edqmid

Motsvarande kod enligt edqm standard.

0..1

Sträng

text

Beskrivning av lexikonet.

0..1

Sträng

Versionshistorik

Version

Datum

Kommentar

1.0 2021-11-27 Ny handbok vård- och apotekstjänster
1.1 2022-02-02 Rättat stavfel. Lagt till figur 3 struktur för lexikon. Lagt tabelltext över tabellerna.
1.2 2022-05-18 Korrigerat 13.11 forvarings_temperatur
1.3 2023-03-23 Tabell 1. Uppdaterat DNS-namn sftp-server