NEF - Specifikation för XML-meddelande e-recept human
Denna sida beskriver det fastställda formatet för att skicka e-recept fö människa.
1. Inledning
1.1. 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.
1.1.1. 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.
1.1.2. Informationsnivå
Teknisk information.
1.1.3. Bakgrund
Detta dokument har tagits fram i ett nationellt samarbete med representanter från regionerna, Sveriges Apoteksförening, Distriktsveterinärerna och E-hälsomyndigheten (tidigare Apotekens Service). Förvaltningen av dokumentet ligger hos E-hälsomyndigheten.
1.1.4. 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.
1.2. Övergripande struktur
1.2.1. 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.
1.2.2. Förkortningar
-
Förekomst = antal gånger ett element eller attribut ska eller 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.
-
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)
1.2.3. Generella regler för meddelandestruktur
Om ett komplext element inte innehåller några obligatoriska element ska det komplexa elementet inte vara obligatoriskt. Denna regel tillämpas i specifikationen.
-
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.
-
Obligatoriska element får inte lämnas tomma. Detta kontrolleras vid mottagning av receptet.
1.2.4. 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 dokumentet Tillåtna tecken i element och attributdata.
1.2.5. 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.
1.2.6. Ändringslogg
Äldre relevanta kommentarer i ändringsloggen är utgråade.
1.2.7. Ä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.
1.2.8. XML-Schema definitioner
XML-specifikationer och koppling till respektive XML-schema finns specificerade i NEF - Implementationsguide . XML-specifikationer kan uppdateras separat utan att ett nytt XML-schema tas fram.
1.3. 1 Interchange (Rootelement) - Utväxlingsmeddelande
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
|---|---|---|---|---|---|
|
Interchange |
|
Class |
1 |
|
|
|
- MessageRoutingAddress |
Meddelandehuvud, transportinformation |
Class |
1 |
|
Se specifikation för XML-MessageRoutingAddress. Tillämpningar se 1.1
|
|
- NewPrescriptionMessage |
Receptmeddelande |
Class |
1 |
|
Se 1.2 |
1.3.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 specifikationen Message Routing Address.
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
MessageRoutingAddress |
Meddelandehuvud, transportinformation |
Class |
1 |
|
|
|
|
- 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: GLN tillagt |
|
- 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', det vill säga det är ett e-recept Exempel : <MessageType receipt="no">e-recept</MessageType> |
2013-09-23: Förtydligat tillämpning i beskrivning och kommentar, detta meddelande är ett e-recept |
1.3.2. NewPrescriptionMessage - Receptmeddelande
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
NewPrescriptionMessage |
Receptmeddelande |
Class |
1 |
|
|
|
|
- PrescriptionMessage |
Information om receptmeddelande |
Class |
1 |
|
Se 1.2.1 |
|
|
- SubjectOfCare |
Patient (Person) |
Class |
1 |
|
Se 1.2.2 |
2013-09-23: Förtydligat att det är person som avses. |
|
- PrescriptionSet |
Receptsamling. |
Class |
1 |
|
Se 1.2.3 |
|
1.3.2.1. PrescriptionMessage - Information om receptmeddelande
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
PrescriptionMessage |
Information om receptmeddelande |
Class |
1 |
|
|
|
|
- GeneralPrescriptionMessage
|
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 |
|
|
- MessageSender |
Meddelandets sändare |
Class |
1 |
|
Se 1.2.1.3 |
|
|
- DesignatedMessageReceiver |
Meddelandets mottagare |
Class |
1 |
|
Se 1.2.1.4. |
Tidigare värde 0..1. Obligatoriskt fält.
|
|
- Prescriber |
Förskrivare |
Class |
1 |
|
Se 1.2.1.5 |
|
1.3.2.2. GeneralPrescriptionMessageInformation - Allmän information om meddelandet
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
GeneralPrescriptionMessageInformation |
Allmän information om meddelandet |
Class |
1 |
|
|
|
|
- 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. |
Tidigare värde förekomst: 0..1. Obligatoriskt ID. Utökad längd för att möjliggöra användande av olika idtyper. Ändringstyp: Regelverk resp. utökad funktionallitet. 2013-09-23: Beskrivning förenklad |
|
--- idtype |
Typ av id. |
A,E |
1 |
Char(14) {UUID, GUID} |
Exempel: <IdOfMessageBySender idtype="GUID">0af25f00-387d-11d3-9d31-00a0cc39621a </IdOfMessageBySender > |
Nytt attribut för att kunna representera idtyp.
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. |
Tidigare värde förekomst: 0..1. Obligatoriskt. Ändring av format (T istället för mellanslag mellan dd och tt). Utökning av teckenlängd från 19 till 20 (optional med ett inledande minustecken XML typen dateTime). Ändringstyp: Regelverk, formaliserad struktur. |
|
- UrgencyOfMessage |
Brådskandegrad för meddelandet N=Normal, H=High, |
S |
0..1 |
Char(1) {N, H } |
Endast N= Normal används. |
Tillägg av definierade kvalificerare.
|
|
- MessageReceiptAcknowledgementRequest |
Önskemål om kvittens på meddelandet. AL= Always NE = Never |
S |
1 |
Char(2) {AL} |
Aperakflagga. |
Tidigare värde: 0..1, samt AP.
|
1.3.2.3. FunctionOfMessage - Meddelandetyp
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
|
|---|---|---|---|---|---|---|
|
- FunctionOfMessage |
Meddelandetyp 1= Förskrivning, vilket innebär förskrivning av läkemedel, hjälpmedel och livsmedel. |
V |
1 |
{1} |
|
|
1.3.2.4. MessageSender - Meddelandets sändare
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
MessageSender |
Meddelandets sändare |
Class |
1 |
|
|
|
|
- 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 |
Tidigare värde SENDER. Ändringstyp: Formaliserad struktur, enl. HL7. |
|
- 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 |
|
Vårdande enhet med arbetsplatskod som finns i arbetsplatskodregistret krävs vid elektronisk förskrivning. |
Tidigare värde förekomst: 1..*. Endast en Vårdande enhet är tillåten i detta sammanhang.
2016-04-16: Förtydligat att arbetsplatskoden ska finnas i arbetsplatskodregistret. |
|
--- IdScheme |
Kodtyp |
E |
1 |
Char(3) {VEN} |
Kod för arbetsplatskod. VEN= Vårdande enhet |
Tidigare värde förekomst: 0..1.
|
|
--- Value |
Kodvärde (arbetsplatskod) för vårdande enhet |
S |
1 |
Char(17) |
Arbetsplatskoden ska anges med minst 3 och max 13 siffror och ska finnas i arbetsplatskodregistret. |
2014-09-17: Förtydligat att arbetsplatskoden ska anges med mellan 3 och 13 siffror och ska finnas i arbetsplatskodsregistret 2015-04-02: förtydligat att arbetsplatskoden och ska finnas i arbetsplats-kodsregistret. |
|
-- HealthcareAgentId |
Identifikation för sjukvårdsaktör |
Class |
1 |
|
Sjukvårdsaktör som är utfärdare återkommer endast en gång |
Tidigare värde förekomst: 1..*. Endast en utfärdare är tillåten i detta sammanhang.
|
|
--- IdScheme |
Kodtyp |
E |
1 |
Char(3) {UTF} |
UTF = Utfärdarkod |
Tidigare värde förekomst: 0..1.
|
|
--- 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örtydligande av regelverk. |
|
-- 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 strukturerade namn (Efternamn Förnamn) i systemet som en förberedelse för framtida ändringar. |
2013-09-23: förtydligat kommentar |
|
---- Qualification |
Förskrivartyp alt Yrkeskvalifikation Kodad form |
E |
1 |
Char(3) {LAK, ATL, LMF, TAN, TAH, SSK, BMO, HJM} |
LAK = Leg läkare ATL = AT-läkare LMF = Läkare med förordnande TAN = Tandläkare TAH = Tandhygienist SSK = Sjuksköterska med särskild behörighet BMO = Barnmorska HJM = Hjälpmedelsförskrivare |
Definierad och ändrad mängd koder. Uppdaterad efter Socialstyrelsens kategorier för förskrivartyper. Bortaget DSK=Distriktssköterska
2011-10-17: Dietist används för närvarande inte 2013-09-23: DIT och VET har tagits bort från värdemängden. DIT (Dietister) saknar förskrivningsrätt och VET (Veterinärer) ska använda avsett XML-schema som tagits fram för djur |
|
--- Address |
Adressinformation till förskrivarens arbetsplats |
Class |
1 |
|
Adress obligatoriskt för förskrivare. |
2013-09-23: Förtydligat att det är förskrivarens arbetsplats som avses |
|
---- PostalCode |
Postnummer |
S |
1 |
Char(6) |
Postnummer ska anges utan landskod, med fem siffror utan mellanrum. |
|
|
---- StructuredAddress |
Adress i strukturerad form |
Class |
1 |
|
|
|
|
----- NumberOrNameOfHouse |
Lokalitet |
S |
0..1 |
Char(35) |
Exempelvis Vårdcentralen Humlan. Inte gatunummer. |
|
|
----- StreetName |
Gatuadress |
S |
1 |
Char(35) |
Exempelvis Storgatan 7, gatunummer ska anges i Gatuadress. |
Kan även användas för C/O. Ett specifikt fält för detta bör införas i framtida versioner. |
|
----- City |
Ort |
S |
1 |
Char(28) |
|
Tidigare värde: 25tkn.
|
|
---Telecommunication |
Telefonnummer inklusive riktnummer |
S |
1 |
Char(13) |
|
Tidigare värde förekomst: 0..*. Telefonnummer obligatorisk för förskrivare.
|
1.3.2.5. DesignatedMessageReceiver - Meddelandets mottagare
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
DesignatedMessageReceiver |
Meddelandets mottagare |
Class |
1 |
|
|
Tidigare värde 0..1. Obligatoriskt fält. Ändringstyp: Regelverk. |
|
- 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 |
Tidigare värde RECEIVER. Ändringstyp: Formaliserad struktur, enl. HL7. |
|
- HealthcareAgent |
Organisation som mottager meddelandet |
Class |
1 |
|
|
2013-09-23: Förtydligat beskrivning. |
|
-- HealthcareAgentId |
Identifikation för apoteksaktör Identifierar organisation som tar emot meddelandet |
Class |
1 |
|
Används endast en gång i DesignatedMessageReciever. E-hälsomyndighetens receptbrevlåda anges i första hand om förskrivning sker på personnummer (PNR). Specifikt apotek måste anges om förskrivning sker på födelsedatum (FDA). |
Tidigare värde förekomst: 1..*. Endast en mottagare.
2013-09-23: Förtydligat att det är apoteksaktör som avses. Förtydligande ang PNR och FDA i kommentar. 2014-04-22: ersatt Apotekens Service med eHälsomyndigheten. |
|
--- IdScheme |
Kodtyp |
E |
1 |
Char(3) {EAN} |
Kodtyp ska alltid finnas då kodvärde finns. EAN = EAN-kod / GLN-kod |
Tidigare värde förekomst: 0..1
|
|
--- Value |
Kodvärde för receptbrevlådan eller mottagande apotek |
S |
1 |
Char(13) |
|
2013-09-23: Förtydligande, receptbrevlådan tillagt. |
1.3.2.6. Prescriber - Förskrivare
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
Prescriber |
Förskrivare |
Class |
1 |
|
|
|
|
- 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 |
Tidigare värde Typ = S, ändrat till Typ lika med V.
|
|
- 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 |
|
Vårdande enhet med arbetsplatskod endast obligatoriskt vid förskrivning av läkemedel med förmån. |
Tidigare värde förekomst: 1..*. Endast en vårdande enhet.
|
|
--- IdScheme |
Kodtyp |
E |
1 |
Char(3) {VEN} |
Kodtyp alltid obligatorisk då kodvärde finns. VEN = Vårdande enhet |
Tidigare värde förekomst: 0..1
|
|
--- Value |
Kodvärde för vårdande enhet |
S |
1 |
Char(17) |
Arbetsplatskod |
|
|
-- HealthcareAgentId |
Roll för sjukvårdsaktör Identifierar person/enhet som utfärdat receptet |
Class |
1 |
|
Endast en förskrivare per meddelande. |
Tidigare värde förekomst: 1..*. Endast en utfärdare.
|
|
--- IdScheme |
Kodtyp |
E |
1 |
Char(3) {UTF} |
Förskrivarkod. Kodtyp alltid obligatorisk då kodvärde finns. UTF = Utfärdarkod |
Tidigare värde förekomst: 0..1 Ändringstyp: Formaliserad struktur. |
|
--- 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. |
|
|
-- HealthcareParty |
Sjukvårdspart |
Class |
1 |
|
|
|
|
--- HealthcarePerson |
Sjukvårdsperson |
Class |
1 |
|
|
|
|
---- Name |
Namn Efternamn Förnamn |
S |
1 |
Char(35) |
Rekommendation är att implementera strukturerade namn (Efternamn Förnamn) i systemet som en förberedelse för framtida ändringar. |
2013-09-23: förtydligat kommentar |
|
---- Qualification |
Förskrivartyp alt Yrkeskvalifikation Kodad form |
E |
1 |
Char(3) {LAK, ATL, LMF, TAN, TAH, SSK, BMO, HJM} |
LAK =Leg läkare, ATL=AT-läkare, LMF=Läkare med förordnande, TAN=Tandläkare, TAH=Tandhygienist SSK=Sjuksköterska med särskild behörighet, BMO=Barnmorska, HJM = Hjälpmedelsförskrivare |
Definierad och ändrad mängd koder. Uppdaterad efter de Socialstyrelsens kategorier för förskrivartyper. Bortaget DSK=Distriktssköterska
|
|
--- Address |
Förskrivarens arbetsplatsinformation |
Class |
1 |
|
|
2013-09-23: förtydligat att det är förskrivarens arbetsplats som avses. |
|
---- PostalCode |
Postnummer |
S |
1 |
Char(6) |
Postnummer ska anges utan landskod, med fem siffror utan mellanrum. |
|
|
---- StructuredAddress |
Adress i strukturerad form |
Class |
1 |
|
|
|
|
----- NumberOrNameOfHouse |
Lokalitet |
S |
0..1 |
Char(35) |
Exempelvis Vårdcentralen Humlan, inte gatunummer. |
|
|
----- StreetName |
Gatuadress |
S |
1 |
Char(35) |
Exempelvis Storgatan 7, gatunummer ska anges i Gatuadress. |
|
|
----- City |
Ort |
S |
1 |
Char(28) |
|
Tidigare värde: 25tkn.
|
|
--- Telecommunication |
Telefonnummer inklusive riktnummer |
S |
1 |
Char(13) |
|
Tidigare värde förekomst: 0..*. Telefonnummer obligatorisk för förskrivare.
|
1.3.2.7. Subjectofcare - Patient {Person}
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
- SubjectOfCare |
Patient |
Class |
1 |
|
|
|
|
- TypeOfSubjectOfCare |
Patienttyp 1 = Person |
V |
1 |
|
|
|
|
- PatientMatchingInfo |
Patientinformation |
Class |
1 |
|
|
|
|
-- PersonNameDetails |
Namndetaljer |
Class |
1 |
|
|
|
|
--- StructuredPersonName |
Strukturerat personnamn |
Class |
1 |
|
Patientens namn (efternamn och förnamn). |
Tidigare värde förekomst: 0..1. Ändringstyp: Regelverk. 2013-09-23: Förtydligat att det är patientens namn som avses. |
|
---- FamilyName |
Efternamn |
S |
1 |
Char(35) |
|
Tidigare värde förekomst: 0..1.
|
|
---- FirstGivenName |
Förnamn |
S |
1 |
Char(35) |
|
Tidigare värde förekomst: 0..1.
|
|
-- PatientId |
Patientid |
Class |
1 |
|
Någon form av patientidentifikation är obligatorisk. |
Tidigare värde förekomst: 0..1.
|
|
--- IdScheme |
Kodtyp |
E |
1 |
Char(3) {PNR, FDA} |
PNR = personnummer FDA = Födelsedatum (utan löp- och kontrollsiffra) |
Tidigare värde förekomst: 0..1. Tillägg FDA.
|
|
--- IdValue |
Idnummer Kundens (patientens) identifikationsnummer inklusive sekelsiffror |
S |
1 |
Char(12) |
PNR: ccyymmddpppp, FDA: ccyymmdd. FDA med sekelskiftesnummer utan löp- och kontrollnummer. |
|
|
-- Address |
Adressinformation |
Class |
0..1 |
|
|
Tidigare värde förekomst: .
|
|
--- 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 fem siffror |
|
--- StructuredAddress |
Strukturerad adress |
Class |
1 |
|
I denna implementation används endast strukturerad adress. |
|
|
---- StreetName |
Gatuadress |
S |
1 |
Char (35) |
Exempelvis Lillgatan 9 |
Tidigare värde förekomst: 0..1.
|
|
---- City |
Ort |
S |
1 |
Char (28) |
|
Tidigare värde förekomst: 0..1. Ändringstyp: Regelverk. |
|
-- Telecommunication |
Telefonnummer inklusive riktnummer |
S |
0..1 |
Char(13) |
|
Tidigare värde: Telefonnummer saknades för Patient.
|
|
-- Sex |
Kön 1=man 2=kvinna 3=ej specificerat |
V |
0..1 |
Char(1) |
Enligt Socialstyrelsens föreskrifter, SOSFS 2003:13 (M), Man = 1 och Kvinna = 2. Avviker från GPIC-standarden (EN 14822-2, GPIC 9.1.2.2 Person). |
Definierad mängd koder.
|
1.3.2.8. PrescriptionSet - Receptsamling
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
PrescriptionSet |
Receptsamling. |
Class |
1 |
|
|
|
|
- PrescriptionSetId |
Id på receptsamling.
|
S |
1 |
Char(41) |
Idtyp anges i attributet idtype. |
Utökad längd för att möjliggöra användande av olika idtyper.
|
|
-- idtype |
Typ av id. |
A,E |
1 |
Char(14) {UUID, GUID} |
Exempel: <PrescriptionSetId idtype="GUID">0af25f00-387d-11d3-9d31-00a0cc39621a
|
Nytt attribut för att kunna representera idtyp.
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ärdande.
|
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 |
Tidigare värde förekomst: 0..1.
2013-09-23: Förtydligat datums giltighet. Patienten måste hinna få receptet expedierat innan det går ut.
|
|
- PrescribersComment |
Förskrivarens kommentar |
S |
0..1 |
Char(35) |
I fältet är det möjligt för förskrivaren att lämna kortfattad upplysning som kan vara relevant för apotekspersonal vid expediering. |
Tidigare värde: Det var möjligt att ange annan giltighetstid genom GILT nn (månader). Detta tas bort. Istället skall LatestRequestedTimeForDispensing användas.
|
|
- 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. |
Tidigare värde förekomst: 1..* Ändringstyp: Formaliserad struktur. |
|
- PaymentDetails |
Finansiella detaljer för hela receptsamlingen |
Class |
0..1 |
|
Se 1.2.3.2 |
Tidigare värde förekomst: 1. Ej obligatoriskt.
|
|
- DeliveryLocation |
Leveransinformation |
Class |
0..1 |
|
Om receptsamlingen avser att skickas till distanshandel är leveransinformation obligatorisk. |
2011-10-17: Dokumentet "Frågor och svar" uppdateras inte mer. 2011-11-09: Ersatt "distansapotek" med distanshandel. Leveransinformation är liksom tidigare obligatorisk då receptsamling ska skickas till distanshandel. |
|
-- DeliveryMethod |
Leveranssätt |
E |
1 |
Char(3) {MAI} |
Adress avser slutadress för leverans, till exempel till ombud. Ska användas vid leverans via ombud. MAI = Skickas som paket |
|
|
-- DeliveryAddressDetails |
Leveransadressdetaljer |
Class |
1 |
|
|
|
|
---UnstructedAddress |
Adress i ostrukturerad form |
Class |
1 |
|
|
Tidigare värde förekomst 0..1. Finns DeliveryAddressDetails måste även UnstructuredAddress vara obligatorisk då det är enda alternativet. Ändringstyp: Formaliserad struktur. |
|
----UnstructedAddressLine |
Adressrad |
S |
1 |
Char(35) |
|
Tidigare värde förekomst 1.* Endast ett kan fn anges.
|
1.3.2.9. PrescriptionItemDetails - Receptinformation
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
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 |
|
|
Tidigare värde förekomst: 1..*
|
|
- PrescriptionItemId |
ReceptradId |
S |
1 |
Char(4) |
Identifierar en receptrad inom ett recept. Det är normalt ett sekvensnummer där man börjar med 1 (1-99) som följs av ett löpnummer (1-9). 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. Anmärkning: Om man måste förskriva två förpackningsstorlekar i ett recept för att exempelvis förskriva 75 st med hjälp av 1 st 50 tabl och 1 st 25 tabl förpackningar så upprepas hela PrescriptionItemDetails (Ett recept ska till exempel ha samma doseringsanvisning) 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 |
2010-11-25: Ändrat från "ska" till "behöver" angående löpnummer vid flerval 2013-09-23: 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. |
Tillägg av nytt fält.
|
|
- PrescriptionItemAuthTime |
Datum för sista giltighetsdag för recept. Ett absolut datum. Idag gäller alltid 1 år. Förkortad giltighetstid gäller alltid enbart för första uttag. |
S |
0..1 |
Char(10) |
Fältet ska inte användas idag. ccyy-mm-dd Förvalt värde är alltid 1 år från utfärdandedatum. |
Tillägg av nytt fält.
|
|
- IndicationForPrescription |
Förskrivningsorsak Enligt specifikation av Socialstyrelsen |
E |
0..1 |
Char(5) {ej fastställt} |
Används inte för närvarande
|
|
|
- SubstitutionType |
Typ av utbyte |
E |
0..2 |
Char(3) {EBY, PRO} |
Max 2 EBY=Får ej bytas mot generika PRO=Startförpackning |
Tidigare värde förekomst: 0..*.
|
|
- 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.3.2.10. PaymentDetails - Finansiella detaljer enskild recept rad
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
PaymentDetails |
Finansiella detaljer för enskild receptrad |
Class |
1 |
|
|
|
|
- ServiceAgreementType |
Identifiering av finansieringsavtal. |
E |
0..1 |
Char(3) {STA} |
STA = Staten |
|
|
- PaymentCondition |
Betalningsvillkor |
Class |
1 |
|
Rättning i överensstämmelse med receptföreskrifter om aktivt val av förmånstyp. Avvikelse från SIS XML. |
|
|
-- CareCoverageType |
Förmånstyp |
E |
1 |
Char(1) {R, U} |
R = Rabatt/Förmån U = Utan förmån |
Definierad mängd koder. Ändringstyp: Formaliserad struktur. |
1.3.2.11. PrescribedMedicinalProduct - Förskriven medicinsk produkt
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
PrescribedMedicinalProduct |
Förskriven medicinsk produkt |
Class |
1 |
|
|
|
|
- MedicinalProduct |
Medicinsk produkt |
Class |
1 |
|
Se 1.2.3.1.2.1 |
|
|
- InstructionsForUse |
Instruktioner för användning |
Class |
0..1 |
|
Se1.2.3.1.2.2. Obligatoriskt vid läkemedel och teknisk sprit. |
2010-11-25: Teknisk sprit tillagd.
|
|
- RepeatDispensingInstructions |
Instruktioner för upprepad expediering |
Class |
1 |
|
Se 1.2.3.1.2.3 |
|
1.3.2.12. MedicinalProduct - Medicinsk produkt
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
MedicinalProduct |
Medicinsk produkt |
Class |
1 |
|
|
|
|
- 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 NPL-id och NPLPACK-id. |
Tidigare värde förekomst: 0..1 Obligatoriskt. Möjligt att kunna använda två Idn vid användande av NPLIdn.
2014-04-22: Förtydligat att klassen kan anges 2 gånger för att kunna skicka in både NPL-id och NPLPACK-id. |
|
-- ProductId |
Produktnummer |
S |
1 |
Char(14) |
Produktnummer är obligatorisk vid status = 1 vilket alltid är fallet. |
Tidigare värde förekomst: 0..1, char(6) Obligatoriskt samt 14 tkn för att hantera NPLidn Ändringstyp: Regelverk, förberedelse för ny funktionalitet. |
|
-- IdType |
Typ av ID |
E |
1 |
Char(7) {NVN, NPLID, NPLPACK} |
Obligatoriskt då produktnummer finns. Samtliga läkemedel ska förskrivas med NPL-värden, det vill säga kombinationen NPL-id och NPLPACK-id. Handelsvaror inom förmånen identifieras med NVN. NPLID = identifierar läkemedel på produktnivå. NPLPACK-id identifierar läkemedel på förpackningsnivå NPL-värden är 14 tecken långa. NVN= Nordiskt varunummer. NVN är sex tecken långa och numeriskt. |
Tidigare värde förekomst: 0..1 Obligatoriskt. Nya kvalificerare för NPLIdn.
2014-04-22: Läkemedelsverkets NPL-värden består av siffror, fältet kan dock innehålla bokstäver. NVN är inte längre tidsbeständig och unik identifierare för läkemedelsartiklar då det förekommer parallellimporterade 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 med NPL-värden, dvs en kombination av NPL-id och NPLPACK-id. |
|
- Package |
Förpackning |
Class |
1 |
|
Obligatoriskt vid status = 1 och vid Typ av ID = NPL och NVN. |
Tidigare värde förekomst: 0..1 Obligatoriskt.Ändringstyp: Regelverk. 2013-09.23: Förtydligat kommentar. |
|
-- NumberOfPackages |
Antal förpackningar |
I |
1 |
Int(4) Min 1 … Max 9999 |
|
|
1.3.2.13. InstructionsForUse - Instruktion för användning
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
InstructionsForUse |
Instruktioner för användning |
Class |
0..1 |
|
|
Tidigare värde förekomst 0..*.
|
|
- UnstructuredInstructionsForUse |
Ostrukturerad instruktion för användning |
Class |
1 |
|
|
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
-- TypeOfInstruction |
Typ av instruktion 1 = Doseringsanvisning |
V |
1 |
{1} |
Typ av instruktion är obligatorisk. |
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
-- UnstructuredDosageAdmin |
Instruktion till patienten |
S |
1 |
Char(254) |
Instruktion till patienten är obligatorisk vid förskrivning av läkemedel och teknisk sprit. |
Teknisk sprit tillagd.
|
|
- LanguageOfLabel |
Främmande språktyp. Främmande språk för anvisningar i kodad form enligt ISO 639-1 |
E |
0..1 |
Char(2) |
XML-schemat uppdateras med kontroll av alla giltiga ISO-639-1 koder. |
Uppdatering av beskrivning och definition av giltiga koder. Ändringstyp: Formalisering. |
1.3.2.14. PrescribedMedicinalProduct/RepeatDispensingInstructions - Instruktioner för upprepad expediering
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
RepeatDispensingInstructions |
Instruktioner för upprepad expediering |
Class |
1 |
|
|
|
|
- DispensingRepeatNumber |
Antal uttag. Antalet gånger som receptet kan expedieras |
I |
1 |
Int(2) Min 1 ....
|
1..99 |
|
|
- TimeInterval |
Tid mellan uttag Tidsintervall mellan expedieringstillfällena |
Class |
0..1 |
|
Apotek kan expediera receptet på nytt om den angivna tiden har gått från den tidigare expedieringen. |
2013-09-23: Förtydligat kommentar. |
|
-- TimeValue |
Tidsvärde |
S |
1 |
Char(4) |
Obligatoriskt fält om tid mellan uttag finns med som klass. Observera att endast heltal är tillåtet, maximalt till exempel 365 dagar. |
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
-- TimeUnit |
Tidsenhet |
E |
1 |
Char(2) {Dg, V, Mn} |
Obligatoriskt fält om tid mellan uttag finns med som klass. Dg = dag/dagar
|
Tidigare värde förekomst: 0..1 Obligatoriskt. Definierad kodmängd. Mån ändrad till Mn för att minska problem med ÅÄÖ i Schema.
|
1.3.2.15. PaymentDetails - Finansiella detaljer hela receptsamlingen
Funktionalitet för hantering av arvode har utgått. Fälten går fortfarande att skicka in, men informationen i dessa fält är inte synliga för apotek. Detta innebär att apoteken inte har någon möjlighet att administrera arvoden.
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp / Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
PaymentDetails |
Finansiella detaljer för hela receptsamlingen |
Class |
0..1 |
|
|
Tidigare värde förekomst: 1. Ej obligatoriskt.
|
|
- Fee |
Betalningsanspråk |
Class |
1 |
|
|
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
-- FeeType |
Typ av betalningsanspråk, |
E |
1 |
Char(3) {ARV} |
ARV = Arvode |
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
-- PaymentAccount |
Konto |
Class |
1 |
|
|
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
--- IdType |
Typ av konto |
E |
1 |
Char(3) {PGI, BGI } |
|
Tidigare värde förekomst: 0..1 Obligatoriskt. Definierad kodmängd. BKO bortaget.
|
|
--- IdValue |
Kontonummer |
S |
1 |
Char(10) |
Odefinierat format . |
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
-- Amount |
Belopp |
Class |
1 |
|
|
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
--- Value |
Värde |
I |
1 |
Int(3)
|
Endast hela kronor. |
Tidigare värde förekomst: 0..1 Obligatoriskt.
|
|
--- Unit |
Enhet, Betalningsvaluta |
E |
1 |
Char(3)
|
SEK = Svenska kronor |
|
1.4. Versionhistorik
|
Datum |
Version |
Beskrivning |
|---|---|---|
|
2014-04-22 |
4.0 |
Specifikationen har bytt namn från "Specifikation för XML-recept" till "NEF- Specifikation för XML-recept" Tagit bort versionshistorik som är äldre än 4 år gammal. Ersatt Apotekens Service med eHälsomyndigheten. 1.2.1.1, Idtype, lagt till hänvisning till dokument som beskriver hur UUID/GUID ska genereras. Exemplet har uppdaterats. 1.2.1.4, HealthcareAgentId: ersatt Apotekens Service med eHälsomyndigheten 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-09-17 |
5.0 |
1.2.1.3, HealtcareAgendId/IdScheme/Value, Förtydligande angående arbetsplatskod, Förtydligat att arbetsplatskoden ska anges med mellan 3 och 13 siffror. 1.2.3.2, PaymentDetails, funktionaliteten har utgått. Fälten går fortfarande att skicka in, men informationen i dessa fält är inte synliga för apotek. |
| 2016-04-16 | 6.0 |
Ny mall. Förtydligande av syfte och målgrupp. Byter namn från NEF - Specifikation för XML-recept. 1.2.1.3, HealthcareAgentId och Value förtydligat att arbetsplatskoden ska finnas i arbetsplatskodsregistret.
|
| 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 |
| 2023-11-16 | 9.0 | 1.2.2 Tagit bort kommentar i Address att adress bör anges vid förskrivning av särskilda läkemedel, efter föreskriftsuppdatering (HSLF-FS 2021:75) |