​

NEF - Specifikation för XML-meddelande e-recept djur

 
 Gulmarkerad text är information som driftsätts i release 17.1.15.

 
Denna sida beskriver det fastställda formatet för att skicka e-recept djur.
 

Inledning

Syfte

Syftet med denna sida är att beskriva den struktur och det format informationen ska hålla för att mottagaren ska kunna tolka informationen i ett XML-meddelande på ett korrekt sätt.
 

Målgrupp

Målgrupp för denna sida är vårdgivare med IT-system som nyttjar E-hälsomyndighetens tjänster samt systemleverantör som utvecklar eller förvaltar dessa IT-system.​
 

Informationsnivå

Teknisk information.
 

Avgränsningar och förutsättningar

Specifikationen innehåller de element som används vid överföring av recept i XML-format 

Denna specifikation bygger på "Recept New Prescription Message" enligt " Hälso- och sjukvårdsinformatik - Meddelanden för utbyte av information om läkemedel Guide för svensk implementering av ENV 13607 i XML" utgåva 1.1 (i detta dokument kallat SIS XML) samt " Hälso- och sjukvårdsinformatik -XML-kuvert för EDI-routing av XML-meddelanden" version 0.9. Den senare är underlag för MessageRoutingAddress.

Denna specifikation är ett underlag för framtagning av ett XML-schema.


Övergripande struktur

Förklaringar 

I denna specifikation förekommer ett antal förkortningar och koder för att beskriva förekomst och datatyper för element och attribut i XML-meddelandet. 

Förkortningar

  1. Förekomst = antal ggr ett element eller attribut ska/får förekomma enligt nedan:
    [1] = Måste förekomma 1 gång (Obligatoriskt element eller attribut)
    [0..1] = Förekommer ingen eller högst 1 gång (Frivilligt element eller attribut)
    [0..*] = Förekommer ingen eller många gånger (Frivilligt element eller attribut)
    [1..*] = Repeteras valfritt antal gånger. Måste dock förekomma minst 1 gång (Obligatoriskt element eller attribut)
    {a,b,..} = Uppräkning av giltiga värden i ett datafält av uppräkningsbar typ.

    2.  

  2.  

    Typ = typ av element eller attribut
    A anger att det är ett attribut som avses och inte ett element.
    Class motsvaras i ett XML-schema av en complexType.
    Nedanstående typer motsvarar i ett XML-schema av simpleType.
    S = String = Alfanumerisk teckensträng (bokstäver och siffror tillåtna)
    V = Code Value = Kodat värde (numerisk), där betydelsen av varje kod ska framgå av tabell. (Exempel: 1 = Förskrivning)
    I = Integer = Heltal
    E = Enumerated = Uppräkningsbar typ (alfanumerisk), där tabell ska ange tillåtna värden med förklaringar. (Exempel: VEN)

     

Generella regler för meddelandestruktur

  1. Om ett komplext element inte innehåller några obligatoriska element ska det komplexa elementet inte vara obligatoriskt.
    Denna regel tillämpas i specifikationen. 

  2. Om ett element inte är obligatorisk och inte innehåller data ska det inte finnas med i meddelandet.
    Denna regel är nödvändig att följa för att det ska vara möjligt att kontrollera innehållet i ett meddelande. För att kunna göra detta måste det vara möjligt att avgöra om information är avsedd att finnas i ett visst elementfält. 

  3. Obligatoriska element får inte lämnas tomma. Detta kontrolleras vid mottagning.

 

Tillåtna tecken i element- och attributfält 

XML-meddelanden ska följa XML 1.0.Endast kodning enligt UTF-8 tillåts. Detta ska anges i en XML-deklaration. Detta gäller enbart meddelandet vilket kan konverteras till UTF-8 i till exempel en receptserver ifall aktuellt vårdsystem inte stödjer UTF-8. 

Tillåtna tecken i attribut och elementfält är en delmängd av UTF-8 och specificeras i Tillåtna tecken i element och attributdata.

 

XML-reserverade tecken

XML-reserverade tecken ska ersättas enligt "Extensible Markup Language (XML) 1.0 (Fourth Edition) 2.4 Character Data and Markup" (Se www.w3c.org). XML-reserverade tecken finns listade i Tillåtna tecken i element och attributdata. 

CDATA sektioner tillåts inte.

Ändringslogg 

Äldre relevanta kommentarer i ändringsloggen är utgråade.

 

Ändringstyper

  • Formaliserad struktur. Innebär en ändring som syftar till att rätta struktur och fält och göra formatregler och kontroller enhetliga och mer formellt definierade.

  • Regelverk. Innebär en ändring som syftar till att korrigera meddelandet så att det överensstämmer med praxis, verksamhetsregler, föreskrifter och legala krav.

  • Utökad funktionalitet. Innebär en ändring som syftar till att utöka funktionalitet i meddelandet.​

 

XML-Schema definitioner 

XML-specifikationer och koppling till respektive XML-schema finns specificerade i NEF - Teknisk implemantationsguide XML-specifikationer kan uppdateras separat utan att ett nytt XML-schema tas fram.


1 Interchange (Rootelement) - Utväxlingsmeddelande

Element/Attribut​

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

- MessageRoutingAddress

Meddelandehuvud, transportinformation

Class

1


Se specifikation för XML MessageRoutingAddress. Tillämpningar se 1.1 MessageRoutingAddress - Transportinformation (tillämpning)

- NewPrescriptionMessage

Receptmeddelande

Class

1


Se 1.2

 
 
 

1.1 MessageRoutingAddress - Transportinformation (tillämpning) 

Generellt meddelandehuvud tillämpas på e-recept. Specifik tillämpning från det generella meddelandehuvudet anges nedan. I övrigt tillämpas MessageRoutingAddress enligt specifikationen för MessageRoutingAddress.

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- RecipientQualifier

Kodkvalificerare för mottagare

V

1

Char(4)

{14}

Koden för receptbrevlådan.

Endast 14=EAN / GLN används för detta meddelande.

2013-09.23: Förklaring till fältet, GLN-kod tillagd. och förtydligat att det är receptbrevlådan som avses.

- MessageType

Meddelandetyp

e-recept = meddelande av typen E-recept

S

1

Char(14)

{e-recept}

För detta meddelande används e-recept.

 


-- receipt

Kvittenskvalificerare

no = meddelandet är inte en kvittens utan ett e-recept

A, E

1

Char(14)

{no}

För detta meddelande används 'no', dvs. det är ett e-recept. .

Exempel: <MessageType receipt="no">e-recept</MessageType>

2013-09-23: förtydligat tillämpning i beskrivning och kommentar att detta meddelande är ett e-recept.

 
  

1.2 NewPrescriptionMessage - Receptmeddelande 

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- PrescriptionMessage

Information om receptmeddelande

Class

1


Se 1.2.1


- SubjectOfCare

Patient (Djurägare)

Class

1


Se 1.2.2

2013-09-23: Förtydligat att det är djurägare som avses.

- PrescriptionSet

Receptsamling.

Class

1


Se 1.2.3


 
 

1.2.1 PrescriptionMessage - Information om receptmeddelande

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- GeneralPrescriptionMessageInformation

Allmän information om meddelandet

Class

1


Se 1.2.1.1


- FunctionOfMessage

Meddelandetyp

1= Förskrivning, vilket innebär förskrivning av läkemedel, hjälpmedel och livsmedel.

V

1

{1}

Se 1.2.1.2

(finns endast med av historiska skäl)

2013-09-23: Kommentar korrigerad.

- MessageSender

Meddelandets sändare

Class

1


Se 1.2.1.3


- DesignatedMessageReceiver

Meddelandets mottagare

Class

1


Se 1.2.1.4


- Prescriber

Förskrivare

Class

1


Se 1.2.1.5


 
 
 

1.2.1.1 GeneralPrescriptionMessageInformation - Allmän information om meddelandet

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- IdOfMessageByOriginator

Skaparens unika identifikation

Class

1



2013-09-23: Beskrivning förtydligad.

-- IdOfMessageBySender

Sändarens unika identifikation

S

1

Char(41)

Idtyp anges i attributet idtype.

2013-09-23: Beskrivning förtydligad.

--- idtype

Typ av id.

A, E

1

Char(14) {UUID, GUID}

Exempel: <IdOfMessageBySender idtype="GUID"> 0af25f00-387d-11d3-9d31-00a0cc39621a </IdOfMessageBySender>

2014-04-22: UUID/GUID ska genereras enligt standard RFC 4122 enligt dokumentet NEF - Rekommendationer till hantering av UUID GUID Exemplet har uppdaterats

-- IssueDateAndTimeOfMessage

Tidpunkt för skapande av meddelande.

S

1

Char(20)

ccyy-mm-ddThh:mm:ss.

Denna tidpunkt kan vara samma som Tidpunkt för utfärdande (under recept) men kan avvika om det sker teknisk kontroll eller konvertering.


- UrgencyOfMessage

Brådskandegrad för meddelandet

N=Normal, H=High,

S

0..1

Char(1)

{N, H }

Endast N= Normal används.


- MessageReceiptAcknowledgementRequest

Önskemål om kvittens på meddelandet.

AL= Always

NE = Never

S

1

Char(2)

{AL}

Aperakflagga.


 
 
 

1.2.1.2 FunctionOfMessage - Meddelandetyp

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- FunctionOfMessage

Meddelandetyp

1= Förskrivning, vilket innebär förskrivning av läkemedel, hjälpmedel och livsmedel.

V

1

{1}

Finns endast av historiska skäl

2013-09-23: Kommentar korrigerad.

 
 
 

1.2.1.3 MessageSender - Meddelandets sändare

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- HealthcareAgentInContextId

Roll för sjukvårdsaktör

Class

1




-- Value

Roll.

Identifierar att det är sändare av meddelandet

E

1

Char(3)

{SND}

SND = Sender


- HealthcareAgent

Sjukvårdsaktör

Person/organisation som sänder meddelandet

Class

1


Måste vara samma som förskriver.


-- HealthcareAgentId

Identifikation för sjukvårdsaktör

Class

0..1


Används för närvarande inte för djur.

Vårdande enhet med arbetsplatskod endast obligatoriskt vid förskrivning av läkemedel med förmån. Saknas arbetsplatskod gäller ej läkemedelsförmån.

2013-09-23: Används för närvarande inte.

--- IdScheme

Kodtyp

E

1

Char(3)

{VEN}

Används för närvarande inte för djur.

Kod för arbetsplatskod.

VEN= Vårdande enhet

2013-09-23: Används för närvarande inte.

--- Value

Kodvärde för vårdande enhet

S

1

Char(17)

Används för närvarande inte för djur.

Odefinierat format. Standard saknas för arbetsplatskod.

2013-09-23: Används för närvarande inte.

-- HealthcareAgentId

Identifikation för sjukvårdsaktör

Class

1


Sjukvårdsaktör som är utfärdare återkommer endast en gång


--- IdScheme

Kodtyp

E

1

Char(3)

{UTF}

UTF = Utfärdarkod


--- Value

Kodvärde för sändande person

S

1

Char(17)

Sändande person måste vara samma som förskrivare.

Giltig förskrivarkod alltid obligatorisk vid elektronisk förskrivning.

För närvarande består förskrivarkoden av upp till 4 siffror.

2013-09-23: Förtydligat att förskrivarkoden fn består av 4 siffror.

2014-02-22: förskrivarkoden består av upp till 4 siffror.

-- HealthcareParty

Sjukvårdspart

Class

1




--- HealthcarePerson

Sjukvårdsperson

Class

1


Identitet för sändande sjukvårdsaktör.


---- Name

Namn

Efternamn Förnamn

S

1

Char(35)

Rekommendation är att implementera förskrivarens namn strukturerat (Efternamn Förnamn) i systemet som en förberedelse för framtida ändringar.

2013-09-23: Rekommendation tillagt i kommentar.

---- Qualification

Förskrivartyp alt Yrkeskvalifikation

Kodad form

E

1

Char(3)

{VET}

VET = Veterinär


--- Address

Adressinformation till förskrivarens arbetsplats

Class

1


Adress obligatoriskt för förskrivare.

2013-09-23: Kommentar korrigerad. Förtydligat att det är förskrivarens arbetsplats som avses.

---- PostalCode

Postnummer

S

1

Char(6)

Postnummer skall anges utan landskod, med fem siffror utan mellanrum.

 


---- StructuredAddress

Adress i strukturerad form

Class

1




----- NumberOrNameOfHouse

Lokalitet

S

1

Char(35)

Ex Djursjukhuset, ej gatunummer.

1.7.0: Satt som obligatorisk. Kommentar uppdaterad.

2014-10-09: Anonymisering av exempel

----- StreetName

Gatuadress

S

1

Char(35)

Ex Gata 1, gatunummer skall anges i Gatuadress.

2014-10-09: Anonymisering av exempel

----- City

Ort

S

1

Char(28)



---Telecommunication

Telefonnummer, inklusive riktnummer

S

1

Char(13)


1.5.0: Tagit bort Apoteksspecifik kommentar.
2013-09-23: Förtydligat under beskrivning att riktnummer är inkluderat.

 
 
 

1.2.1.4 DesignatedMessageReceiver - Meddelandets mottagare

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- HealthcareAgentInContextId

Roll för apoteksaktör

Class

1



2013-09-23: Förtydligat att det är apoteksaktör som avses

-- Value

Roll

E

1

Char(3)

{RCV}

RCV = Receiver


- HealthcareAgent

Organisation som mottager meddelandet

Class

1




-- HealthcareAgentId

Identifikation för apoteksaktör

Identifierar organisation som mottager meddelandet

Class

1


Används endast en gång i DesignatedMessageReciever

Här anges adressering till specifikt apotek när så är aktuellt (krav för FDA-kund samt vid "Beställning vid förskrivning").


--- IdScheme

Kodtyp

E

1

Char(3)

{GLN}

Kodtyp skall alltid finnas då kodvärde finns.

GLN = GLN-kod

1.5.0: EAN ersatt av GLN

--- Value

Kodvärde för receptbrevlådan eller mottagande apotek

S

1

Char(13)


2013-09-23: Förtydligande, receptbrevlådan tillagt.

 
 
 
 

1.2.1.5 Prescriber - Förskrivare (Samma som sändare)

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- HealthcareAgentInContextId

Roll för sjukvårdsaktör

Class

1




--Value

Roll.

Identifierar att det är förskrivaren

E

1

Char(10)

{PRESCRIBER}

PRESCRIBER = Förskrivare


- HealthcareAgent

Sjukvårdsaktör

Person som utfärdat receptet

Class

1




-- HealthcareAgentId

Identifikation för sjukvårdsaktör

Identifierar person/enhet som utfärdat receptet

Class

0..1


Används för närvarande inte för djur. Vårdande enhet med arbetsplatskod endast obligatoriskt vid förskrivning av läkemedel med förmån.

2013-09-23: Används för närvarande inte.

--- IdScheme

Kodtyp

E

1

Char(3)

{VEN}

Används för närvarande inte för djur.

Kodtyp alltid obligatorisk då kodvärde finns.

VEN = Vårdande enhet

2013-09-23: används för närvarande inte.

--- Value

Kodvärde för vårdande enhet

S

1

Char(17)

Används för närvarande inte för djur.

Arbetsplatskod.

2013-09-23: används för närvarande inte.

-- HealthcareAgentId

Roll för sjukvårdsaktör

Identifierar person/enhet som utfärdat receptet

Class

1


Endast en förskrivare per meddelande.

 


--- IdScheme

Kodtyp

E

1

Char(3)

{UTF}

Förskrivarkod. Kodtyp alltid obligatorisk då kodvärde finns.

UTF = Utfärdarkod


--- Value

Kodvärde för förskrivande person

S

1

Char(17)

Giltig förskrivarkod alltid obligatorisk vid elektronisk förskrivning. Utfyllnad med nollor eller dylikt accepteras inte

För närvarande består förskrivarkoden av upp till 4 siffror.

2014-04-22: Förskrivarkoden består av upp till 4 siffror.

-- HealthcareParty

Sjukvårdspart

Class

1




--- HealthcarePerson

Sjukvårdsperson

Class

1




---- Name

Namn

Efternamn Förnamn

S

1

Char(35)

Rekommendation är att implementera förskrivarens namn strukturerat (Efternamn Förnamn) i systemet som en förberedelse för framtida ändringar.

2013-09-23: Rekommendation har lagts till i kommentar.

---- Qualification

Förskrivartyp alt Yrkeskvalifikation Kodad form

E

1

Char(3)

{VET}

VET = Veterinär


--- Address

Förskrivarens arbetsplatsinformation

Class

1



2013-00-23: Förtydligat att det är förskrivarens arbetsplats som avses.

---- PostalCode

Postnummer

S

1

Char(6)

Postnummer ska anges utan landkod, med fem siffror utan mellanrum.


---- StructuredAddress

Adress i strukturerad form

Class

1




----- NumberOrNameOfHouse

Lokalitet

S

1

Char(35)

Exempelvis Djursjukhuset, inte gatunummer.

2014-10-09: Anonymisering av exempel

----- StreetName

Gatuadress

S

1

Char(35)

Exempelvis Gata 1, gatunummer ska anges i Gatuadress.

2014-10-09: Anonymisering av exempel

----- City

Ort

S

1

Char(28)



--- Telecommunication

Telefonnummer inklusive riktnummer

S

1

Char(13)



 
 
 

1.2.2 Subjectofcare - Patient {Djur}(Beskriver djurägare)

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- SubjectOfCare

Patient

Class

1


Beskriver hur SubjectOfCare används vid TypeOfSubjectOfCare = 2, e-recept för djur.

 


- TypeOfSubjectOfCare

Patienttyp

2 = Djur

V

1


Indikerar att detta är ett meddelande för e-recept djur.


- AnimalCarerMatchingInfo

Information om djurägare.

Class

1


Namn och adress till djurägare. Kan vara professionell djurägare om typ = ORG.

2013-09-23: Förtydligat djurägare och professionell djurägare.

-- PersonNameDetails

Namndetaljer

Class

1




--- StructuredPersonName

Strukturerat djurägarnamn

Class

1


Djurägarens namn (efternamn och förnamn).

2013-09-23: Förtydligat att det är djurägarens namn som avses.

---- FamilyName

Efternamn alternativt företagsnamn

S

1

Char(35)

Innehåller företagsnamn om typ=ORG.

Djurägarens efternamn alternativt företagsnamn för professionell djurägare

2013-09-23: Förtydligat att det är djurägarens efternamn alternativs företagsnamn som avses.

---- FirstGivenName

Förnamn

S

0..1

Char(35)

Obligatorisk om typ = PNR eller FDA.

Används ej om typ = ORG.

2013-09-23: Förtydligat att fältet ej används om typ = ORG.

-- CarerId

Identifiering av djurägare.

Class

1



2013-09-23: Korrigerat till djurägare.

--- IdScheme

Kodtyp

E

1

Char(3)

{PNR,

FDA,

ORG}

PNR = personnummer

FDA = Födelsedatum (utan löp- och kontrollsiffra)

ORG = Organisations­nummer, gäller för professionella djurägare. (gäller ej enskild firma vilken nyttjar PNR)


--- IdValue

Idnummer

Djurägarens identifikationsnummer.

S

1

Char(12)

PNR: ccyymmddpppp,

FDA: ccyymmdd.

FDA med sekelskiftes­nummer utan löp- och kontrollnummer.

ORG: 10 tecken.

2013-09-23: Korrigerat till djurägare.

-- Address

Adressinformation

Class

0..1


Adress ska anges.

2021-06-18
Ny text i kommentarsfältet med information om att adress ska anges för samtliga recept.

--- PostalCode

Postnummer

S

0..1

Char(6)

Postnummer ska anges utan landskod, med fem siffror utan mellanrum
 2016-01-27, förtydligat att postnummer består av 5 siffror.

--- StructuredAddress

Strukturerad adress

Class

1




---- StreetName

Gatuadress

S

1

Char (35)

Exempelvis Gata 1

2014-10-09: Anonymisering av exempel

---- City

Ort

S

1

Char (28)



--Telecommunication

Telefonnummer inklusive riktnummer

S

0..1

Char(13)



 
 
 

1.2.3 PrescriptionSet - Receptsamling (används bl.a. för information vid "beställning vid förskrivning")

Element/Attribut

Beskrivning

Typ

Före­komst

Datatyp / Value

Kommentar

Ändringslogg

- PrescriptionSetId

Id på receptsamling.

Identifierar en receptsamling som är en samling av förskrivna varor (kan innefatta mer än läkemedel - recept används i detta samman­hang för enkelhetens skull även för dessa förskrivna varor) till en djurägare vid ett visst tillfälle för ett visst syfte.

S

1

Char(41)

Idtyp anges i attributet idtype.

2013-09-23: Korrigerat till djurägare.

-- idtype

Typ av id.

A,E

1

Char(14) {UUID, GUID}

Exempel: <PrescriptionSetId idtype="GUID"> 0af25f00-387d-11d3-9d31-00a0cc39621a </PrescriptionSetId>

2014-04-22: UUID/GUID ska genereras enligt standard RFC 4122 enligt dokumentet NEF - Rekommendationer till hantering av UUID GUID Exemplet har uppdaterats.

- PrescriptionSetIssueTime

Tidpunkt för utfärdade.

Datum och tid för utfärdandet av receptet. Tidpunkt för utfärdande är tidpunkt då förskrivare skickar iväg recept från vårdapplikation.

T

1

Char(20)

ccyy-mm-ddThh:mm.

Mottagningsdatum får inte vara större än PrescriptionSetIssueTime plus 4 dygn.

eller 
Mottagningsdatum får inte vara större än IssueDateAndTimeOfMessageplus 4 dygn 

och

 

Mottagningsdatum får inte vara mindre än PrescriptionSetIssueTime

 2013-09-23: Förtydligat rimlighet för datum. Receptet måste hinna expedieras innan det går ut.​

- PrescribersComment

Förskrivarens kommentar

S

0..1

Char(35)

Detta fält nyttjas även vid behov av att tydligare specificera en professionell djurägare (typ = ORG) som finns på flera ställen i Sverige. Exempelvis: "Polisen Kalmar". Behovet av detta bedöms av förskrivare tillsammans med djurföreträdare.

2013-09-23: Korrigerat till djurföreträdare.

- PrescriptionItemDetails

Receptinformation

Ett recept är normalt en förpackning, av ett läkemedel eller annan vara. Ett recept kan begreppsmässigt även innehålla flera förpackningar (flera varurader) av samma vara/läkemedel. I detta fall knyts ett recept ihop av flera varurader med ett gemensamt första sekvensnummer på ReceptradId samt ett löpnummer för varje enskild tillkommande rad. Se kommentar för PrescriptionItemId.

Class

1..99


Se 1.2.3.1

Maximalt 99 receptrader, kan förskrivas i en receptsamling.


- PaymentDetails

Finansiella detaljer för hela receptsamlingen

Class

0..1


Se 1.2.3.2


- DeliveryLocation

Leveransinformation

Class

0..1



 


-- DeliveryMethod

Leveranssätt

E

1

Char(3)

{ADR,

APO}

För beställning vid förskrivning gäller:

ADR= Till angiven leveransadress
APO= Till angivet utlämnande apotek

2013-09-23: Förtydligat ADR och APO.

-- DeliveryLocationId

Identifikation för sjukvårdsaktör

Identifierar organisation som mottager meddelandet

Class

0..1


Obligatorisk om Leveranssätt = APO.


--- IdScheme

Kodtyp

E

1

Char(3)

{GLN}

Kodtyp ska alltid finnas då kodvärde finns.

GLN = GLN-kod


--- Value

Kodvärde utlämnande apotek

S

1

Char(13)


2013-09-23: Förtydligat utlämnande apotek.

-- DeliveryAddressDetails

Leveransadressdetaljer

Class

0..1


Obligatorisk om Leveranssätt=ADR


--- PostalCode

Postnummer

S

1

Char(6)


 


--- StructuredAddress

Adress i strukturerad form

Clas s

1




---- NumberOrNameOfHouse

Lokalitet

S

0..1

Char(35)

Ex Stall A

2013-09-23: Lagt till ett exempel.

---- StreetName

Gatuadress

S

1

Char(35)



---- City

Ort

S

1

Char(28)



--Telecommunication

Telefonnummer inklusive riktnummer

S

1

Char(13)

Djurägarens / djur­företrädarens telefon­nummer, obligatoriskt vid APO och ADR.

2013-09-23: Förtydligat att det är djurägarens / djurföreträdarens telefon­nummer som avses.

 
 

 

1.2.3.1 PrescriptionItemDetails - Receptinformation

Element/Attribut

Beskrivning

Typ

Före-Komst

Datatyp / Value

Kommentar

Ändringslogg

-- PrescriptionItemId

ReceptradId

S

1

Char(4)

Identifierar en receptrad inom ett recept. Det är normalt ett sekvens­nummer där man börjar med 1 (1-99) som kan följas av ett löpnummer (1-9) om flera förpackningar tillhör ett recept. Dessa ReceptradId måste vara unika inom varje receptsamling.

ReceptradId = <sekvensnummer>"-" <löpnummer>

Tex 1-1, 2-1, 2-2, 3-1, 3-2, 3-3.

Ett recept identifieras av Id på receptsamling och av sekvensnummer för receptrad.

OBS! E-hälsomyndigheten avråder från att implementera funktionalitet för flerval.

Anm . Om man måste förskriva två förpacknings­storlekar i ett recept för att t.ex. förskriva 75 st med hjälp av 1 st 50 tabl och 1 st 25 tabl så upprepas hela PrescriptionItemDetails (Ett recept skall t.ex. ha samma doserings­anvisning)

Exempel : om det tredje receptet innehåller två storlekar av förpackningar skrivs dessa som två PrescriptionItemDetailsrader:
PrescriptionItemId=3-1. och den andra PrescriptionItemId=3-2

2013-09-23: Rättat stavfel i kommentar. Korrigerat till förpackningsstorlek i kommentar.

-- LatestRequestedTimeForDispensing

Datum inom vilken första uttag av läkemedel måste göras.

S

0..1

Char(10)

ccyy-mm-dd

Kan användas för att ange begränsad giltighetstid för första uttaget. Expedieras inte receptet senast detta datum anses hela receptet förverkat. Expedieras receptet senast detta datum gäller resten av uttagen 1 år från utfärdandedatum.


-- PrescriptionItemAuthTime

Datum för sista giltighetsdag för recept. Ett absolut datum.

S

0..1

Char(10)

ccyy-mm-dd


Om inget datum anges sätts giltighetstid av E-hälsomyndigheten.

2021-06-18
Fältet ska användas from 28 januari 2022.

-- IndicationForPrescription

Behandlingsändamål

E

0..1

Char(5)

{1, 2, 3}

Ska endast användas för antimikrobiella läkemedel.

Obligatoriskt fält vid antimikrobiella läkemedel

1 = Terapi
2 = Profylax
3 = Metafylax
2021-06-18
Fältet ska användas from 28 januari 2022.

-- SubstitutionType

Typ av utbyte

E

0..2

Char(3)

{EBY, PRO}

Används ej för djur.

EBY=Får ej bytas mot generika

PRO=Startförpackning


-- PaymentDetails

Finansiella detaljer för enskild receptrad

Class

1


Se 1.2.3.1.1


-- PrescribedMedicinalProduct

Förskriven medicinsk produkt

Class

1


Se 1.2.3.1.2


 
 
 

1.2.3.1.1 PaymentDetails - Finansiella detaljer enskild recept rad

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- ServiceAgreementType

Identifiering av finansieringsavtal.

E

0..1

Char(3)

{STA}

Används ej för djur.

STA = Staten


- PaymentConditions

Betalningsvillkor

Class

1


Rättning i överens­stämmelse med receptföreskrifter om aktivt val av förmånstyp. Avvikelse från SIS XML.


-- CareCoverageType

Förmånstyp

E

1

Char(1)

{U}

U = Utan förmån

2013-09-23: Förtydligat kommentar, endast U är giltigt för djur.

 
 
 

1.2.3.1.2 PrescribedMedicinalProduct - Förskriven medicinsk produkt

 

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kom mentar

Ändringslogg

--- MedicinalProduct

Medicinsk produkt

Class

1


Se 1.2.3.1.2.1


--- InstructionsForUse

Instruktioner för användning

Class

0..1


Se 1.2.3.1.2.2. Obligatoriskt vid läkemedel och teknisk sprit.

2013-09-23: Teknisk sprit tillagt.

--- RepeatDispensingInstructions

Instruktioner för upprepad expediering

Class

1


Se 1.2.3.1.2.3


--- AnimalMatchingInformation

Beskriver djuridentitet.

Class

1


Se 1.2.3.1.2.4

 


--- QualifyingPeriodInformation

Beskriver karensinformation

Class

0..4


Se 1.2.3.1.2.5

 


 
 
 

1.2.3.1.2.1 MedicinalProduct - Medicinsk produkt (används även för att lagra information om Licensläkemedel)

 

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp / Value

Kommentar

Ändringslogg

- Status

Status

1 = Förskriven

V

1

{1}

Endast 1= Förskriven används.


- ProductType

Produkttyp

1 = Företagstillverkat läkemedel

V

1

{1}



- ManufacturedProductId


Class

1..2

 

Vid Status = 1, förskriven (se ovan), är denna klass obligatorisk.

Denna klass har max förekomst = 2 för att kunna skicka in både NPLId och NPLPackId.

2013-09-23: Förenklat kommentar.

2014-04-22: Förtydligat att klassen kan anges 2 gånger för att kunna skicka in både NPLId och NPLPackId.

-- ProductId

Produktnummer

S

1

Char(14)

Produktnummer är obligatorisk vid status = 1 vilket alltid är fallet.  

 2015-07-29: NVN 670000 har tagits bort

-- IdType

Typ av ID

E

1

Char(7)

{NVN, NPLID, NPLPACK}

Obligatoriskt då produkt­nummer finns.

Samtliga läkemedel ska förskrivas med NPL-värden, det vill säga NPL-id och NPLPACK-id.

Handelsvaror i VARA identifieras med NVN.

NPLID = identifierar läke­medel på produktnivå.

NPLPACK-id = identifierar läkemedel på förpacknings­nivå

NPL-värden är 14 tecken långa.

NVN= Nordiskt varu­nummer. NVN är sex tecken långa och numeriskt.

Tidigare värde förekomst: 0..1 Obligatoriskt. Nya kvalificerare för NPLIdn.
Ändringstyp: Regelverk, förberedelse för ny funktionalitet.
2013-09.23: Förtydligat att läkemedel bör förskrivas med NPL-värden, rekommen­dationen är att använda kombinationen. NPL-id och NPLPACK-id

NVN är inte tidsbeständig och unik identifierare för läkemedelsartiklar.

Förtydligat att om bägge NPL-värdena används ska de tillhöra samma artikel.

2014-04-22 Läkemedels­verkets NPL-värden består av siffror, fältet kan dock innehålla bokstäver.

NVN är inte längre tids­beständig och unik identifierare för läke­medels­artiklar då det förekommer parallell­importerade förpackningar som kan skilja sig från varandra

eHälsomyndigheten har beslutat att läkemedel ska förskrivas med NPLId och NPLPackId.

2015-04-02:  Förtydligat att alla läkemedel ska förskrivas på en kombination av NPL-id och NPLPACK-id.

-- SupplementaryInformation

 

Preparatnamn

S

0..1

Char(50)

Fältet får endast användas vid: Licens­läkemedel e-förskrivning och är då obligatoriskt.

Produktid:

NPLId: SB060301000001 NPLPackId:SB060301100001

Tilläggsinformation i fall av licensläkemedel. Beskriver namn på aktuell produkt.

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

 

-- DosageForm

Läkemedelsform

S

0..1

Char(20)

Fältet får endast användas vid: Licens­läkemedel e-förskrivning och är då obligatoriskt.

Produktid:

NPLId: SB060301000001 NPLPackId:SB060301100001.

Tilläggsinformation i fall av licensläkemedel. Beskriver läkemedelsform på aktuell produkt.

 

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

-- Strength

Styrka

S

0..1

Char(20)

Fältet får endast användas vid: Licens­läkemedel e-förskrivning och är då obligatoriskt.

Produktid:

NPLId: SB060301000001 NPLPackId:SB060301100001.

Tilläggsinformation i fall av licensläkemedel. Beskriver styrka på aktuell produkt.

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

-- Quantity

Mängd

D

0..1

Dec(6.2)

Min 0.01 … Max 9999.99

Fältet får endast användas vid: Licens­läkemedel e-förskrivning och är då obligatoriskt.

Produktid:

NPLId: SB060301000001 NPLPackId:SB060301100001.

Tilläggsinformation i fall av licensläkemedel. Beskriver mängd i förpackning på aktuell produkt.

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

--- QuantityUnit

Enhet för mängd

S

0..1

Char(2)

{st, gr, kg, ml, lt}

Fältet får endast användas vid: Licens­läkemedel e-förskrivning och är då obligatoriskt.

Produktid:


NPLId: SB060301000001 NPLPackId:SB060301100001.

Tilläggsinformation i fall av licensläkemedel. Beskriver enhet på mängden på aktuell produkt.
st = Styck
gr = Gram
kg = Kilogram
ml = Milliliter
lt = Liter

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

- Package

Förpackning

Class

1


Obligatoriskt vid status = 1 och vid Typ av ID = NPL och NVN.

2013-09-23: Förtydligat kommentar.

-- NumberOfPackages

Antal förpackningar

I

1

Int(4)

Min 1 … Max 9999


 


-- PackageContent

Antal i förpackning

I

0..1

Int(4)

Min 1 … Max 9999

Fältet får endast användas vid: Licens­läkemedel e-förskrivning och är då obligatoriskt.

Produktid:

NVN= 670000

eller

NPLId: SB060301000001 NPLPackId:SB060301100001.

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

- LicenseInformation

Information om licensläkemedel.

Class

0..1


Fältet får endast användas vid: Licens­läkemedel e-förskrivning.

Produktid:

NPLId: SB060301000001 NPLPackId:SB060301100001.

Om denna klass används är PharmacyId (nedan) obligatoriskt.

2013-09-23: Tagit bort: obligatoriskt om ProduktId = 67 00 00 samt att fältet endast får användas om Produktid= 67 00 00.

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

-- LicenseId

Licensid.

S

0..1

Char(20)

Idnummer för licens.

Läkemedelsverkets diarienummer för licensläkemedel.

Fältet får endast användas vid: Licens­läkemedel e-förskrivning.

Produktid:

NPLId: SB060301000001 NPLPackId:SB060301100001.

2013-09-23: Förtydligat licensläkemedel.

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

-- PharmacyId

Apoteksid.

S

1

Char(13)

Idnummer för apotek som har licens att hantera aktuellt licensläkemedel. GLN- kod.

Fältet får endast användas vid: Licens­läkemedel e-förskrivning.

Produktid:

NPLId: SB060301000001 NPLPackId:SB060301100001.

Om klassen LicenseInformation (enligt ovan) anges är detta fält obligatoriskt.

2014-10-09: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

2015-07-29: NVN 670000 har tagits bort

 
 
 

1.2.3.1.2.2 InstructionsForUse - Instruktion för användning

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp/ Value

Kommentar

Ändringslogg

- UnstructuredInstructionsForUse

Ostrukturerad instruktion för användning

Class

1




-- TypeOfInstruction

Typ av instruktion

1 = Doseringsanvisning

V

1

{1}

Typ av instruktion är obligatorisk.


-- UnstructuredDosageAdmin

Instruktion till djurägaren

S

1

Char(254)

Instruktion till djurägaren är obligatorisk vid förskrivning av läkemedel och teknisk sprit.

- Karenstid livstid skrivs i detta fält.
- Information kring OBS (förskrivning skall ej ifrågasättas) skrivs in i detta fält.
- Information kring Extempore skrivs in i detta fält.
- Anv. EJ för beskrivning av Licensläkemedel
Doseringsanvisningen ska vara i klartext, dvs förkortningar får ej förekomma (bortsett från ml, mg, E och cm vilka är tillåtna förkortningar). Texten ska inte innehålla några kontrolltecken (radbrytning, tab m fl).

2013-09-23: Teknisk sprit tillagt. Förtydligat djurägare.

Förtydligande gällande doserings­anvisningens utformning.

- LanguageOfLabel

Främmande språktyp.

Främmande språk för anvisningar i kodad form enligt ISO 639-1

E

0..1

Char(2)

Språkkoder och användning i e-recept definieras enligt ISO 639-1. XML-schemat uppdateras med kontroll av alla giltiga ISO-639-1 koder.

2013-09-23: Tagit bort hänvisningen till bilaga som inte uppdateras mer. Hänvisningen till standarden kvarstår.

 
 
 

1.2.3.1.2.3 PrescribedMedicinalProduct/RepeatDispensingInstructions - Instruktioner för upprepad expediering

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp/ Value

Kommentar

Ändringslogg

- DispensingRepeatNumber

Antal uttag.

Antalet gånger som receptet kan expedieras.

I

1

 

Int(2)

 

Min 1 ....

 

Max 99

 

1..99


- TimeInterval

Tid mellan uttag.

Tidsintervall mellan expedieringstillfällena.

Class

0..1


Absolut expeditionsintervall.

 


-- TimeValue

Tidsvärde

S

1

Char(4)

Obligatoriskt fält ifall tid mellan uttag finns med som klass. Obs endast heltal är tillåtet, maximalt t.ex. 365 dagar.


-- TimeUnit

Tidsenhet

E

1

Char(2)

{Dg, V, Mn}

Obligatoriskt fält ifall tid mellan uttag finns med som klass.

Dg = dag/dagar
V = vecka
Mn = månad


 
 
 

1.2.3.1.2.4 AnimalMatchingInformation - Djuridentitet 

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp/ Value

Kommentar

Ändringslogg

-AnimalMatchingInformation

Djuridentitet

Class

1



 


-- AnimalIdentification

Djuridentitet

S

1

Char(120)

Individidentitet, separerade med ett kommatecken.

 


-- AnimalIdQualifier

Typ av djuridentitet

IND = Individ/er

GRP = Grupp

BES = Besättning

E

1

Char 3

{IND, GRP, BES}



-- AnimalSpecies

Djurslag

S

1

Char(3)

Kod som korresponderar mot SJV's baslista av djurslag.

Koden skall alltid inledas med en nolla, därefter följer en tvåställig sifferkod. (ex. "015").


 
 
 

1.2.3.1.2.5 QualifyingPeriodInformation - Karensinformation

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp/ Value

Kommentar

Ändringslogg

-QualifyingPeriodInformation

Karensinformation

Class

0..4




-- QualifyingPeriodType

Karenstyp

S

1

Char(6)

{HONUNG, MJOLK, SLAKT, AGG }

Beskriver vilka olika sorts karens som finns.

1.5.0: Karenstyp START borttagen.

-- QualifyingPeriod

Antal dygn

I

1

Int(3)

Min 0

Max 365

Karensperiod

0..365. Antal dygn från senaste behandling.

0 dygn är ett värde som är skilt från odefinierat värde.

Livstid anges via fritext i Doseringsanvisning.

2013-09-23: Förtydligat dygn och karensperiod.

 
 

1.2.3.2 PaymentDetails - Finansiella detaljer hela receptsamlingen 

Denna funktionalitet har inte längre centralt stöd utan eventuell användning hanteras på lokal nivå.

 

Element/Attribut

Beskrivning

Typ

Före-komst

Datatyp/ Value

Kommentar

Ändringslogg

- Fee

Betalningsanspråk

Class

1




-- FeeType

Typ av betalningsanspråk,

E

1

Char(3)

{ARV}

ARV = Arvode


-- PaymentAccount

Konto

Class

1




--- IdType

Typ av konto

E

1

Char(3)

{PGI, BGI }

PGI=Plusgiro

BGI=Bankgiro


--- IdValue

Kontonummer

S

1

Char(10)

Odefinierat format.

 


-- Amount

Belopp

Class

1




--- Value

Värde

I

1

Int(3)

Min1....

Max999

Endast hela kronor.


--- Unit

Enhet, Betalningsvaluta

E

1

Char(3)

{SEK}

SEK = Svenska kronor


 

Versionshistorik

Datum

Version

 Författare

Kommentar

2014-04-22

3.0

 ​Monica Rosén

Specifikationen har bytt namn från "Specifikation för XML-recept djur" till "NEF - Specifikation för XML-recept djur".

Tagit bort versionshistorik som är äldre än 4 år.

1.2.1.1, Idtype, lagt till hänvisning till dokument som beskriver hur UUID/GUID ska genereras. Exemplet har uppdaterats.

1.2.1.3 och 1.2.1.5.Value, förtydligat att förskrivarkod kan vara upp till fyra tecken.

1.2.3, Idtype, lagt till hänvisning till dokument som beskriver hur UUID/GUID ska genereras. Exemplet har uppdaterats.

1.2.3.1.2.1, ManufacturedProductId, förtydligat att klassen kan anges 2 gånger för att kunna skicka in både NPLId och NPLPackId.

1.2.3.1.2.1, IdType, förtydligande gjorda angående NPLpack-id, NPLPId och NVN.

2014-10-09

4.0

 ​Monica Rosén​

1.2.3.1.2.1 SupplementaryInformation, DosageForm, Strength, Quantity, QuantityUnit, PackageContent, LicenseInformation, LicenseId och PharmacyId: Förtydligat att fältet endast får användas vid Licens­läkemedel e-förskrivning samt lagt till NPLId och NPLPackId.

​2016-04-19 ​5.0 ​Maria Hassel

​Ny mall. Förtydligande av syfte och målgrupp. Byter namn från  NEF - Specifikation för XML-recept - djur

1.2.2, Postnummer skall anges utan landskod, med fem siffror utan mellanrum.
1.2.3.1.2.1, IdType, Förtydligat att läkemedel ska förskrivas med en kombination av NPL-id och NPL-packid.
1.2.3.1.21.; ProductId, SupplementaryInformation, DosageForm, Strength, Quantity, QuantityUnit, PackageContent, LicenseInformation, LicenseId, och PharmacyId: NVN 670000 har tagits bort

​2017-12-15 ​6.0 ​Anette Karlsson 1.2.3.1​ ​Förtydligat att eHm avråder från flervalsrecept för djur.
​2021-01-28 ​7.0 ​ ​Redaktionella ändringar, ny stavning E-hälsomyndigheten
​2021-01-28 ​8.0 ​ ​1.2.3 Lagt till kommentar PrescriptionSetIssueTime
1.2.3.1 Tagit bort felaktig kommentar LatestRequestedTimeForDispensing​​
​2021-06-18 9.0​ ​Fabian Göransson

​1.2.2, Adress är obligatoriskt på samtliga recept

1.2.3.1 PrescriptionItemAuthTime och IndicationForPrescription kan nu användas vid förskrivning. Datatyp, kommentar uppdaterade.

 
 
 
 
 
 ​