VARA Export - Dokumentation av XML Schema version 6.0

 

4.2.1 Lexikon-scheman ligger under katalogen lexikon och har namn-standarden /x-<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, exempelvis vid utökning av nya koder.

4.2.2 Lexikon-data (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 kopplingar mellan lakemedelsform och administreringsmetod.

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 version stegas upp varje gång den gått igenom intagningsprocessen 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 intagningsprocess.

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 är härledda utifrån annan information och beroende dessutom 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 genomgår VARAs intagningsprocess 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.

 

Beskriver en artikels identifikations-begrepp.

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​

Beskriver en utbytbarhetsgrupp för produkten.

Beskriver de olika farmaceutiska produkterna.

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

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 exempelvis 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

Beskriver en kemisk 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-dotter-relationer.	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
​biologisk_substans	​Anger om en substans är en biologisk aktiv substans	​0..1	​Kod enligt lx-yesno.xsd

Beskriver relationen mellan två substanser.

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. Exempel: klopidogrelhydroklorid är Child (i relation med klopidogrel).	1	Kod enligt lx-substansrelation

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

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

Beskriver en intressents 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

Beskriver ett pris för en förpackning/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 till exempel 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)

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

Beskriver en artikels medverkan i en utbytesperiod från TLV.

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
​klustergrupp_pv	​Anger om läkemedlet ingår i det generiska utbytet	​0..1	​Kod enligt lx-yesno.xsd

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

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

Utökning av typen flagga-med-datum.

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)

Beskriver fördjupad information kring lexikon.

 

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	​Nycke 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

Version​	​Datum	​Kommentar
​1.0	​2022-02-02	​​Första utgåva