LabPortalen Services 2.11

Transkript

1 LabPortalen Services 2.11 LabPortalen 2.11 har tjänster för integrerade journalsystem. Vem kan nyttja tjänsterna? Ett integrerat journalsystem kan programmeras att nyttja valda delar av dessa tjänster. För att kunna nyttja tjänsterna krävs att InfoSolutions godkänner ditt system och därmed lägger till en accesspunkt i LabPortalen för er integrering. Accesspunkten innehåller uppgifter om integrationen och en gemensam nyckel som identifierar ert anrop, och som särskiljer det från andra integrerade system. När ett nytt journalsystem vill integrera tjänsterna med LabPortalen tilldelas journalsystemet en GUID av InfoSolutions. Det är systemet/leverantören som tilldelas denna GUID, och inte varje installation. Denna GUID används för att se vilket system/leverantör som anropas tjänsten, och för att koppla nya kunder till rätt debiteringsmodell. Detta fält kallas nedan för SYSTEMID

2 Tillgängliga tjänster: 1. Skapa ny vårdorganisation i LabPortalen 2. Redigera/Spara vårdorganisation 3. Skapa ny användare 4. Redigera/Spara användare 5. Ta bort användare 6. Återta användare 7. Hämta lista av rapporter för en patient 8. Hämta lista på olästa/osignerade svar/remisser/konsultationsremisser en användare har 9. Hämta lista av rapporter för en användare 10. Hämta patientöversikt i form av pdf 11. Hämta svarsfiler (xml) för en mottagning för angiven tidperiod 12. Hämta notis InfoSolutions förutsätter att journalsystemet kontrollerar vem som får rättigheter att anropa funktionerna. LabPortalen Services gör rättighetskontroll genom att kontrollera att integrationsnyckeln är giltig (SYSTEMID) och vidare att organisationer som berörs tillhör integrationsleverantören och att användare tillhör någon av dessa organisationer.

3 Service: anrop av funktioner Varje funktion tar ett anropsobjekt och ett antal parametrar. Parametrarna kan vara objekt i sig som i fallet organisation och användare. Funktionerna returnerar ett svarsobjekt. Här följer definitioner av de olika objektstyperna: Anropsobjekt Egenskaper Typ Max Längd Obligatorisk Beskrivning SYSTEMID Sträng 36 Ett ID som identifierar system/leverantör. ORGID Sträng 36 En GUID som identifierar organisationen. USERID Sträng 36 - för användarfunktioner annars Nej En GUID som identifierar användaren. Organisationsobjekt Egenskaper Typ Max Obligatorisk vid Beskrivning längd skapande* Namn Sträng 45 Adress Sträng 45 Postnummer Sträng 5 Postadress Sträng 25 Telefon Sträng 25 Fax Sträng 25 Nej Organisationsnummer Sträng 10 * För att uppdatera organisation behöver bara det/de argument som ska uppdateras skickas med

4 Användarobjekt Egenskaper Typ Max Obligatorisk vid Beskrivning längd skapande* Namn Sträng 45 Inloggningsnamn Sträng 20 Lösenord Sträng 20 Mobiltelefon/SMS Sträng 20 Telefon Sträng 20 e-post adress Sträng 45 Får signera för Sant/ avdelning falskt Får signera för Sant/ organisation falskt Får beställa via Sant/ eremiss falskt Användartyp Positivt heltal 0= vanlig användare 1= extern användare Användarroll Positivt heltal 0= inaktiv användare 1= vanlig användare 2= superanvändare 3= funktionsansvarig * För att uppdatera användare behöver bara det/de argument som ska uppdateras skickas med Svarsobjekt Success Sant/ Anger om anropet av funktionen lyckades falskt ReturnValue Sträng Vid lyckat anrop returneras ett värde från funktionen t ex idnumret på en organisation vid skapande eller uppdaterad. Ej genomförd funktion returnera namnet på anropad funktion och felmeddelande

5 Service: skapa ny organisation Denna funktion skapar en ny organisation. Funktionen kontrollerar att det inte finns en organisation med samma organisationsid som är satt i anropsobjektets egenskap ORGID. createorganisation Anropsparameter Anropsobjekt Ett objekt som identifierar Organisationsparameter Organisationsobjekt Ett objekt som innehåller information om organisationen som ska skapas Funktionen returnerar ett svarsobjekt där godkänt skapande av organisationen returnerar sant för egenskapen Success. Organisationen skapas med en debiteringsmodell som är förkonfigurerad av InfoSolutions. Misslyckas skapandet av organisation returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

6 Service: a ndra organisation Denna funktion ändrar valfria fält i en organisation. Endast de egenskaper som anges i organisationsobjektet kommer medföra att fälten ändras. Övriga fält påverkas inte. updateorganisation Anropsparameter Anropsobjekt Ett objekt som identifierar Organisationsparameter Organisationsobjekt Ett objekt som innehåller information om organisationen som ska ändras Funktionen returnerar ett svarsobjekt där en godkänd ändring av organisationen returnerar sant för egenskapen Success. Misslyckas ändringen av organisationen returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

7 Service: skapa anva ndare Denna funktion skapar en användare med idet angivet i anropsobjektet (USERID) under organisationen angiven i anropsobjektet (ORGID). Funktionen kontrollerar att inte Användaridet eller användarnamnet redan finns. createuser Anropsparameter Anropsobjekt Ett objekt som identifierar Användarparameter Användarobjekt Ett objekt som innehåller information om användaren som ska skapas Funktionen returnerar ett svarsobjekt där godkänt skapande av användaren returnerar sant för egenskapen Success. Misslyckas skapandet av användaren returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

8 Service: a ndra anva ndare Denna funktion ändrar en användare med idet angivet i anropsobjektet (USERID). Funktionen kontrollerar att användare tillhör organisationen angiven i anropsobjektet (ORGID). Endast de egenskaper som satts i användarobjektet i anropet kommer att medföra att fält ändras. Övriga fält påverkas inte. updateuser Anropsparameter Anropsobjekt Ett objekt som identifierar Användarparameter Användarobjekt Ett objekt som innehåller information om användaren som ska ändras Funktionen returnerar ett svarsobjekt där godkänt skapande av användaren returnerar sant för egenskapen Success. Misslyckas skapandet av användaren returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

9 Service: radera anva ndare Denna funktion raderar användare med idet angivet i anropsobjektet (USERID). Användaren raderas inte från LabPortalen, utan inaktiveras. Alla poster som tillhör användaren ligger kvar på användaren, men kan nås av andra användare inom samma organisation. Funktionen låter posterna ligga kvar på användare MEN säkerställer att användarens inställningar säger att alla inom organisationen får läsa dess poster. Beställarkoder som ägs av användaren läggs upp till den organisation som användaren tillhör. deleteuser Anropsparameter Anropsobjekt Ett objekt som identifierar Användarparameter Användarobjekt Ett objekt som innehåller information om användaren som ska ändras Funktionen returnerar ett svarsobjekt där godkänt raderande av användaren returnerar sant för egenskapen Success. Misslyckas raderande av användaren returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

10 Service: a terskapa anva ndare Denna funktion återskapar användaren med idet angivet i anropsobjektet (USERID) förutsatt att användaren har raderats Funktionen aktiverar användaren men flyttar inte tillbaks beställarkoderna som flyttats till organisationen. undeleteuser Anropsparameter Anropsobjekt Ett objekt som identifierar Användarparameter Användarobjekt Ett objekt som innehåller information om användaren som ska ändras Funktionen returnerar ett svarsobjekt där godkänt återskapande av användaren returnerar sant för egenskapen Success. Misslyckas återskapandet av användaren returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

11 Service: ha mta lista av rapporter fo r en patient. Frågan ställs för att få en lista av rapporter på en patient i system. Med denna information kan det integrerade journalsystemet skapa en sida med alla önskade rapporter och skapa en utskrift av dem. GetReportsByPatient Anropsparameter Anropsobjekt Ett objekt som identifierar Patientnummer Sträng Patientens nummer som vi vill veta vilka rapporter det finns. Från och med datum Datum ja Från och med datum Till och med datum Datum ja Till och med datum Funktionen returnerar ett objekt av typen rapportlistsvar RapportlistSvarsobjekt Funktionens svar Svarsobjekt Anger om anropet av funktionen lyckades och ett returvärd Rapportlista Rapportlistaobjekt En lista med rapportobjekt där godkänt hämtande av listan returnerar sant för egenskapen Success i svarsobjektet Resultat returneras i listform i rapportlisteobjektet Rapportlisteobjekt Antal rapporter Positivt heltal Anger hur många rapporter som ingår i listan Lista med rapporter Lista med rapportobjekt Aktuella rapporter returneras i en lista

12 Rapportobjekt Rapportid Sträng Rapportens id Patientnummer Sträng Patientens nummer Rapportens Tidpunkt Sträng Tidpunkten för rapporten Patologisk Boolean True/False anger om något svar i rapporten har avvikande svar enligt rapporterande labb. Misslyckas hämtandet av rapporter returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

13 Service: ha mta hur ma nga ola sta eller osignerade rapporter en anva ndare har Funktionen anropas för att kunna visa upp informationen i system, för att i sin tur ge användaren direkt information om att det finns nya olästa rapporter, och för vilka patienter. getunreadunsignedreportsbyuser Anropsparameter Anropsobjekt Ett objekt som identifierar Ägare Postivt heltal 1= Personliga poster 2= Avdelningens poster 3= Organisationens poster PostTyp Postivt heltal 1= Svar (inkl Konsultationsremisssvar) 2= Remisser 3= Konsultationsremisser PostStatus Postivt heltal 1= helt och delvis Olästa poster 2= helt och delvis Osignerade poster (i fallet PostTyp=3 ej besvarade) Funktionen returnerar ett objekt av typen patientlistasvar PatientlistaSvarsobjekt Funktionens svar Svarsobjekt Anger om anropet av funktionen lyckades och ett returvärd Patientlista Patientetlistaobjekt En lista med patientobjekt där godkänt hämtande av listan returnerar sant för egenskapen Success i svarsobjektet Resultat returneras i form av ett patientlisteobjektet Patientlisteobjekt Antal patienter Positivt Anger hur många patienter som ingår i listan

14 Lista med patienter heltal Lista med patientobjekt ja De aktuella patienterna returneras i en lista Patientobjekt Patientnummer Sträng Patientens nummer Patientid Sträng Patientens id Namn Sträng Patientens namn Rapportlista Rapportlistaobjekt En lista med rapportobjekt - se tidigare defintion Misslyckas hämtande listan av användaren returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue.

15 Service: ha mta alla rapporter en anva ndare har Funktionen anropas för att kunna visa upp informationen i system, för att i sin tur ge användaren direkt information om alla dess rapporter getreportsbyuser Anropsparameter Anropsobjekt Ett objekt som identifierar Funktionen returnerar ett objekt av typen patientlistasvar (se tidigare definition)

16 Service: Ha mta patiento versikt i form av pdf Funktionen anropas för att tillgång till patientens översikt i form av pdf i system, för att i sin tur systemet möjlighet att skriva ut eller bifoga denna getpatientsummarypdf Anropsparameter PDFanropsobjekt Ett objekt som identifierar PDFAnropsobjekt Egenskaper Typ Obligatorisk Beskrivning Anrop Anropsobjekt Ett vanligt anropsobjekt som identifierar Patientnummer Sträng Patientens nummer vars patientöversikt efterfrågas Från och med Datum Från och med datum datum Till och med datum Datum Till och med datum Supportanrop Sant/ falskt Bestämmer om begäran loggas som support Extra Sträng Nej För framtida användning Antal bytes Positivt, referens till retur Antal bytes i strömmen heltal PDF-ström Ström, referens till ström PDF-strömmen Funktionen returnerar ett objekt av typen PatientSammanfattningsPDFsvarObjekt PatientSammanfattningsPDFsvarsobjekt Funktionens svar Svarsobjekt Anger om anropet av funktionen lyckades och ett returvärd Antal bytes Positivt Antal bytes i strömmen heltal PDF-ström Ström PDF-strömmen

17 Service: Ha mta svarsfiler (xml) fo r en mottagning fo r angiven tidperiod Funktionen anropas för att få svaren i xmlformat vilket ger möjligheten att hämta s k kvalitetsparametrar. OBS endast signerade svar erhålls för organisation under begärd tidsperiod getxmllistfororganisation Anropsparameter Anropsobjekt Ett objekt som identifierar system/organisation (mottagning) Från och med datum Datum Från och med datum Till och med datum Datum Till och med datum Funktionen returnerar ett objekt av typen patientlistasvar XMLListaSvarsobjekt Funktionens svar Svarsobjekt Anger om anropet av funktionen lyckades och ett returvärd XMLlista XMLlistaobjekt En lista med XMLobjekt där godkänt hämtande av listan returnerar sant för egenskapen Success i svarsobjektet Resultat returneras i form av ett patientlisteobjektet XMLlisteobjekt Antal XMLer Positivt Anger hur många XMLobjekt som ingår i listan heltal Lista med XMLer Lista med XMLer ja De aktuella XMLobjekten returneras i en lista XMLobjekt Referens Sträng Svarsreferens XML Sträng SvarsXML

18 Misslyckas hämtande listan med XMLer returnerar funktionen orsaken till felet i svarsobjektets egenskap ReturnValue. Ha mta notiser GetNotis Anropsparameter Anropsobjekt Ett objekt som identifierar GetRead Boolean True= hämtar även alla notiser som är markerade som lästa och olästa False= hämtar bara de notiser som är markerade som lästa. Funktionen returnerar ett objekt av typen NotisObject NotisObject Patientnummer Sträng Patientens nummer vars patientöversikt efterfrågas Organisation Integer Organisationens ID i LabPortalen/eRemiss Datum DatumTid YYYYMMDDmmhhss. Aktuellt datum då notisen skapades Typ Integer 1=Ny remiss är skapad 2=Inkommen konsultationsremiss 3=Lokala prover är inskrivna Text Sträng Meddelandets text. Texten kan visas upp i journal, alternativt används Typ för att avgöra vad för notis som inkommit och välja egen text. RapportID Sträng ID för aktuell remiss/svar

19 Signera rapporter Med denna funktion kan integrerade journalsystem själva skapa en lista över de rapporter en användare tittat på och uppdatera dessa rapporter som signerade. SignReport Anropsparameter Anropsobjekt Ett objekt som identifierar Rapportlista Lista ID-nummer på rapporten. Funktionen returnerar en lista av av typen SignReportResult SignReportResult RapportID Svarsobjekt Anger om anropet av funktionen lyckades och ett returvärd Success Boolean En lista med rapportobjekt ErrorText String Nej Felmeddelande i text, om funktionen misslyckades för aktuell rapportid.

20 Service: testfunktioner Denna funktion är endast för testa anrop utan anropsobjekt. Den returnerar teststrängen. testreturncallstring Teststräng Sträng Valfri sträng för test Denna funktion är endast för testa anrop med anropsobjekt. Den returnerar anropsegenskaperna separerade med _ och avslutas med testrängen dvs ORGID_SYSTEMID_USERID_teststrängen. testcallerreturnids Anropsparameter Anropsobjekt Ett objekt som identifierar Teststräng Sträng Valfri sträng för test Förändringslogg Förändring Version Information Alex Stendahl 2.10 Tillägg av funktion för att hämta notifieringar. Alex Stendahl 2.11 Tillägg för att kunna signera automatiskt - SignReport