Specifikationer för XML-meddelanden - Övergripande struktur
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. Nedanstående information gäller för samtliga typer av XML-meddelanden.
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.1. 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:
Förkortning | Betydelse | Förklaring | Exempel |
---|---|---|---|
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 | 1 = Förskrivning |
I | Integer | Heltal | |
E | Enumerated | Uppräkningsbar typ (alfanumerisk), där tabell skall ange tillåtna värden med förklaringar | VEN |
1.2. 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.3. 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.
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. XML-reserverade tecken
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). XML-reserverade tecken finns listade på sidan Tillåtna tecken i element och attributdata.
CDATA-sektioner tillåts inte.
1.5. Ä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.6. XML-Schema definitioner
XML-specifikationer och kopplingar till respektive XML-schema finns specificerade på sidan NEF - Implementationsguide. XML-specifikationer kan uppdateras separat utan att ett nytt XML-schema tas fram.
2. XML-specifikationer för specifika typer av meddelanden
Nedan följer specifik information för varje typ av meddelande.
- Applikationskvittens - e-recept djur — Följande specifikationer gäller för applikationskvittens för e-recept djur.
- Applikationskvittens makuleringsbegäran djur — Följande specifikationer gäller för "applikationskvittens för makuleringsbegäran djur"
- E-recept djur — Följande specifikationer gäller för e-recept djur.
- Makuleringsbegäran djur — Följande specifikationer gäller för makuleringsbegäran djur
- Routing Adress — Följande specifikationer gäller för Routing Adress
Versionshistorik
Version |
Datum |
Kommentar |
---|---|---|
1.0 | 2021-11-27 | Ny handbok vård- och apotekstjänster |