NEF - Specifikation för XML-meddelande makuleringsbegäran djur
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 information i ett XML-meddelande på ett korrekt sätt.
1.2. Målgrupp
Målgrupp för denna sida är vårdgivare med IT-system som nyttjar eHälsomyndighetens tjänster samt systemleverantör som utvecklar eller förvaltar dessa IT-system.
1.3. Informationsnivå
Teknisk information.
1.4. Övergripande struktur
1.4.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.4.2. Förkortningar
-
Förekomst = antal ggr ett element eller attribut skall/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 skall framgå av tabell. (Exempel: 1 = Förskrivning)
I = Integer = Heltal
E = Enumerated = Uppräkningsbar typ (alfanumerisk), där tabell skall ange tillåtna värden med förklaringar. (Exempel: VEN)
1.4.3. Generella regler för meddelandestruktur
-
Om ett komplext element inte innehåller några obligatoriska element skall det komplexa elementet inte vara obligatorisk.
Denna regel tillämpas i specifikationen.
-
Om ett element inte är obligatorisk och inte innehåller data skall det inte finnas med i meddelandet.
Denna regel är nödvändig att följa för att det skall 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.
1.4.4. Tillåtna tecken i element- och attributfält
XML-meddelanden skall följa XML 1.0. Endast kodning enligt UTF-8 tillåts. Detta skall anges i en XML-deklaration. Detta gäller enbart meddelandet vilket kan konverteras till UTF-8 i t.ex. en receptserver ifall aktuellt journalsystem 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.
1.4.5. XML-reserverade tecken
För XML-reserverade tecken skall ersättas enligt "Extensible Markup Language (XML) 1.0 (Fourth Edition) 2.4 Character Data and Markup" (Se www.w3c.org).
CDATA sektioner tillåts inte.
1.4.6. Ändringslogg
Äldre relevanta kommentarer i ändringsloggen utgråas.
1.4.7. XML-Schema definitioner
XML-specifikationer och koppling till respektive XML-schema finns specificerade i NEF - Tteknisk implementationsguide. XML-specifikationer kan uppdateras separat utan att ett nytt XML-schema tas fram.
2. Interchange (Rootelement) - Utväxlingsmeddelande
|
Element/Attribut |
Beskrivning |
Typ |
Före- komst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
Interchange |
|
Class |
1 |
|
|
|
|
- MessageVersion |
Fält för identifiering av XML-meddelandets version |
S |
1 |
Char(4) |
Exempel <MessageVersion>1.0<
|
|
|
- MessageRoutingAddress |
Meddelandehuvud, transportinformation |
Class |
1 |
|
Tillämpningar beskrivs under 1.1 MessageRoutingAddress - Transportinformation |
2014-10-08: Förtydligande i kommentar |
|
- PrescriptionCancellationMessage |
Makuleringsmeddelande |
Class |
1 |
|
Se 1.2 |
|
2.1.1. MessageRoutingAddress - Transportinformation
Tillämpning av MessageRoutingAdress enligt följande:
|
Element/Attribut |
Beskrivning |
Typ |
Före-komst |
Datatyp/ Value |
Kommentar
|
Ändringslogg |
|---|---|---|---|---|---|---|
|
MessageRoutingAddress |
Meddelandehuvud, transportinformation |
Class |
1 |
|
|
|
|
-Sender |
Sändarens EAN/GLN-kod |
|
1 |
|
|
2014-10-08: GLN tillagt |
|
-Sender Qualifier |
Kvalificerare för Sändare. |
V |
1 |
Char(4) {14, 30, ZZZ} |
14 = EAN/GLN 30 = Organisationsnummer ZZZ = Avtalad struktur mellan parterna. |
2014-10-08: GLN tillagt |
|
-SubSender |
Systemidentitet för sändande system |
S |
1 |
Char(20) |
|
2014-10-08: Rättat, det är sändande system som avses |
|
- SubSenderInfo |
Ytterligare information om systemet som skapat det refererade meddelandet |
Class |
1 |
|
|
|
|
- - SystemName |
Namn på system |
S |
1 |
Char(20) |
|
|
|
-- SystemVersion |
Version på system |
S |
1 |
Char(20) |
|
|
|
-- ModuleVersion |
Version på eventuell använd modul i system |
S |
0..1 |
Char(20) |
|
|
|
-- SystemInfo |
Information från system |
S |
0..1 |
Char(100) |
|
|
|
- InterchangeDate |
Utväxlingsdatum |
S |
1 |
Char(10) |
ccyy-mm-dd Datum då meddelandet skickas till mottagare. |
|
|
- InterchangeTime |
Utväxlingstidpunkt |
S |
1 |
Char(8) |
hh:mm:ss Tidpunkt då meddelandet skickas till mottagare. |
|
|
- InterchangeRef |
Överföringsreferens. Unik referens för överföringen given av avsändaren |
S |
1 |
Char(41) |
Idtyp anges i attributet idtype. |
|
|
-- idtype |
Typ av id. |
A,E |
1 |
Char(14) {GUID,UUID} |
Exempel : <InterchangeRef idtype="UUID"> 0af25f00-387d-11d3-9d31-00a0cc39621a<
|
2014-10-08: Exemplet har uppdaterats. |
2.1.2. PrescriptionCancellationMessage - Receptmakuleringsmeddelande
|
Element/Attribut |
Beskrivning |
Typ |
Före- komst |
Datatyp/ Value |
Ko mmentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
PrescriptionCancellationMessage |
Information om receptmakuleringsmeddelande |
Class |
1 |
|
|
|
|
- GeneralCancellationMessageInformation |
Allmän information om meddelandet |
Class |
1 |
|
Se 1.2.1 |
|
|
-MessageSender |
Meddelandets sändare, Makulerare |
Class |
1 |
|
Se 1.2.2 |
|
|
-SubjectOfCare |
Djurägare |
Class |
1 |
|
Se 1.2.3 |
|
|
-CancellationSet |
Makuleringsmängden |
Class |
1 |
|
Se 1.2.4 |
|
2.1.2.1. GeneralCancellationMessageInformation - Allmän information om meddelandet
|
Element/Attribut |
Beskrivning |
Typ |
Före- komst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
GeneralCancellationMessageInformation |
Allmän information om meddelandet |
Class |
1 |
|
|
|
|
- IdOfMessageByOriginator |
|
Class |
1 |
|
|
|
|
-- IdOfMessageBySender |
Sändarens unika identifikation på makuleringsmeddelandet |
S |
1 |
Char(41) |
Idtyp anges i attributet idtype. |
|
|
--- Idtype |
Typ av id. |
A,E |
1 |
Char(14) {GUID, UUID} |
Exempel : <IdOfMessageBySender idtype="UUID"> 0af25f00-387d-11d3-9d31-00a0cc39621a<
|
2014-10-08: Exemplet har uppdaterats. |
|
-- IssueDateAndTimeOfMessage |
Tidpunkt för skapande av makuleringsmeddelande. |
S |
1 |
Char(20) |
ccyy-mm-ddThh:mm:ss. |
|
2.1.2.2. MessageSender - Meddelandets sändare
|
Element/Attribut |
Beskrivning |
Typ |
Före- komst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
MessageSender |
Meddelandets sändare, Makulerare |
Class |
1 |
|
|
|
|
- HealthcareAgentInContextId |
Roll för sjukvårdsaktör |
Class |
1 |
|
|
|
|
-- Value |
Roll. Identifierare att det är sändare av meddelandet |
E |
1 |
Char(3) {CNR} |
CNR = Cancellator, Cancellator alltid likställt med den som utför makuleringsbegäran, detta blir då en schema / verksamhetsregel |
|
|
- HealthcareAgent |
Sjukvårdsaktör Person/organisation som sänder meddelandet |
Class |
1 |
|
|
|
|
-- HealthcareAgentId |
Identifikation för sjukvårdsaktör |
Class |
0..1 |
|
Används för närvararande inte för djur. |
2014-10-08: Används för närvarande inte för djur. |
|
--- 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 |
2014-10-08: Används för närvarande inte för djur. |
|
--- 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. |
2014-10-08: Används för närvarande inte för djur. |
|
-- 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) |
För närvarande består förskrivarkoden av upp till 4 siffror. |
2014-10-08: 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 |
Förnamn och efternamn på förskrivare. |
S |
1 |
Char(35) |
|
|
|
---- Qualification |
Förskrivartyp alt Yrkeskvalifikation Kodad form |
E |
1 |
Char(3) {VET} |
VET = Veterinär |
|
|
--- Address |
Adressinformation |
Class |
1 |
|
Adress obligatoriskt för förskrivare. Se nedan vilka fält som är obligatoriska. |
|
|
---- 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. |
2014-10-08: anonymisering av exempel |
|
----- StreetName |
Gatuadress |
S |
1 |
Char(35) |
Ex Gata 1, gatunummer skall anges i Gatuadress. |
2014-10-08: anonymisering av exempel |
|
----- City |
Ort |
S |
1 |
Char(28) |
|
|
|
---Telecommunication |
Telefonnummer |
S |
1 |
Char(13) |
Inklusive riktnummer. Telefonnummer till sändare av meddelande obligatoriskt. |
|
2.1.2.3. SubjectOfCare - Djurägare
|
Element/Attribut |
Beskrivning |
Typ |
Före- komst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
SubjectOfCare |
Djurägare |
Class |
1 |
|
Motsvarar fältet 1.2.2 SubjectOfCare i XML-specifikationen för djur |
|
|
- TypeOfSubjectOfCare |
Patienttyp
|
V |
1 |
|
Indikerar att det handlar om makulering för djur |
|
|
- AnimalCarerMatchingInfo |
Information om djurägare |
Class |
1 |
|
Namn och adress till djurägare. Kan vara professionell djurägare om typ = ORG |
2014-10-08: Förtydligat djurägare och professionell djurägare. |
|
--PersonNameDetails |
Namndetaljer |
Class |
1 |
|
|
|
|
--- StructuredPersonName |
Strukturerat personnamn |
Class |
1 |
|
Djurägarens namn (efternamn och förnamn). |
2014-10-08: Förtydligat att det är djurägarens namn som avses. |
|
---- FamilyName |
Efternamn |
S |
1 |
Char(35) |
Innehåller företagsnamn om typ=ORG. Djurägarens efternamn alternativt företagsnamn för professionell djurägare. |
2014-10-08: Förtydligat att det är djurägarens efternamn alternativt företagsnamn som avses. |
|
---- FirstGivenName |
Förnamn |
S |
0..1 |
Char(35) |
Obligatorisk om typ = PNR eller FDA. Används ej om typ = ORG. |
2014-10-08: Förtydligat att fältet ej används om typ = ORG. |
|
-- CarerId |
Identifiering av djurägare. |
Class |
1 |
|
Någon form av identifikation av djurägare / djurföreträdare är obligatorisk. (Kan vara juridisk person) |
|
|
--- IdScheme |
Kodtyp |
E |
1 |
Char(3)
|
PNR = personnummer FDA = Födelsedatum (dvs utan löp- och kontrollsiffra) ORG = Organisationsnummer, 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 sekelskiftesnummer utan löp- och kontrollnummer. ORG: 10 tecken. |
|
2.1.2.4. CancellationSet - Makuleringssamling
|
Element/Attribut |
Beskrivning |
Typ |
Före- komst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
CancellationSet |
|
Class |
1 |
|
|
|
|
- Cancellation |
|
Class |
1 |
|
|
|
|
--PrescriptionSetId |
Id på förskriven receptsamling som avses att makuleras/delmakuleras, dvs PrescriptionSetId |
S |
1 |
Char(41) |
Idtyp anges i attributet idtype. |
|
|
---idtype |
Typ av id. |
A,E |
1 |
Char(14) {UUID, GUID} |
Exempel : <PrescriptionSetId idtype="GUID"> 0af25f00-387d-11d3-9d31-00a0cc39621a
|
2014-10-08: Exemplet har uppdaterats. |
|
-- PrescriptionItemDetails |
|
Class |
1..99 |
|
Se under rubrik 1.2.4.1 |
|
2.1.2.5. PrescriptionItemDetails
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
PrescriptionItemDetails |
Receptinformation |
Class |
1..99 |
|
Maximalt 99 receptrader, kan makuleras i ett makuleringsmeddelande. |
|
|
- PrescriptionItemId |
ReceptradId |
S |
1 |
Char(4) |
Identifierar en receptrad inom ett recept. Exempel : om det tredje receptet innehåller två typer av förpackningar skrivs dessa som två PrescriptionItemDetailsrader: PrescriptionItemId=3-1. och den andra PrescriptionItemId=3-2 |
|
|
-Item |
Klasselement i vilket attribut för PrescriptionItemId samt attribut för orsakskod och beskrivning definieras. |
Class |
1 |
|
Se under rubrik 1.2.4.1.1 |
|
2.1.2.6. 1.2.4.1.1 Item
|
Element/Attribut |
Beskrivning |
Typ |
Förekomst |
Datatyp/ Value |
Kommentar |
Ändringslogg |
|---|---|---|---|---|---|---|
|
Item |
Klasselement i vilket attribut för PrescriptionItemId samt attribut för orsakskod och beskrivning definieras. |
Class |
1 |
|
|
|
|
-CauseCode |
Makuleringsorsak Enligt specifikation av eHälsomyndigheten, OBS detta orsaksfält är i denna specifikation på PrescriptionItemIDnivå. Orsak 1=01 Orsak 2=02 Orsak 3=03 Orsak 4=04 |
E |
1 |
Int(2) {01,02,03,04} |
Vårdsystem ska använda sig av följande tvingande orsakskoder. 1: Fel djurägare.
Obs, texten i orsakskoderna kan komma att justeras. |
2014-10-08: Apotekens Service har ersatts med eHälsomyndigheten. |
|
-Cause |
Fritextfält för val 4 Annan orsak. Om CauseCode="04" är "Cause" obligatorisk |
S |
0..1 |
Char(80) |
Cause ska endast skickas med vid makuleringsorsak 4 och då är den obligatorisk. |
|
|
-Consent |
Klass för samtycke |
Class |
0..1 |
|
|
|
|
--Value |
Om djurägare t är informerad sätts Value till värdet 1. |
I |
1 |
Int(1) |
Om orsakskod är 2, 3 eller 4 ska value vara satt till värdet 1. Dvs djurägaren måste vara informerad om orsaken till makulering. |
2016-04-17: Förtydligat kommentaren. |
Versionshistorik
|
Datum |
Utgåva |
Författare |
Kommentar |
|---|---|---|---|
|
2012-11-23 |
1.0 |
Monica Rosén |
Nytt dokument. Bygger på dokumentet Specifikation XMLmakulering v 1.0.1 (human). Fastställd version |
|
2014-10-08 |
2.0 |
Monica Rosén |
Specifikationen har bytt namn till "NEF - Specifikation XML-meddelande - makulering av recept Djur" Apotekens Service har ersatts med eHälsomyndigheten i text och logga. Översyn av layout och små textuella justeringar är gjorda. Rubriken Ändringstyper har tagits bort, ändringar beskrivs i historik samt i ändringsloggen. Extensible Markup Language (XML) 1.0 rättat hänvisningen till fourth edition, Koppling mellan XML-scheman och XSD-filer finns från och med nu i dokumentet NEF- Implementationsguide. 1, MessageRoutingAddress, tillämpningar beskrivs under 1.1 1.1, Förtydligat vad som är tillämpligt i makuleringsbegäran. 1.1, GLN tillagt i Sender och SenderQualifier. 1.1, SubSender, rättat, det är sändande system som avses. 1.1, 1.2.1 och 1.2.4, idtype, exemplet har uppdaterats. 1.2.2, Förtydligat att fälten HealthcareAgentId, IdScheme och Value inte används för djur. 1.2.2, Förtydligande av fältet Value, förskrivarkoden består för närvarande av upp till 4 siffror. 1.2.2, NumberOrNameOfHouse och StreetName, anonymisering av exempel 1.2.3, Förtydliganden är gjorda under AnimalCarerMatchingInfo, StructuredPersonName, FamilyName och FirstGivenName. |
| 2016-04-19 | 3.0 | Maria Hassel |
Ny mall. Förtydligande av syfte och målgrupp. Bytt namn från "NEF - Specifikation XML-meddelande - makulering av recept Djur" 1.2.4.1.1, Value, förtydligat kommentar |