Hämta loggarkiv. Utgåva PA Hämta loggarkiv. Sida 1 (20) Utskriftsdatum: Baserad på mall revision A

Transkript

1 Inera AB Sida: 1 (20) Hämta loggarkiv Utgåva PA Sida 1 (20)

2 Inera AB Sida: 2 (20) Revisionshistorik Version Revision Datum Komplt beskrivning av ändringar Ändringarna gjorda av Definitiv revision fastställd av PA Första utkast Pär Hansson / Roger Öberg PA Uppdaterad efter kommentarer Pär Hansson PA Uppdaterad Pär Hansson / Roger Öberg PA Uppdaterad Pär Hansson / Roger Öberg PA Uppdaterat namespace i lista arkiv Pär Hansson / Roger Öberg Innehållsförteckning 1 INLEDNING LISTA ARKIV FÖR VÅRDGIVARE HÄMTA LOGGARKIV DATATYPER Sida 2 (20)

3 Inera AB Sida: 3 (20) 1 Inledning 1.1 Om dokument Denna beskrivning är en tillägg av tjänstekontrakten i tjänstedomänen urn:riv:ehr:log (huvuddomän Electronic Health Record underdomän log). Dokument beskriver hur tjänsten Hämta loggarkiv är uppbyggd med hjälp av en REST-service. Val att använda en REST-tjänst iställ för SOAP(som RIV-TA använder) har gjorts då d är en myck lättviktig lösning för att hämta/skicka filer. Att skicka filer via SOAP innebär en förhållandevis tungrodd lösning för en enkel uppgift. Om SOAP används kan man skicka datat som en binär bilaga. Men om tjänsten ska konsumeras av t.n system innebär d att tredjeparts produkter måste användas då varken WSE eller WCF stödjer dta.alternativ hade då varit att skicka datat i payloaden som en Base64-kodad sträng. Men dta innebär ungefär 33% overhead vilk gör d direkt olämpligt att använda i hämta loggarkiv -tjänsten där filerna är stora och många. Tjänsterna för att hämta loggarkiv är av typen HTTP-REST. En REST-service tillåter olika typer av HTTP anrop GET, PUT, POST och DELETE. I hämta loggarkiv -tjänsten är d endast GET som kommer att implementeras, då d bara är hämtning och listning av arkiv som kan utföras. Anrop mot tjänsterna sker med https(tvåvägs-ssl) och validering av certifikat från tjänstekonsument utförs för att endast tillåta att tjänsten levererar data till tillåtna mottagare. Sida 3 (20)

4 Inera AB Sida: 4 (20) 2 Lista arkiv för vårdgivare Lista en vårdgivares arkiv som matchar angiv datumintervall. Tjänsten svarar med en XML-struktur som innehåller de arkiv som matchar paramrarna. Då loggarkiven är statiska filer så kommer dessa kunna innehålla loggposter utanför angiv intervall om filens innehåll går över intervallgränsen. Därför är d av intresse för konsumenten att hålla reda på vilka arkiv som hämtats för att undvika inläsning av dubblter i konsumerande system. Arkiven särskiljs av sitt unika id. Svar om paramrar är giltiga: Statuskod: 200 Content-Type: application/xml Content: xml-struktur som beskriver efterfrågade arkiv Svar vid felaktiga paramrar: Statuskod: 200 Content-Type: application/xml Content: xml-struktur med felkod 2.1 Frivilligh 2.2 Version SLA-krav Kategori Värde Kommentar Svarstid Tillgängligh Last Aktualit 2.4 Fältregler Begäran careproviderid log:hsaid HsaId för vårdgivaren 1..1 fromdate xs:datetime Anger från och med datum för d 1..1 intervall som efterfrågas. todate xs:datetime Anger till datum för d intervall som 1..1 efterfrågas. Observera att datum hanteras exklusivt, dvs inte till och med. Svar listarchivesresponse 1..1 Sida 4 (20) log:download:list ArchivesResponse Rurnerar en samling arkivmadata som matchar förfrågan. Arkivsamlingen kan ha storleken 0 om ing arkiv matchar angivna paramrar.

5 Inera AB Sida: 5 (20) 2.5 Regler 2.6 Tjänsteinteraktion Archives 2.7 Exempel Exempel på anrop Tjänsten anropas genom: Datum från och till anges på format enligt Notera att dessa måste URL-kodas för att skickas via http. Då ser anrop ut enlig nedan. 11T14%3A54%3A42.418%2B02%3A00&toDate= T14%3A54%3A42.418%2B02%3A Exempel på svar Följande XML visar strukturen på svarsmeddeland från tjänsten. <ns1:listarchivesresponse xmlns:ns1="urn:riv:ehr:log:download:1" xmlns:ns2="urn:riv:ehr:log:1"> <ns1:result> <ns1:resultcode>?</ns1:resultcode> <ns1:resulttext>?</ns1:resulttext> </ns1:result> <!-- Array --> <ns1:archivemadata> <ns2:archiveid>?</ns2:archiveid> <ns2:fromdate>?</ns2:fromdate> <ns2:careprovider> <ns2:careproviderid>?</ns2:careproviderid> <ns2:careprovidername>?</ns2:careprovidername> </ns2:careprovider> <ns2:todate>?</ns2:todate> </ns1:archivemadata> </ns1:listarchivesresponse> Sida 5 (20)

6 Inera AB Sida: 6 (20) 3 Hämta loggarkiv Tjänst för att hämta t loggarkiv. Tjänsten måste anropas för varje arkiv-fil som ska hämtas Således måste anrop föregås av anrop till tjänsten lista arkiv (listarchives) för att va vilken resurs som ska hämtas. Konsumentens certifikat verifieras för att inga arkiv som inte tillhör rätt vårdgivare rurneras. Svar om efterfrågat arkiv finns: Statuskod: 200 Content-Type: application/zip Content-Disposition: attachment; filename="<arkivfilnamn>" Content: arkivfil (zippat xmldata enligt Log-schemat) Svar vid ogiligt förfrågan: Statuskod: 200 Content-Type: application/xml Content: xml-struktur med felkod 3.1 Frivilligh 3.2 Version SLA-krav Kategori Värde Kommentar Svarstid Tillgängligh Last Aktualit 3.4 Fältregler Begäran archiveid log:id UUID som unikt refererar en arkivfil 1..1 Svar Zip-fil application/zip (Normalfall) Om arkivfilen finns rurneras denna(zipfil) innehållandes den efterfrågade arkivfilen. Upppackad består zip-filen av Madata.xml och Archive.xml enligt specifikation nedan. garchivesresponse Sida 6 (20) log:download: GArchivesRespo nse (Felfall) Dta svar fås enbart ifall efterfrågat arkiv inte kan levereras (t.ex. om d inte finns eller vid annat fel)

7 Inera AB Sida: 7 (20) 3.5 Regler 3.6 Tjänsteinteraktion Archives 3.7 Exempel Exempel på anrop Tjänsten anropas genom: Exempel på svar I normalfall rurneras en zippad arkivfil med http-rubrikerna Statuskod: 200 Content-Type: application/zip Content-Disposition: attachment; filename="<arkivfilnamn>" Filen har namn <UUID>.zip där UUID är t unikt id för arkiv. Ex 0d8f f b1447e1245c3.zip Arkiv innehåller två filer Madata.xml och Archive.xml. Madata.xml beskriver innehåll i Archive.xml med vårdgivare från och till datum på logposter. Ex: <?xml version='1.0' encoding='utf-8'?> <log:archivemadata xmlns:log="urn:riv:ehr:log:1"> <log:archiveid>4b91870f-52a1-4bab-9d67-19d777c9dd8f</log:archiveid> <log:careprovider> <log:careproviderid>se ab5</log:careproviderid > <log:careprovidername>xll</log:name> </log:careprovider> <log:fromdate> t21:41:48.050z</log:fromdate> <log:tomdate> t21:41:48.050z</log:tomdate> </log:archivemadata> Archive.xml innehåller loggposter enligt loggschemat. Ex: <?xml version='1.0' encoding='utf-8'?> <log:archive xmlns:log="urn:riv:ehr:log:1" version="1.0"> <log:archiveid>4b91870f-52a1-4bab-9d67-19d777c9dd8f</log:archiveid> <!-- Array --> <log:logenvelope xml:id="id "> <log:logsequencenumber>3</log:logsequencenumber> <log:lastdigest>...</log:lastdigest> <!-- Array --> <log:log> <log:logid>4b91870f-52a1-4bab-9d67-14c653c9bb4f</log:logid> <log:system> <log:systemid>se ab5</log:systemid> <log:systemname>samtyckestjänst</log:systemname> </log:system> Sida 7 (20)

8 Inera AB Sida: 8 (20) <log:activity> <log:activitytype>nödöppning</log:activitytype> <log:activitylevel/> <log:activityargs/> <log:startdate> t21:41:48.050z</log:startdate> <log:purpose>vård och behandling</log:purpose> </log:activity> <log:user> <log:userid>se pb5</log:userid> <log:name>helge Nilsson</log:Name> <log:personid/> <log:assignment>se pb5</log:assignment> <log:title/> <log:careprovider> <log:careproviderid>se ab5</log:careproviderid> <log:careprovidername>xll</log:careprovidername> </log:careprovider> <log:careunit> <log:careunitid>se12345-xll-admin</log:careunitid> <log:careunitname>admin</log:careunitname> </log:careunit> </log:user> <log:resources> <!-- Array --> <log:resource> <log:resourcetype>samtycke</log:resourcetype> <log:patient> <log:patientid> </log:patientid> <log:patientname/> </log:patient> <log:careprovider> <log:careproviderid>se ab5</log:careproviderid> <log:careprovidername>xll</log:careprovidername> </log:careprovider> <log:careunit> <log:careunitid>se12345-xll-admin</log:careunitid> <log:careunitname>admin</log:careunitname> </log:careunit> </log:resource> </log:resources> </log:log> <ds:signature xmlns:ds=" <ds:signedinfo> <ds:canonicalizationmhod Algorithm=" <ds:signaturemhod Algorithm=" <ds:reference URI="#ID "> <ds:transforms> <ds:transform Algorithm=" <ds:transform Algorithm=" </ds:transforms> <ds:digestmhod Algorithm=" <ds:digestvalue>...</ds:digestvalue> </ds:reference> </ds:signedinfo> <ds:signaturevalue>...</ds:signaturevalue> <KeyInfo xmlns=" <X509Data> <X509Certificate>... </X509Certificate> Sida 8 (20)

9 Inera AB Sida: 9 (20) </X509Data> </KeyInfo> </ds:signature> </log:logenvelope> </log:archive> Exempel vid felaktigt anrop. Statuskod: 200 Content-Type: application/xml Content: xml-struktur med felkod Följande XML visar strukturen på svarsmeddeland från tjänsten om fel uppstår <ns1:garchivesresponse xmlns:ns1="urn:riv:ehr:log:download:1"> <ns1:result> <ns1:resultcode>?</ns1:resultcode> <ns1:resulttext>?</ns1:resulttext> </ns1:result> </ns1:garchivesresponse> Sida 9 (20)

10 Inera AB Sida: 10 (20) 4 Datatyper Kaptitl beskriver alla datatyper som används av tjänsterna, version Datatyper från namnrymd urn:riv:ehr:log:1 Nedan beskrivs några komplexa datatyper som är deklarerade i den beroende namnrymden urn:riv:ehr:log:1, version 1.0. Dessa datatyper är vanligt förekommande i övriga tjänster senare i kapitl log:activity Datatyp som representerar vilken typ av aktivit som utförts, på vilken nivå, tidpunkt samt syft med aktiviten. activitytype log:activitytype Värde som anger vilken typ av aktivit 1 som utförts. activitylevel log:activitylevel Information om vilken nivå som aktivit 0..1 utförts på. activityargs log:activityargs Övrig information för aktiviten. T.ex paramerar för en rapport. startdate xs:datetime Information om tidpunkt som aktivit 1 utfördes på. purpose log:purposetype Information om syft med aktiviten log:activityargs Datatyp som representerar en. Maxlängd: log:activitylevel Datatyp som representerar en aktivits nivå. Maxlängd: log:activitytype Enumerationsvärde som anger typ av aktivit som utförts. Kan vara Läsa, Skriva, Signera, Utskrift, Vidimera, Radera, Nödöppning Värde "Läsa" "Skriva" "Signera" "Utskrift" "Vidimera" "Radera" "Nödöppning" Beskrivning En läsning av data har utförts. En aktivit där något läggs till. Signering har utförts. En utskrift har utförts. En autentisering har utförts. Något har raderats. Nödöppning har gjorts. Sida 10 (20)

11 Inera AB Sida: 11 (20) log:archive Information om befintliga arkiv. archiveid log:id 1 logenvelope log:logenvelope 1..* log:archivemadata Datatyp som beskriver madata för t arkiv. archiveid log:id Arkivs unika id 1 careprovider log:careprovider Vårdgivare som äger loggposter i arkiv. 1 fromdate xs:datetime Datum på arkivs första loggpost. 1 todate xs:datetime Datum på arkivs sista loggpost log:assignment Datatyp som representerar namn på medarbare i uppdrag. Maxlängd: log:careprovider Datatyp som representerar en vårdgivare. careproviderid log:hsaid Vårdgivarens id. 1 careprovidername log:careprovidern ame Vårdgivarens namn. Värd är ej obligatoriskt log:careprovidername Datatyp som representerar namn på en vårdgivare. Maxlängd: log:careunit Datatyp som representerar en vårdenh. careunitid log:hsaid Vårdenhens id. 1 careunitname log:careunitname Vårdenhens namn. Värd är ej obligatoriskt Sida 11 (20)

12 Inera AB Sida: 12 (20) log:careunitname Datatyp som representerar namn på en vårdenh. Maxlängd: log:hsaid Datatyp som representerar d unika nummer som identifierar en anställd, uppdragstagare, strukturenh eller en HCC funktion (HSA-id). Specificerat enligt HSA-schema tjänsträd version 3.9. Maxlängd: log:id Datatyp som representerar t unikt identifikationsnummer enligt format för UUID (Universally Unique Identifier). Maxlängd: log:log Datatyp som representerar en loggpost enligt PDL. Datatypen beskriver grundformat för en loggpost. logid log:id Unik, global identifierare posten. 1 system log:system Information om system som skapar 1 loggpost. Innehåller systems id samt eventuellt namn. activity log:activity Information om aktivit som utförts och 1 som ska loggas. Innehåller typ av aktivit, datum för aktiviten och i vilk syfte som aktiviten utfördes. user log:user Information om användaren som utfört 1 aktivit. Innehåller användarens id samt till vilken vårdenh användaren tillhör. Kan även innehålla ej obligatoriska uppgifter som namn, personnummer, uppdrag och titel. resources log:resources Information om aktuella resurser log:logenvelope Information om befintliga arkiv. logsequencenumber xs:int 1 lastdigest xs:string 1 log log:log 1..* signature ds:signature 1 Sida 12 (20)

13 Inera AB Sida: 13 (20) log:patient Datatyp som representerar en patient i en resurs. patientid log:personid Patientens id nummer, kan vara personnummer, samordningsnummer alternativt reservnummer. patientname log:patientname Patienten namn. Värd är ej obligatoriskt log:patientname Datatyp som representerar en patients namn. Maxlängd: log:personid Datatyp som representerar t personnummer, samordningsnummer eller t reservnummer. Maxlängd: log:purposetype Enumerationsvärde som anger syfte till aktivit. Kan vara Vård och behandling, Kvalitssäkring, Annan dokumentation enligt lag, Statistik, Administration/tillsyn, Specialuppgift Värde "Vård och behandling" "Kvalitssäkring" "Annan dokumentation enligt lag" "Statistik" "Administration/tillsyn" "Specialuppgift" Beskrivning Aktivitens syfte är vård och behandling Aktivitens syfte är kvalitssäkring Aktivitens syfte är annan dokumentation enligt lag Aktivitens syfte är statistik Aktivitens syfte är administration/tillsyn Aktivitens syfte är av typen specialuppgift log:resource Datatyp som representerar en resurs i loggposten. resourcetype log:resourcetype Information om vilken typ av resurs som loggpost avser. Kan vara kemlabbsvar, journaltext, remiss, översikt, samtycke, patientrelation, sätta spärr, rapport osv. patient log:patient Information om vilken patient som resursen avser. Värd är ej obligatoriskt. careprovider log:careprovider Information om vilken vårdgivare resursen tillhör. Sida 13 (20)

14 Inera AB Sida: 14 (20) careunit log:careunit Information om vilken vårdenh resursen tillhör log:resourcetype Datatyp som representerar en aktivits nivå. Maxlängd: log:resources Information om aktuella resurser. En loggpost kan hålla en eller flera resurser. resource log:resource 1..* log:result Datatyp som rurneras som t generellt svar från alla förändrande tjänster, t.ex. skapa, radera, c. En anropande klient skall alltid kontrollera att resultatkoden inte innehåller fel för att på så sätt va om anrop lyckades. Alla svarskoder förutom OK och INFO byder att åtgärden inte genomfördes. resultcode log:resultcode Anger svarskod för åtgärden. 1 resulttext xs:string Optionellt felmeddelande som innehåller information om fel som uppstod. Fält är tomt om resultatkoden är "OK" log:resultcode Enumerationsvärde som anger de svarskoder som finns. Värde "OK" "INFO" "ERROR" "VALIDATION_ERROR" "ACCESSDENIED" Beskrivning Transaktionen har utförts enligt uppdrag. Transaktionen har utförts enligt begäran, men d finns t meddelande som konsumenten måste visa upp för användaren (om tillämpbart). Exempel på dta kan vara "kom fastande". Transaktionen har INTE kunnat utföras p.g.a t logiskt fel. D finns t meddelande som konsumenten måste visa upp. Exempel på dta kan vara "tiden har bokats av annan patient". En eller flera inparamrar innehåller felaktiga värden. Angiven tjänst utfördes ej. Behörigh saknas för att utföra begärd tjänst. Angiven tjänst utfördes ej log:system Datatyp som representerar t system i loggposten. D system som skapar loggposten. Sida 14 (20)

15 Inera AB Sida: 15 (20) systemid log:hsaid Systems id. 1 systemname log:systemname Systems namn. Värd är ej 0..1 obligatoriskt log:systemname Datatyp som representerar namn på t system. Maxlängd: log:user Datatyp som representerar användaren som utfört aktivit, tillika ägare av loggpost. userid log:hsaid Användarens id. Loggpostens ägare. 1 name log:username Användarens fulla namn. Värd är ej 0..1 obligatoriskt. personid log:personid Användarens id nummer, kan vara 0..1 personnummer, samordningsnummer alternativt reservnummer. Värd är ej obligatoriskt. assignment log:assignment Namn på medarbare i uppdrag, 0..1 exempelvis sjuksköterska på kirurgkliniken. Värd är ej obligatoriskt. title log:usertitle Användarens titel. Värd är ej 0..1 obligatoriskt. careprovider log:careprovider Användarens vårdgivare när aktivit 1 utfördes. Den vårdgivaren är ägare av loggposten. careunit log:careunit Användarens vårdenh när aktivit utfördes log:username Datatyp som representerar namn för en användare. Maxlängd: log:usertitle Datatyp som representerar titel på användare. Maxlängd: Datatyper från namnrymd Nedan beskrivs några komplexa datatyper som är deklarerade i den beroende namnrymden ds, ds:canonicalizationmhod Sida 15 (20)

16 Inera AB Sida: 16 (20) algorithm ds:uri ds:digestmhod algorithm ds:uri ds:digestvalue value xs:string ds:keyinfo x509data ds:x509data 1..* ds:object signatureproperties ds:signaturepropert ies ds:reference uri ds:uri 0..1 id xs:string 0..1 referencetype ds:uri 0..1 transforms ds:transforms 0..1 digestmhod ds:digestmhod 1 digestvalue ds:digestvalue ds:signature id xs:string 0..1 signedinfo ds:signedinfo 1 Sida 16 (20)

17 Inera AB Sida: 17 (20) signaturevalue ds:signaturevalue 1 keyinfo ds:keyinfo 0..1 object ds:object 0..* ds:signaturemhod algorithm ds:uri ds:signatureproperties signatureproperty ds:signaturepropert y 0..* ds:signatureproperty id xs:string 1 targ xs:string 1 timestamp ds:timestamp ds:signaturevalue value xs:string 1 id xs:string ds:signedinfo id xs:string 0..1 canonicalizationmhod ds:canonicalization 1 Mhod reference ds:reference 1..* signaturemhod ds:signaturemho d ds:timestamp Sida 17 (20)

18 Inera AB Sida: 18 (20) date xs:string 1 time xs:string ds:transform algorithm ds:uri ds:transforms transform ds:transform 1..* ds:uri Maxlängd: ds:x509certificate value xs:base64binary ds:x509data x509certificate ds:x509certificate Datatyper från namnrymd urn:riv:ehr:log.download:1 Nedan beskrivs några komplexa datatyper som är deklarerade i aktuell namnrymd urn:riv:ehr:log.download:1, version 1.0. Dessa datatyper är vanligt förekommande i övriga tjänster senare i kapitl log.download:garchivesresponse Rurtyp för tjänsten hämta arkiv Typen ärver Result och används bara då något går fel och ingen arkivfil rurneras. Sida 18 (20)

19 Inera AB Sida: 19 (20) log.download:hsaid Datatyp som representerar d unika nummer som identifierar en anställd, uppdragstagare, strukturenh eller en HCC funktion (HSA-id). Specificerat enligt HSA-schema tjänsträd version 3.9. Maxlängd: log.download:listarchivesresponse Rurtyp för tjänsten lista arkiv archivemadata log:archivemad ata En samling arkivmadata. 0..* log.download:result Datatyp som rurneras som t generellt svar från alla tjänster. En anropande klient skall alltid kontrollera att resultatkoden inte innehåller fel för att på så sätt va om anrop lyckades. Alla svarskoder förutom OK byder att åtgärden inte genomfördes. resultcode log.download:resu Anger svarskod för åtgärden. 1 ltcode resulttext xs:string Optionellt felmeddelande som innehåller information om fel som uppstod. Fält är tomt om resultatkoden är "OK" log.download:resultcode Enumerationsvärde som anger de svarskoder som finns. Värde "OK" "ERROR" "VALIDATION_ERROR" "ACCESSDENIED" Beskrivning Transaktionen har utförts enligt uppdrag. Transaktionen har INTE kunnat utföras p.g.a t logiskt fel.". En eller flera inparamrar innehåller felaktiga värden. Angiven tjänst utfördes ej. Behörigh saknas för att utföra begärd tjänst. Angiven tjänst utfördes ej. Sida 19 (20)

20 Inera AB Sida: 20 (20) Sida 20 (20)