2007-02-08 Slutarkiv Inleveransspecifikation vårdrelaterade system Filnamn: LA_Inleveransspecifikation_Vårdsystem_2.0.doc Ändrat: 8 feb 2007 16:25:00
2 (28) Revisionsdatum Version Beskrivning Författare Godkänd 2007-01-12 2.0.1.1 Strukturförändring av specifikationen för inleveranser. Alla tidigare vårdrelaterade specifikationer har nu slagits samman i denna specifikation. 2007-01-08 2.0.2.1 Vardform är numer ej obligatorisk. Tillåtna leveransformat justerat. Jon Lindhé Jon Lindhé 1 INNLEDNING...3 2 XML SPECIFIKATION...4 2.1 ALLMÄNT...4 2.2 BESKRIVNING AV ELEMENTET <LEVERANSOBJEKT>...5 2.2.1 Beskrivning av et <ObjektLista> i LeveransObjekt...7 2.3 BESKRIVNING AV VARDKONTAKTOBJEKT...8 2.3.1 Beskrivning av VardkontaktObjektSokfalt i VardkontaktObjekt...8 2.4 BESKRIVNING AV LABSVAROBJEKT...10 2.4.1 Beskrivning av LabsvarObjektSokfalt i LabsvarObjekt...10 2.5 BESKRIVNING AV FILMRUTAOBJEKT...12 2.5.1 Beskrivning av FilmrutaObjektSokfalt i FilmrutaObjekt...13 2.6 BESKRIVNING AV PATOLOGOBJEKT...14 2.6.1 Beskrivning av PatologObjektSokfalt i PatologObjekt...14 2.7 BESKRIVNING AV RONTGENBILDOBJEKT...16 2.7.1 Beskrivning av RontgenbildObjektSokfalt i RontgenbildObjekt...16 2.8 BESKRIVNING AV GEMENSAMMA ELEMENT...18 2.8.1 Beskrivning av et SkyddatPersonnummer...18 2.8.2 Beskrivning av et Signatur...18 2.8.3 Beskrivning av et Innehall...19 2.8.4 Beskrivning av et SystemspecifikaSokfalt...22 2.8.5 Beskrivning av et <SokStrang>...23 2.8.6 Beskrivning av et <SokDatum>...23 2.8.7 Beskrivning av et <SokInteger>...23 3 DETALJERAD BESKRIVNING AV ELEMENTET INNEHALL...24 4 PAKETERING AV LEVERANSER...26 4.1 INLEVERANSSTRUKTUR...26 4.1.1 Zip rotnivå...26 4.1.2 bilagor...27 4.1.3 diverse...27 4.1.4 systemfiler...27 4.1.5 xml...27 4.1.6 sip.xml...27 4.2 BESKRIVNING AV SIP.XML...27
3 (28) 1 Innledning Detta dokument innehåller XML-specifikation samt krav som ställs för inleveranser av digital vårdrelaterad information till s slutarkiv. Denna specifikation är framtagen för att kunna hantera olika typer av data från olika typer av system. För att möjliggöra detta så definieras endast de sökkriterier som krävs av slutarkivet för att kunna återsöka information. Leverantören kan sedan specificera strukturen för själva innehållsdata under tagen <Data> eller i en fil som refereras i et <Bilaga>. I den mån möjlighet finns bör någon form av standard följas när informationen är strukturerad. Beskrivningen är avsedd för leverantörer av vårdrelaterade system som på beställning av olika informationsägare behöver överföra information till slutarkivet (t ex i samband med avveckling av ett system). Med vårdrelaterade system avses här Journalsystem, Labsvarsystem, Mikrofilmsystem, Patologregistersystem och Röntgenbildsystem. Kapitel 2 innehåller en detaljerad beskrivning av XML-schemat (la_earkiv_vardsystem_2.0.xsd) som ligger till grund för leveransen. Leverantörerna måste tagga den information som skall tas om hand i e-arkivet i enlighet med denna specifikation. Kapitel 3 beskriver Innehall taggen mer detaljerat Kapitel 4 beskriver paketering av leveransen Som bilagor finns XML-schemat (la_earkiv_vardsystem_2.0.xsd) som skall användas och exempelfiler för vårdrelaterade system. XML-schemat har en versionsidentifikation på formatet 2.0.1 Detta innebär att detta är första versionen av schemat som bygger på version 2.0. Vi har valt att i namnet ange endast 2.0 (la_earkiv_vardsystem_2.0.xsd). Så länge schemat är fullt bakåtkompatibelt med tidigare versioner så kommer endast versionidentifikationen i själva schemat räknas upp medan schema namnet står fast vid 2.0. Motsvarande versionsidentifikation finns för detta dokument, med ett tillägg om version på dokumentet relativt schemat. Exempel: version 2.0.1.1 utgör alltså första utgåvan av dokumentet (2.0.1.1) som baserar sig på schema 2.0.1.
4 (28) 2 XML Specifikation 2.1 Allmänt För att kunna lagra och söka arkiverad information på ett enhetligt sätt har definierat ett XML-format på vilket leveranser av digital information till slutarkivet skall ske. Utöver själva XML-specifikation, som beskriver hur informationen skall struktureras, har definierat ett antal Systemtyper. För vårdrelaterad information gäller följande systemtyper: Journalsystem Labsystem Mikrofilmsystem Patologregistersystem Röntgensystem En post, eller objekt, som ingår i en systemtyp benämns objekttyp, t ex VardkontaktObjekt för Journalsystem, LabsvarObjekt för Labsystem. Varje objekttyp har ett antal sökbegrepp definierade för att möjliggöra utsökning i slutarkivet. Utöver de fördefinierade sökbegreppen finns det möjlighet att definiera Systemspecifika sökbegrepp, som endast gäller för det aktuella systemet. De systemspecifika sökbegreppen används ej av slutarkivet för utsökning, men ger möjlighet att i framtiden användas i ett annat system, t ex för forskningssyften. Observera att det inte går att blanda objekttyper inom en leverans. I beskrivningen av och attribut används ett gemensamt tabellformat med följande rubriker: attribut namn Förklaring till rubriker: : E/A: Kard: Obl: Beskrivning: Användning: Anger det namn som används i schemat för eller attribut. I denna kolumn anges om det beskrivna objektet är ett eller attribut i schemat. Anger objektets kardinalitet, d v s antal förekomster som kan finnas. Anges med ett kryss om objektet är obligatoriskt. Saknas krysset i kolumnen betyder det att objektet är optionellt. Innehåller en beskrivning av objektets typ, datatyp, maxlängd och giltiga värden med mera Anger hur objektet skall användas.
5 (28) Även om de flesta XML parsers klarar teckenset med svenska tecken har dessa undvikits i och eftersom det framkommit viss osäkerhet om alla parsers hanterar dokument med teckenset innehållande svenska tecken. 2.2 Beskrivning av et <LeveransObjekt> Denna bild innehåller en översiktlig beskrivning av de som skall ingå under <LeveransObjekt> i en inleveransfil. LeveransObjekt E 1 x Grundet i XML filen. Innehåller endast. HuvudArkivbildare E 1 x xs:string, maxlängd 64 Skall innehålla namn på arkivbildaren, enl.ö.k med slutarkivet. DelArkivbildare E 0..1 xs:string, maxlängd 64 Skall innehålla namn på ev. delarkivbildaren, enl.ö.k med slutarkivet Arkivbildare3 E 0..1 xs:string, maxlängd 64 Skall innehålla Namn på ev. delarkivbildaren, enl.ö.k med slutarkivet. SystemTyp E 1 x Enumererad lista: Journalsystem Följande värden är giltiga beroende på i leveransen ingående objekt:
6 (28) Labsystem Mikrofilmsystem Patologregistersystem Röntgensystem Journalsystem (för VardkontaktObjekt) Labsystem (för LabsvarObjekt) Mikrofilmsystem (för FilmrutaObjekt) Patologregistersystem (för PatologObjekt) Röntgensystem (för RontgenbildObjekt) SystemNamn E 1 x xs:string, maxlängd 32 Anger namn på systemet som skall arkiveras enl. ö.k. med slutarkivet. Namnet skall unikt identifiera systemet hos slutarkivet. LeveransDatum E 1 x xs:date, yyyy-mm-dd Leveransdatum enl ö.k. med slutarkivet. Tidsperiod E 1 x Nod för FranDatum och TillDatum FranDatum E 1 x xs:date, yyyy-mm-dd Från det datum objektet gäller TillDatum E 1 x xs:date, yyyy-mm-dd Till det datum objektet gäller om tidsperioden sträcker sig över ett dygn LeveransAnteckning E 1 xs:string, maxlängd 256 Kortfattad information om leveransen ObjektLista E 1 x Se detaljbeskrivning nedan.
7 (28) 2.2.1 Beskrivning av et <ObjektLista> i LeveransObjekt Observera att skall väljas utifrån den SystemTyp som har angetts. VardkontaktObjekt E 1.. Innehåller information från Journalsystem. Används när SystemTyp har värdet Journalsystem LabsvarObjekt E 1.. Innehåller information från Labsystem. Används när SystemTyp har värdet Labsystem FilmrutaObjekt E 1.. Innehåller information från Mikrofilmsystem. Används när SystemTyp har värdet Mikrofilmsystem PatologObjekt E 1.. Innehåller information från Patologregistersystem. Används när SystemTyp har värdet Patologregistersystem RontgenbildObjekt E 1.. Innehåller information från Röntgensystem. Används när SystemTyp har värdet Röntgensystem Se Beskrivning av VardkontaktObjekt nedan. Se Beskrivning av LabsvarObjekt nedan. Se Beskrivning av FilmrutaObjekt nedan. Se Beskrivning av PatologObjekt nedan. Se Beskrivning av RontgenbildObjekt nedan.
8 (28) 2.3 Beskrivning av VardkontaktObjekt Elementet VardkontaktObjekt skall användas när SystemTyp är satt till Journalsystem. Förväntat data är från ett journalsystem. ObjektId A 1 x xs:string, maxlängd 32 Attribut ObjektId skall vara en för systemet (se SystemNamn) unik sträng som identifierare för objektet SkyddatPersonnummer E 0..1 Se Beskrivning av gemensamma Signatur E 1 x Se Beskrivning av gemensamma VardkontaktObjektSokfalt E 1 x Se detaljbeskrivning nedan för de olika alternativen Innehall E 1 x Se Beskrivning av gemensamma <ObjektLista> <VardkontaktObjekt ObjektId= vk-111 > </VardkontaktObjekt> <VardkontaktObjekt ObjektId= vk-112 > </VardkontaktObjekt> </ObjektLista> 2.3.1 Beskrivning av VardkontaktObjektSokfalt i VardkontaktObjekt Följande sökbegrepp är definierade för VardkontaktObjekt.
9 (28) VardkontaktSokfalt E 1 x Nod Personnummer E 1 x xs:string, pattern = 12 numeriska tecken Efternamn E 1 x xs:string, maxlängd 128 Fornamn E 1 x xs:string, maxlängd 64 Tidsperiod E 1 x Nod för FranDatum och TillDatum Personnummer eller temporärnummer utan bindestreck FranDatum E 1 x xs:date, yyyy-mm-dd Från det datum objektet gäller TillDatum E 1 xs:date, yyyy-mm-dd Till det datum objektet gäller om tidsperioden sträcker sig över ett dygn Diagnos E 1 x xs:string maxlängd 256 Kort beskrivning av diagnos Ansvarig E 0..1 x xs:string, maxlängd 128 Ansvarig person för objektet Befattning A 0..1 xs:string, maxlängd 64 Den ansvariga personens befattning Vardform E 0..1 xs:string, giltiga värden är Öppen vård eller Sluten vård Om det inte finns någon möjlighet att mappa befintliga värden mot Öppen vård eller Sluten vård skall detta utelämnas SystemspecifikaSokfalt E 1 Se rubrik Beskrivning objektsgemensamma
10 (28) 2.4 Beskrivning av LabsvarObjekt Elementet LabsvarObjekt skall användas när SystemTyp är satt till Labsystem. Förväntat data är från ett labsystem. ObjektId A 1 x xs:string, maxlängd 32 Attribut ObjektId skall vara en för systemet (se SystemNamn) unik sträng som identifierare för objektet SkyddatPersonnummer E 0..1 Se Beskrivning av gemensamma Signatur E 1 x Se Beskrivning av gemensamma LabsvarObjektSokfalt E 1 x Se detaljbeskrivning nedan för de olika alternativen Innehall E 1 x Se Beskrivning av gemensamma <ObjektLista> <LabsvarObjekt ObjektId= ls-111 > </ LabsvarObjekt > < LabsvarObjekt ObjektId= ls-112 > </ LabsvarObjekt Objekt> </ObjektLista> 2.4.1 Beskrivning av LabsvarObjektSokfalt i LabsvarObjekt Följande sökbegrepp är definierade för LabsvarObjekt.
11 (28) LabsvarSokfalt E 1 x Nod Personnummer E 1 x xs:string, pattern = 12 numeriska tecken Efternamn E 1 x xs:string, maxlängd 128 Fornamn E 1 x xs:string, maxlängd 64 Tidsperiod E 1 x Nod för FranDatum och TillDatum Personnummer eller temporärnummer utan bindestreck FranDatum E 1 x xs:date, yyyy-mm-dd Från det datum objektet gäller TillDatum E 1 xs:date, yyyy-mm-dd Till det datum objektet gäller om tidsperioden sträcker sig över mer än ett dygn Provtyp E 1 x xs:string maxlängd 32 Ansvarig E 0..1 x xs:string, maxlängd 128 Ansvarig person för objektet Befattning A 0..1 xs:string, maxlängd 64 Den ansvariga personens befattning Vardform E 0..1 xs:string, giltiga värden är Öppen vård eller Sluten vård Om det inte finns någon möjlighet att mappa befintliga värden mot Öppen vård eller Sluten vård skall detta utelämnas SystemspecifikaSokfalt E 1 Se rubrik Beskrivning objektsgemensamma
12 (28) 2.5 Beskrivning av FilmrutaObjekt Elementet FilmrutaObjekt skall användas när SystemTyp är satt till Mikrofilmsystem. Förväntat data är från ett mikrofilmsystem. ObjektId A 1 x xs:string, maxlängd 32 Attribut ObjektId skall vara en för systemet (se SystemNamn) unik sträng som identifierare för objektet SkyddatPersonnummer E 0..1 Se Beskrivning av gemensamma Signatur E 1 x Se Beskrivning av gemensamma FilmrutaObjektSokfalt E 1 x Se detaljbeskrivning nedan för de olika alternativen Innehall E 1 x Se Beskrivning av gemensamma <ObjektLista> <FilmrutaObjekt ObjektId= fr-111 > </ FilmrutaObjekt > < FilmrutaObjekt ObjektId= fr-112 > </ FilmrutaObjekt > </ObjektLista>
13 (28) 2.5.1 Beskrivning av FilmrutaObjektSokfalt i FilmrutaObjekt Följande sökbegrepp är definierade för FilmrutaObjekt. FilmrutaSokfalt E 1 x Nod Personnummer E 1 x xs:string, längd 12, numeriska tecken Efternamn E 1 x xs:string, maxlängd 128 Fornamn E 1 x xs:string, maxlängd 64 Tidsperiod E 1 x Nod för FranDatum och TillDatum Personnummer eller temporärnummer FranDatum E 1 x xs:date, yyyy-mm-dd Från det datum objektet gäller TillDatum E 1 xs:date, yyyy-mm-dd Till det datum objektet gäller om tidsperioden sträcker sig över ett dygn Diagnos E 1 x xs:string maxlängd 256 Kort beskrivning av diagnos Ansvarig E 0..1 x xs:string, maxlängd 128 Ansvarig person för objektet Befattning A 0..1 xs:string, maxlängd 64 Den ansvariga personens befattning Vardform E 0..1 xs:string, giltiga värden är Öppen vård eller Sluten vård Om det inte finns någon möjlighet att mappa befintliga värden mot Öppen vård eller Sluten vård skall detta utelämnas SystemspecifikaSokfalt E 1 Se rubrik Beskrivning objektsgemensamma
14 (28) 2.6 Beskrivning av PatologObjekt Elementet PatologObjekt skall användas när SystemTyp är satt till Patologregistersystem. Förväntat data är från ett patologregistersystem. ObjektId A 1 x xs:string, maxlängd 32 Attribut ObjektId skall vara en för systemet (se SystemNamn) unik sträng som identifierare för objektet SkyddatPersonnummer E 0..1 Se Beskrivning av gemensamma Signatur E 1 x Se Beskrivning av gemensamma PatologObjektSokfalt E 1 x Se detaljbeskrivning nedan för de olika alternativen Innehall E 1 x Se Beskrivning av gemensamma <ObjektLista> <PatologObjekt ObjektId= pl-111 > </ PatologObjekt > < PatologObjekt ObjektId= pl-112 > </ PatologObjekt Objekt> </ObjektLista> 2.6.1 Beskrivning av PatologObjektSokfalt i PatologObjekt Följande sökbegrepp är definierade för PatologObjekt.
15 (28) PatologSokfalt E 1 x Nod Personnummer E 1 x xs:string, längd 12, numeriska tecken Efternamn E 1 x xs:string, maxlängd 128 Fornamn E 1 x xs:string, maxlängd 64 Tidsperiod E 1 x Nod för FranDatum och TillDatum FranDatum E 1 x Från det datum objektet gäller xs:date, yyyy-mm-dd TillDatum E 1 Till det datum objektet gäller xs:date, yyyy-mm-dd Preparatnummer E 1 x Personnummer eller temporärnummer SystemspecifikaSokfalt E 1 Se rubrik Beskrivning objektsgemensamma
16 (28) 2.7 Beskrivning av RontgenbildObjekt Elementet RontgenbildObjekt skall användas när SystemTyp är satt till Röntgensystem. Förväntat data är från ett journalsystem. ObjektId A 1 x xs:string, maxlängd 32 Attribut ObjektId skall vara en för systemet (se SystemNamn) unik sträng som identifierare för objektet SkyddatPersonnummer E 0..1 Se Beskrivning av gemensamma Signatur E 1 x Se Beskrivning av gemensamma RontgenbildObjektSokfalt E 1 x Se detaljbeskrivning nedan för de olika alternativen Innehall E 1 x Se Beskrivning av gemensamma <ObjektLista> <RontgenbildObjekt ObjektId= rb-111 > </RontgenbildObjekt> <RontgenbildObjekt ObjektId= rb-112 > </RontgenbildObjekt> </ObjektLista> 2.7.1 Beskrivning av RontgenbildObjektSokfalt i RontgenbildObjekt Följande sökbegrepp är definierade för RontgenbildObjekt.
17 (28) RontgenbildSokfalt E 1 x Nod Personnummer E 1 x xs:string, längd 12, numeriska tecken Efternamn E 1 x xs:string, maxlängd 128 Fornamn E 1 x xs:string, maxlängd 64 Tidsperiod E 1 x Nod för FranDatum och TillDatum Personnummer eller temporärnummer FranDatum E 1 x xs:date, yyyy-mm-dd Från det datum objektet gäller TillDatum E 1 xs:date, yyyy-mm-dd Till det datum objektet gäller om tidsperioden sträcker sig över ett dygn Diagnos E 1 x xs:string maxlängd 256 Kort beskrivning av diagnos Ansvarig E 0..1 x xs:string, maxlängd 128 Ansvarig person för objektet Befattning A 0..1 xs:string, maxlängd 64 Den ansvariga personens befattning Vardform E 0..1 xs:string, giltiga värden är Öppen vård eller Sluten vård Om det inte finns någon möjlighet att mappa befintliga värden mot Öppen vård eller Sluten vård skall detta utelämnas SystemspecifikaSokfalt E 1 Se rubrik Beskrivning objektsgemensamma
18 (28) 2.8 Beskrivning av gemensamma Nedan beskrivs de definitioner som är gemensamma för de vårdrelaterade objekten 2.8.1 Beskrivning av et SkyddatPersonnummer Om personnumret ej är skyddat enligt nivå 1 eller 2 kan detta utelämnas SkyddatPersonnummer E 1 Används för att markera om personnumret är skyddat, se vidare attribut Status. Om et ej är angivet så kommer slutarkivet hantera personnumret som ej skyddat Status A 1 x xs:int, 0 eller 1 Är personnumret skyddat enligt nivå 1 eller 2 skall värdet sättas till 1 Värdet 0 anger att personnumret ej är skyddat <SkyddatPersonnummer Status= 1 /> 2.8.2 Beskrivning av et Signatur Elementet signatur är obligatoriskt och skall alltid finnas angivet. Signatur E 1 x xs:string Om attributet Signerad är satt till 1 skall detta innehålla signaturvärdet. Om attributet Signerad är satt till 0 skall detta vara tomt
19 (28) Signerad A 1 x xs:int, 0 eller 1 Finns en signatur skall värdet sättas till 1 och et Signatur skall innehålla värdet. Om det ej finns en signatur skall värdet sättas till 0 och et Signatur skall vara tomt. <Signatur Signerad= 1 >signaturvärde</signatur> 2.8.3 Beskrivning av et Innehall Objektets innehåll kan realiseras på två olika sätt. Antingen kan data läggas in i et <Data> eller så kan data läggas i en separat fil som man refererar till via et <Bilaga>. Genom detta förfarande kan man hantera både stora och små mängder data som skall hanteras som innehåll. Möjlighet finns också att relatera objekt inom samma leverans med hjälp av et <Lank>. Data E 1 x Se detaljbeskrivning nedan. Bilaga E 0..* Se detaljbeskrivning nedan. Lank E 0..* Se detaljbeskrivning nedan. 2.8.3.1 Beskrivning av et Data I detta finns objektets innehåll placerat. Elementet tillåter endast textbaserad information av typen XML. Informationen skall placeras inom CDATA taggar, se exempel nedan: <Data><![CDATA[<JournalData>Innshåll..</JournalData>]]</Data>
20 (28) Mer information gällande <Data> och <Bilaga> finns i kapitel 3, Detaljerad beskrivning av et Innehall. Data E 1 x xs:any Information som XML inom CDATA taggar. Bör i möjligaste mån följa en befintlig standard om sådan existerar eller är applicerbar formatversion A 1 xs:string Används för att beskriva vilken version av format som ändvänds, t ex XML 1.0 mediatype A 1 xs:token Se tabell nedan för giltiga värden charset A 1 xs:token Se tabell nedan för giltiga värden size A 1 xs:int Anges som antal bytes Definierade mediatyper (MIME): Mediatyper text/xml Definierade teckenkoder (charset): Teckenkoder US-ASCII UTF-8 UTF-16 ISO-10646-UCS-2 ISO-10646-UCS-4 ISO-8859-1 ISO-8859-2 2.8.3.2 Beskrivning av et Bilaga
21 (28) I de fall där en binärfil skall arkiveras, eller för den delen textbaserad information som ej hanteras under Data et, så skall Bilaga et användas. Detta skall relativt peka ut bilagan som måste ingå i leveransen enligt den leveransstruktur som beskrivs i kapitel 4. Mer information gällande <Data> och <Bilaga> finns i kapitel 3, Detaljerad beskrivning av et Innehall. Ex: <Bilaga formatversion= PDF/A meditatype= application/pdf >..\bilagor\bilaga_113.pdf</bilaga> formatversion A 1 xs:string Används för att beskriva vilken version av format som ändvänds, t ex XML 1.0, PDF/A mediatype A 1 xs:string Se tabell nedan för giltiga värden charset A 1 xs:string Se tabell nedan för giltiga värden size A 1 xs:int Anges som antal bytes Definierade mediatyper (MIME): Mediatyper text/plain text/xml application/pdf audio/mp3 image/tiff video/mpeg Definierade teckenkoder (charset): Teckenkoder US-ASCII UTF-8 UTF-16 ISO-10646-UCS-2 ISO-10646-UCS-4 ISO-8859-1 ISO-8859-2
22 (28) 2.8.3.3 Beskrivning av et Lank Lank et används för att relatera aktuellt objekt med andra objekt inom samma leverans. ObjektId A 1 x xs:string, maxlängd 32 Värdet anger objektid för ett annat objekt som ingår i leveransen 2.8.4 Beskrivning av et SystemspecifikaSokfalt SystemspecifikaSokfalt ger möjlighet att specificera sökbegrepp som ej är definierade av slutarkivet. Viktigt att poängtera är att dessa sökbegrepp ej används av slutarkivets personal vid utsökning. Beroende på datatypen kan antingen et <SokStrang>, <SokDatum> eller <SokInteger> användas för att definiera egna sökbegrepp. SokStrang E 0.. Se detaljbeskrivning nedan. SokDatum E 0.. Se detaljbeskrivning nedan. SokInteger E 0.. Se detaljbeskrivning nedan.
23 (28) 2.8.5 Beskrivning av et <SokStrang> SokStrang E 0.. xs:string, maxlängd 2000 Sökbegreppets värde Namn A 1 x xs:string Namn på det aktuella sökbegreppet <SokStrang Namn = Ort >Stockholm</SokStrang> 2.8.6 Beskrivning av et <SokDatum> SokDatum E 0.. xs:date, yyyy-mm-dd Sökbegreppets värde Namn A 1 x xs:string Namn på det aktuella sökbegreppet < SokDatum Namn = Avgångsdag >2005-02-12</SokDatum> 2.8.7 Beskrivning av et <SokInteger> SokInteger E 0.. xs:int Sökbegreppets värde Namn A 1 x xs:string Namn på det aktuella sökbegreppet <SokInteger Namn = Antal >1</SokInteger>
24 (28) 3 Detaljerad beskrivning av et Innehall s slutarkiv är till för att bevara data under längre tidsperioder och måste därför tillse att data är läsbart även efter många år. För att kunna uppnå detta är det av största vikt att de format som används i slutarkivet är beständiga över lång tid. Slutarkivet har valt ett antal digitala format som anses beständiga över längre tid. Leverantören skall i första hand leverera data i något av dessa format där så är möjligt. Följande mime-typer är definierade i XML-schemat. Om annat format än XML för data av elektroniskt ursprung och PDF eller TIFF för data vars ursprung är papper används måste detta överenskommas med slutarkivets förvaltning. Format XML HTML Text PDF TIFF MP3 MPEG 2/4 Andra format Kommentar XML är det format som förväntas för allt data som har ett elektroniskt ursprung. Om det är möjligt skall alltid innehållet levereras i detta format. I dagsläget finns det ej något krav om schema eller stylesheet till levererat XML data, men XML datat bör valideras mot ett schema innan leverans till slutarkivet. (Validator kan skrivas för Hjälpapplikationen för att hantera detta i framtiden) Det är en stor fördel om strukturen följer någon form av standard. Den HTML som produceras skall helst följa XHTML 1.0, men undantag kan göras för HTML 4.01 Detta format används normalt inte. Får bara användas efter särskild överenskommelse med slutarkivets förvaltning. Portable Document Format från Adobe kan utgöra leveransformat. PDF-fil som levereras skall vara kompatibel med PDF/A-1 (ISO 19005-1:2005) Används för bilddata, arbete pågår om krav på version och komprimeringsgrader. Används för ljudupptagningar, arbete pågår om krav på version och komprimeringsgrader. Används för filmupptagningar, arbete pågår om krav på version och komprimeringsgrader. Det är tänkbart att leverera innehållsinformation i andra format. Om t.ex. DICOM används i ursprungsdokumentet kan detta troligtvis levereras i sin ursprungliga form. All leverans av andra format än i tabellen nämnda skall avtalas. Information kan levereras på två olika sätt, direkt i XML-dokumentet (inleveransfilen) eller utanför med en tillhörande referens (bilaga).
25 (28) Om informationen levereras i inleveransfilen skall detta vara XML och läggas inom CDATA direktiv under et <Data>. Markera alltid även vilken typ av information som avses genom att ange rätt MIME typ och vilket teckenset som ändvänds (charset). Är formatet av annan typ än XML, eller xml informationen är omfattande skall informationen levereras som fil. I inleveransfilen används sedan et <Bilaga> för att referera filen. Även här skall MIME typ och charset anges och om möjligt formatversion (arbete pågår om giltiga värden för detta). Se kapitel 4 för hur data skall levereras. I vissa fall där presentationen är av stor vikt och ursprungsformatet t ex är HTML så kan det vara värt att överväga att rendera dokumentet som PDF/A. Detta för att kunna försäkra att informationen kan presenteras även efter lång tid.
26 (28) 4 Paketering av leveranser Leveransen skall paketeras i en eller flera zip filer enligt strukturen beskriven i detta kapitel. I varje zip-fil skall det ingå en xml-fil med namnet sip.xml som beskriver leveransen mer i detalj. En beskrivning av sip.xml finns längre ner i detta kapitel. Filnamn för zip-filer skall vara av formatet: [mottagare]_[systemnamn]_[systemtyp]_filnummer.zip Mottagare, systemnamn och systemtyp hämtas från en <mottagare>, <systemnamn> och <systemtyp> i sip.xml. Om värdet i systemnamn innehåller mellanslag eller andra tecken som ej är giltiga enligt denna specifikation (se Tillåtna tecken nedan) skall dessa tecken ej anges i filnamnet, eller i fallet med å ä ö ersättas med a och o. Exempel för fil nummer 2 av flera: slutarkiv_stgoransjournalsystem_journalsystem_2.zip ZIP-filerna skall inte överstiga 50 MB per styck. Om enstaka externa filer (t ex bildfiler) är av den storlek att de inte går att leverera i en enda zip-fil som understiger 50 MB måste kontakt tas med Ankomstkontrollen. Tillåtna tecken För samtliga filer som nämns i detta kapitel gäller att endast följande tecken är tillåtna: a-z, A-Z, 1-9, - och _ Några andra tecken får ej användas. Svenska tecken som å, ä och ö ersätts med a och o. Observera att namnsättningen är case sensitive, d v s namnsättning av mappar, XMLfiler, Systemfiler och andra filer som ingår i leveransen måste överensstämma vad gäller användandet av versaler och gemener. 4.1 Inleveransstruktur Nedan beskrivs zip-filens struktur. Zip rotnivå bilagor diverse systemfiler xml sip.xml 4.1.1 Zip rotnivå Zip-filens rotnivå innehåller fyra mappar och en xml fil.
27 (28) 4.1.2 bilagor bilaga innehåller 0 till flera filer I de fall separata filer (t ex bildfiler) skall bifogas ett objekt, skall et <Bilaga> i inleveransfilen användas för att peka ut bilagans filnamn. Om leveransen delas upp i flera zip-filer får inte filer med olika innehåll ha samma namn, även om de ligger i olika zipfiler som tillhör samma leverans. 4.1.3 diverse Mappen diverse nyttjas ej av slutarkivet i dagsläget. Skall dock ingå i strukturen. 4.1.4 systemfiler Mappen systemfiler nyttjas ej av slutarkivet i dagsläget. Skall dock ingå i strukturen. 4.1.5 xml xml innehåller en till flera inleveransfiler som följer schemat beskrivet i denna specifikation. Namngivning för inleveransfiler är följande: [filprefix]_[index].xml Värde för filprefix finns angivet som attribut på et <inleveransfiler> i sip.xml. Finns det endast en inleveransfil i aktuell zip så sätts index till 1, finns det flera inleveransfiler så stegas index upp för varje fil: st_goran_1.xml st_goran_2.xml 4.1.6 sip.xml sip.xml innehåller information om leveransen. Se Beskrivning av sip.xml nedan för mer information. 4.2 Beskrivning av sip.xml Strukturen i sip.xml har till uppgift att på ett överskådligt sätt identifiera vad som finns i leveransen, samt att göra initiala valideringar mot att informationen i sip-filen verkligen finns med i leveransen. <sip> <mottagare namn="slutarkiv"/> <kontakt adress= addess@address.se /> <skapare namn="hjälpapp 2.0" datum="2006-10-25"/> <leverans> <systemtyp typ= Journalsystem /> <systemnamn namn= S:t Görans Journalsystem /> <leveranssekvens nr="1" av= 3 /> <leveransversion nr="1"/> <inleveransfiler antal="3" filprefix="st_goran"/>
28 (28) <bilagor antal= 1500 /> </leverans> </sip> Följande tabell beskriver vilken funktion varje /attribut har: sip E 1 Rot för sip.xml mottagare@namn A 1 xs:string Skall vara satt till slutarkiv kontakt@adress A 1 xs:string Kontaktinformation för ansvarig avsändare skapare@namn A 1 xs:string Vilken applikation som använts för att skapa leveransen skapare@datum A 1 xs:date Tidpunkt för skapandet av leveransen leverans E 1 Nod systemtyp@typ A 1 xs:string Används endast vid leverans till slutarkivet, skall vara samma värde som är satt i inleveransfilens <SystemTyp> systemnamn@namn A 1 xs:string Namn på systemet, skall vara samma värde som är satt i inleveransfilens <SystemNamn> leveranssekvens@nr A 1 x xs:int Den aktuella zip-filens (där denna sip.xml ingår) index. leveranssekvens@av A 1 x xs:int Det totala antalet zip-filer som ingår i aktuell leverans. leveransversion@nr A 1 x xs:int Version av leveransen. I vissa fall kan det krävas flera försök för att skapa en leverans, och varje försök är en unik version. inleveransfiler@antal A 1 x xs:int Det antal inleveransfiler som ingår i aktuell zip-fil (placerade i mappen xml). inleveransfiler@filprefix A 1 x xs:string Den del av filnamnet som är gemensamt för samtliga inleveransfiler i leveransen. bilagor@antal A 1 x xs:int Antalet bilagor som ingår i aktuell zip-fil. Dessa skall finnas i mappen bilagor.