Országos Egészségbiztosítási Pénztár
Szabad Ágyszámok Nyilvántartó Rendszere API TESZTELŐ ALKALMAZÁS LEÍRÁS
Szerző:
Simon László
Készült:
2010.01.15.
Utolsó módosítás:
2010.02.25.
Projektazonosító:
Ágyszám
Verzió:
1.7
Dokumentum-ellenőrzés
Változások Dátum
Szerző
Verzió
Hivatkozás
2010 január 15.
Rozgonyi Anna
1.0 verzió
Első, kiadásra kerülő verzió
2010 február 15.
Rozgonyi Anna
1.7
Szinkronizálás korlátozása Hibakódok
Átnézték Név
Beosztás
Simon László
Kapják Sorszám
Név
Hely
Projektkönyvtár AC
Jóváhagyják Név
Aláírás
Dátum
Árki Kornél Hencz László
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
2/28
Tartalom 1.
Bevezetés ....................................................................................................................................... 4 1.1. A dokumentum célja .............................................................................................................. 4
2.
Fogalomtár..................................................................................................................................... 5
3.
A rendszer általános jellemzői ....................................................................................................... 7 3.1. A program indítása ................................................................................................................. 8 3.2. Adatbázis ................................................................................................................................ 9 3.3. API funkcionalitás .................................................................................................................. 9 3.4. API szolgáltatások működése ............................................................................................... 10 Az API-s szolgáltatások működését használati esetek leírásával ismertetjük. ..................... 10 3.4.1. getBedInfoWs - Osztály információk lekérdezése .................................................... 10 3.4.1.1. Az intézmény minden osztálya információinak lekérdezése .............................. 10 3.4.1.2. Egy adott osztály információinak lekérdezése SZÁRNY azonosító alapján. ..... 11 3.4.1.3. Egy adott osztály információinak lekérdezése FIN kód alapján. ........................ 12 3.4.2. Ágyfoglalások lekérdezése adott osztályon - getBedResInfoWs............................... 13 3.4.2.1. Egy adott osztály minden foglalásadatának lekérdezése D-ID kód alapján. ...... 13 3.4.2.2. Egy adott osztály foglalásadatainak lekérdezése FIN kód alapján. .................... 14 3.4.3. Előfoglalások lekérdezése - getBedPreResInfoWs .................................................... 14 3.4.3.1. Egy adott osztály minden előfoglalás adatának lekérdezése D-ID kód alapján. . 15 3.4.3.2. Előfoglalás lekérdezése USER-re. ...................................................................... 16 3.4.4. Ágyfoglalások lekérdezése adott osztályon - getBedResInfoWs............................... 17 3.4.4.1. Ágy foglalása adott osztályon D-ID-val ............................................................. 18 3.4.4.2. Ágy foglalása adott osztályon FIN Kóddal ........................................................ 18 3.4.4.3. Ágy foglalása adott osztályon előfoglalásból. .................................................... 19 3.4.5. Ágy felszabadítása - putBedFreeWs .......................................................................... 20 3.4.5.1. Ágy felszabadítása R-ID-val .............................................................................. 20 3.4.5.2. Ágy felszabadítása adott osztályon FIN kód és törzsszámmal. ......................... 21 3.4.6. Ágy előfoglalása - putBedPreResWs ......................................................................... 21 3.4.6.1. Egy adott osztályhoz előfoglalás adat felvitele D-ID kód alapján. .................... 22 3.4.6.2. Egy adott osztályhoz előfoglalás adat felvitele FIN kód alapján. ...................... 23 3.4.7. Ágyszámok szinkronizálása – putBedSyncWs .......................................................... 24 3.4.7.1. Egy adott osztályhoz foglalások szinkronizálása ............................................... 25 3.4.7.2. Intézményi foglalások szinkronizálása .............................................................. 26 3.5. Saját xml küldése ................................................................................................................. 27 3.6. Hibakezelés .......................................................................................................................... 27 3.6.1. A rendszer által kezelt hibák ...................................................................................... 27
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
3/28
1. Bevezetés 1.1.
A dokumentum célja 2010 január 1-től bevezetésre került a SZÁRNY- Szabad ágyszámok nyilvántartó rendszere, amelynek célja az aktív fekvőbeteg ellátó intézmények online megadott ágyfoglaltsági adatai alapján a mentésirányításnak információt szolgáltatni egy adott térségben elérhető szabad ágyakról. Az ágyszámadatok kezelhetők és lekérdezhetők web-es felületről, valamint API-n keresztül. Jelen dokumentum a SZÁRNY rendszer API-s adatkezeléshez SzarnyWsTest java tesztelő alkalmazás működésének leírását tartalmazza.
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
készült
4/28
2. Fogalomtár Felhasználónév Az OJOTE adminisztrációs rendszerében a SZÁRNY rendszerhez felvett felhasználó felhasználóneve. Jelszó Az OJOTE adminisztrációs rendszerében a SZÁRNY rendszerhez felvett felhasználó belépési jelszava. FIN kód Az adott osztály OEP finanszírozási kódja. D-ID Az adott osztály SZÁRNY rendszerben kapott és használt azonosító kódja. R-ID Egy adott foglalás tétel SZÁRNY rendszerbeli azonosítója. Event Code Egy adott mentésirányítási eset azonosítója. Egy esetazonosító több előfoglalásban is szerepelhet. Törzsszám Egy adott beteg egy adott osztályra való felvételekor kapott intézményi azonosítószám. Egy intézményen belül egy törzsszám egyidőben csak egyszer fordulhat elő az aktív foglalások között. Sync, vagy szinkronizálás Adatszinkronizálás rövidítése, amit a putBedSyncWs funkcióval végzünk el. Ilyenkor egy intézmény, vagy egy osztály egy adott pillanatban érvényes összes aktív foglalásadatát egyszerre adjuk át a SZÁRNY rendszernek, ahol azok összehasonlításra kerülnek az ottlévőkkel, és a kapottakhoz lesznek igazítva. D-ID (Sync fejhez) Egy osztály adatszinkronizáláskor az osztály SZÁRNY azonosítója. FIN-kód (Sync fejhez) Egy osztály adatszinkronizáláskor az osztály OEP finanszírozási kódja.
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
5/28
Hozzáadott foglalások száma Adatszinkronizáláskor a megadott paraméterek alapján a foglalási tétel sorszáma. Küldés A paraméterek megadása után a program által összeállított xml átadása. Törlés A paraméter mezők és a text-box kiürítése. Saját küldése A program paraméterek bekérése nélkül, „szabadon” összeállított, a szöveg-boxba beírt xml elküldésének lehetősége. Hozzáad Adatszinkronizáció során a paraméterben megadott értékek átadása az xml-t előállító eljárásnak. TextBox A paraméterek alatt látható ablak, amelyben az aktuális kommunikációban küldött és válaszul kapott adatok láthatók xml formátumban. A dokumentum további fogalmai azonosak a web-es SZÁRNY rendszer felhasználói leírás dokumentumban található értelmezésekkel.
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
6/28
3. A rendszer általános jellemzői A SZÁRNY rendszer funkcióit az arra jogosult külső felhasználók szabványos, Web szolgáltatás (WEB SERVICE) felületen keresztül érhetik el, ugyanúgy, mint az OJOTE rendszerben. Az interfészt webservice technológia segítségével valósult meg. A webservice XML adatfolyamok formájában kommunikál. Autentikáció ellenőrzés történik minden hívás előtt. A WS hívások csak az OJOTE rendszerben szabályosan rögzített aktív felhasználók számára elérhetők. A rendszer minden hívás előtt ellenőrzi a hívó azonosságát, jogosultságát, és az adatokat ennek megfelelően engedi elérni. A szabad ágyszámok nyilvántartó rendszere azonosítási alrendszernek az OJOTE rendszer használata közben keletkezett, és az ott már gyakorlattá vált munkafolyamat szerint karbantartott címtárat alkalmazza. A felhasználók azonosítása a korábban is használt OID-ban történik.
Osztálytörzs kezelés Intézménykezelés1 Felhasználó kezelés2 Szabad ágyszám lekérdezése Előfoglalás, előfoglalás törlés Ágyszám karbantartás, foglalás, felszabadítás Naplók lekérdezése4 Statisztikák
Statisztikus
Ágyszám betekintő
Ágyszám lekérdező
Ágyszám karbantartó
Menü-funkció / Szerepkör
INTADMIN
OEPADMIN
MEPADMIN
Szerepkör alapján elérhető web alkalmazás funkciók:
x x
x
x
x
x x x
x
3
x
x x
x
x
x
x
x
5
x
Szerepkör alapján elérhető API funkciók: Ágyszám karbantartó
Ágyszám lekérdező
x
x
x
x
Menü-funkció / Szerepkör
Osztály ágyszám lekérdezése Osztály foglalás lekérdezése 1
OEPADMIN teljes hatáskörben, MEPADMIN a hozzá tartozó megyén belül OEPADMIN teljes hatáskörben, MEPADMIN a hozzá tartozó megyén belül, INTADMIN csak saját intézményében 3 Az ágyszám betekintő minden intézmény ágyszámadatait lekérdezheti. 4 OEPADMIN teljes hatáskörben, MEPADMIN a hozzá tartozó megyén belül, INTADMIN csak saját intézményében, míg a lekérdező és karbantartó felhasználók a saját kódjukkal végzett módosítások napló adatait kérdezhetik le. 5 Az ágyszám betekintő minden naplóadatot lekérdezhet. 2
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
7/28
Ágyszám karbantartó
Ágyszám lekérdező
x
x
Menü-funkció / Szerepkör
Osztály előfoglalás lekérdezése Foglalás Előfoglalás Felszabadítás Szinkronizálás 3.1.
x x
x
x
x
x
A program indítása A rendszer API-s funkcióinak tesztelésére a SzarnyWsTest java alkalmazás került kifejlesztésre. A program letölthető a SZÁRNY tesztrendszer web-es bejelentkező lapjának felületénél, a „Segédletek, levelezőlista” funkciónál. A programot a tesztkörnyezetbe javasoljuk használni.
Elérés: http://tesztjogviszony.oep.hu/agyszam A program indítása után a következő képernyő jelenik meg:
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
8/28
A legfelső sorban meg kell adni a felhasználói nevet és jelszót. A felhasználónak az alábbi kritériumoknak kell megfelelnie:
Az OEP címtárában szereplő, aktív felhasználónévvel és jelszóval kell rendelkezni.
Az alkalmazásban ne legyen átmenetileg kizárva. o
3.2.
Megadott számú (pl. 3) sikertelen bejelentkezés után történik, és szintén megadható ideig (1 óra) van életben ez a fajta kizárás.
A felhasználó intézményének rendelkezni kell „Ágyszám lekérdező”, vagy „Ágyszám karbantartó” jogosultsággal.
Adatbázis Ez után ki kell választani az adatbázist, amit el szeretnénk érni a programmal. A baloldali legördülő menüből jelenleg az alábbi lehetőségek közül lehet választani:
3.3.
API funkcionalitás Ez után a jobboldali legördülő menüből ki lehet választani a használni kívánt web szolgáltatást. Az API-k pontos specifikációját egy külön SZÁRNY API felhasználói dokumentáció tartalmazza. A web szolgáltatások a következők:
Ezek értelmezése:
Megnevezés getBedInfoWs
Értelmezés Osztályadatok lekérdezése
2.
getBedResInfoWs
Ágyfoglalások lekérdezése adott osztályon
3.
getBedPreResInfoWs
Előfoglalások lekérdezése
4.
putBedResWs
Ágyfoglalás
5.
putBedFreeWs
Ágy felszabadítás
6.
putBedPreResWs
Ágy előfoglalás
Sorsz. 1.
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
9/28
Sorsz. 7. 3.4.
Megnevezés putBedSync
Értelmezés Ágyszám szinkronizálás
API szolgáltatások működése Az API-s szolgáltatások működését használati esetek leírásával ismertetjük. getBedInfoWs - Osztály információk lekérdezése
3.4.1.
Egy adott intézmény összes foglalt, előfoglalt és szabad ágyszámát és a SZÁRNY rendszerben tárolt – adatát kérdezheti le az intézmény ennek a szolgáltatásnak a használatával. Ha az osztály azonosítóját nem adja meg (FINKOD-dal, vagy D_ID-val), akkor az intézmény minden osztályára megkapja az adatokat. A szolgáltatás hívásakor megadandó adatok:
Osztály FIN kódja (nem kötelező)
Osztály SZÁRNY azonosítója (nem kötelező)
A szolgáltatás által visszaadott adatok:
Hibakód (sikeres végrehajtás esetén 0)
Hibaszöveg
Osztályonként:
Osztály SZÁRNY azonosítója
FINkód
Osztálytípus kód
Osztály neve
Osztály címe
Összes ágyszám
Foglalt ágyszám
Előfoglalt ágyszám
Szabad ágyszám
Ha a D-ID van csak megadva akkor az alapján hajtja végre a keresést, ha csak a FINkód van megadva akkor az alapján hajtja végre a keresést. Ha mindkettő meg van adva, akkor a D-ID alapján keres. Ha az osztály azonosítóját nem adja meg (FINKOD-dal, vagy D_ID-val), akkor az intézmény minden osztályára visszaadja az adatokat. Használati esetek: Az intézmény minden osztálya információinak lekérdezése
3.4.1.1.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
10/28
o Válassza ki a getBedInfoWs API-t. o Ellenőrizze, hogy csak a D-ID (osztály SZÁRNY azonosítója), és a FIN kód (osztály azonosító) paraméter lesz kitölthető. o A D-ID-t, és a FIN kódot hagyja üresen. o Nyomja meg a „Küldés” gombot. o Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - fin Kód (üres) - did (üres) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) az „osztályok” több tételsorból áll: - :redBedFree (az osztály szabad ágyainak száma) - bedTotal (az osztály összes ágyainak száma) - redBedOcc (az osztály előfoglalt ágyainak száma) - DId (az osztály SZÁRNY azonosítója) - FINkód (osztálykód) - address (az osztály címe) - name (az osztály neve) - redBedRes (az osztály foglalt ágyainak száma) o Ellenőrizzük, hogy dId=0 és üres FIN kód esetén is minden osztály adatát megkapjuk a válaszban. 3.4.1.2. Egy adott osztály információinak lekérdezése SZÁRNY azonosító alapján. Lépései:
o Válasszon ki egy D-ID-t és adja meg, a FIN kódot hagyja üresen. o Nyomja meg a „Küldés” gombot. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - fin Kód (üres) - dId (a megadott) szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
11/28
A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) az „osztályok” egy tételsorból áll: - redBedFree (az osztály szabad ágyainak száma) - bedTotal (az osztály összes ágyainak száma) - redBedOcc (az osztály előfoglalt ágyainak száma) - DId (a kérésben megadott) - fin Kód (osztálykód) - address (az osztály címe) - name (az osztály neve) - redBedRes (az osztály foglalt ágyainak száma) Egy adott osztály információinak lekérdezése FIN kód alapján.
3.4.1.3. Lépései:
o Az első lekérdezés válaszadataiból válasszon ki egy osztályt, adja meg a FIN kódot, és a D-ID-t hagyja üresen. o Nyomja meg a „Küldés” gombot. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - fin Kód (a megadott) - dId (üres) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) az „osztályok” egy tételsorból áll: - redBedFree (az osztály szabad ágyainak száma) - bedTotal (az osztály összes ágyainak száma) - redBedOcc (az osztály előfoglalt ágyainak száma) - DId (az osztály SZÁRNY azonosítója) - fin Kód (osztálykód) - address (az osztály címe) - name (az osztály neve) szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
12/28
- redBedRes (az osztály foglalt ágyainak száma)
3.4.2. Ágyfoglalások lekérdezése adott osztályon - getBedResInfoWs
Egy adott intézmény adott osztályán levő – a SZÁRNY rendszerben tárolt összes foglalt ágy törzsszámát kérdezheti le az intézmény ennek a szolgáltatásnak a használatával. Ez az adott osztályon a nyilvántartott adatok egyeztetésekor lehet szükséges (ha például valaki elmulasztott jelenteni egy foglalást vagy felszabadítást, és emiatt a nyilvántartott számok nem egyeznek a ténylegessel). A szolgáltatás hívásakor megadandó adatok:
Osztály egyedi azonosítója
Osztály SZÁRNY azonosítója
A szolgáltatás által visszaadott adatok:
Hibakód (sikeres végrehajtás esetén 0)
Hibaszöveg
Osztály egyedi azonosítója
Foglalásonként:
Felvétel dátuma
Esetazonosító
Foglalás SZÁRNY azonosítója
Törzsszámok
Ha a D-ID van csak megadva akkor az alapján hajtja végre a keresést, ha csak a FINkód van megadva akkor az alapján hajtja végre a keresést. Ha mindkettő meg van adva, akkor a D-ID alapján keres. Legalább az egyik azonosítót pontosan meg kell adni a lekérdezéshez. Használati esetek: 3.4.2.1. Egy adott osztály minden foglalásadatának lekérdezése D-ID kód alapján. Lépései:
o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válassza ki a getBedResInfoWs API-t. o Ellenőrizze, hogy csak a D-ID (osztály SZÁRNY azonosítója), és a FIN kód (osztály azonosító) paraméter lesz kitölthető. o A D-ID-t adja meg, és a FIN kódot hagyja üresen. szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
13/28
Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKód (üres) - did (a megadott) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) - finKód (osztálykód) - did (a megadott) - redBedRes (az osztály foglalt ágyainak száma, ez a mező a válaszüzenet végére kerül!) A „foglalások” több tételsorból állhat: - felvetel (a foglalás kezdetének dátuma) - esemAzon (eseményazonosító) - RId (a foglalás azonosítója) - torzsSzam (a beteg törzsszáma)
Egy adott osztály foglalásadatainak lekérdezése FIN kód alapján.
3.4.2.2. Lépései:
o Adja meg az előző lekérdezés D-ID-nek megfelelő FIN kódot. Ellenőrizze, hogy az eredmény ugyan az, mint az előző esetben. Ha a D-ID és a FIN kód is megadásra kerül, akkor a D-ID alapján kapjuk a választ.
3.4.3. Előfoglalások lekérdezése - getBedPreResInfoWs
Előfoglalásokat lehet lekérdezni a következő módon: Ha a lekérdező megadja az osztálykódot (DID, vagy FIN-kód), akkor arra az osztályra vonatkozó előfoglalásokat adja vissza eredményül. Ha nem ad meg osztálykódot, akkor a felhasználó USER aktuálisan élő előfoglalásait adja vissza. Az első esetben a szolgáltatás hívásakor megadandó adatok:
Osztály egyedi azonosítója
Osztály SZÁRNY azonosítója
A szolgáltatás által visszaadott adatok: szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
14/28
Hibakód (sikeres végrehajtás esetén 0)
Hibaszöveg
Előfoglalásonként:
Intézmény neve
Osztály egyedi azonosítója
Osztály SZÁRNY azonosítója
Osztály neve
Osztály címe
Foglalás SZÁRNY azonosítója
Felvétel dátuma (óra, perc)
Eseményazonosító
Törzsszám
Előfoglaló
Ha a D-ID van csak megadva akkor az alapján hajtja végre a keresést, ha csak a FINkód van megadva akkor az alapján hajtja végre a keresést. Ha mindkettő meg van adva, akkor a D-ID alapján keres. Ha nem ad meg osztálykódot, akkor a felhasználó kódjával lefoglalt előfoglalások kerülnek visszaadásra. Használati esetek: 3.4.3.1. Egy adott osztály minden előfoglalás adatának lekérdezése D-ID kód alapján.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válassza ki a getBedPreResInfoWs API-t. o Ellenőrizze, hogy csak a D-ID (osztály SZÁRNY azonosítója), és a FIN kód (osztály azonosító) paraméter lesz kitölthető. o A D-ID-t adja meg, és a FIN kódot hagyja üresen. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKód (üres) - did (a megadott) A Válaszban érkezett: szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
15/28
- hibaSzöveg („Feldolgozva”) - hibaKód (0) A „előfoglalások” több tételsorból állhat: - FINkód (osztálykód) - DID (osztály SZÁRNY azonosító) - RedBedRes (foglalások száma) - felhasználó (előfoglalást végző) - felvetel (a foglalás kezdetének dátuma) - intézménynév - esemAzon (eseményazonosító) - RId (a foglalás azonosítója) - torzsSzam (a beteg törzsszáma) - address (osztálycím) - name (osztálynév)
Előfoglalás lekérdezése USER-re.
3.4.3.2.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válassza ki a getBedPreResInfoWs API-t. o Vigyen fel előzetesen előfoglalást a putBedPreResWs-el az ott leírt módon. o
Válassza ki a getBedPreResInfoWs API-t.
o Ne adjon meg osztálykódot, csak nyomja meg a „Küldés” gombot. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKód (üres) - did (üres) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) A „előfoglalások” több tételsorból állhat: - felvetel (a foglalás kezdetének dátuma) - intézménynév szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
16/28
- esemAzon (eseményazonosító) - finKód (osztálykód) - RId (a foglalás azonosítója) - DID (SZÁRNY osztályazonosító) - felhasználó (előfoglaló) - address (osztálycím) - torzsSzam (a beteg törzsszáma) - name (osztálynév) A rendszer csak az aktuálisan élő előfoglalás adatokat adja vissza.
3.4.4. Ágyfoglalások lekérdezése adott osztályon - getBedResInfoWs
Egy adott intézmény adott osztályán levő – a SZÁRNY rendszerben tárolt összes foglalt ágy törzsszámát kérdezheti le az intézmény ennek a szolgáltatásnak a használatával. Ez az adott osztályon a nyilvántartott adatok egyeztetésekor lehet szükséges (ha például valaki elmulasztott jelenteni egy foglalást vagy felszabadítást, és emiatt a nyilvántartott számok nem egyeznek a ténylegessel). A szolgáltatás hívásakor megadandó adatok:
Osztály egyedi azonosítója
Osztály SZÁRNY azonosítója
A szolgáltatás által visszaadott adatok:
Hibakód (sikeres végrehajtás esetén 0)
Hibaszöveg
Osztály egyedi azonosítója
Foglalásonként:
Felvétel dátuma
Esetazonosító
Foglalás SZÁRNY azonosítója
Törzsszámok
Ha a D-ID van csak megadva akkor az alapján hajtja végre a keresést, ha csak a FINkód van megadva akkor az alapján hajtja végre a keresést. Ha mindkettő meg van adva, akkor a D-ID alapján keres. Legalább az egyik azonosítót pontosan meg kell adni a lekérdezéshez. Használati esetek:
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
17/28
Ágy foglalása adott osztályon D-ID-val
3.4.4.1.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válassza ki a putBedResWs API-t. o Ellenőrizze, hogy a D-ID (osztály SZÁRNY azonosítója), a FIN kód (osztály azonosító) , az EventKod és a törzsSzám paraméter lesz kitölthető. o Az első lekérdezés válaszadataiból válasszon ki egy D-ID-t és adja meg, a FIN kódot, EventCode-ot hagyja üresen, törzsSzámot töltse ki. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKod (üres) - dId (a megadott) - eventCode (üres) - torzsSzam (a megadott) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) - RId (a foglalás SZÁRNY azonosítója) - DId (az osztály SZÁRNY azonosítója)
Ágy foglalása adott osztályon FIN Kóddal
3.4.4.2.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o D-ID-t hagyja üresen, adja meg az első lekérdezés D-ID-jének megfelelő a FIN kódot, törzsSzámot töltse ki új értékkel. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
18/28
- Password (a megadott jelszó) - finKod (a megadott) - dId (üres) - eventCode (üres) - torzsSzam (a megadott) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) - RId (a foglalás SZÁRNY azonosítója) - DId (az osztály SZÁRNY azonosítója) (A későbbi teszteléshez jegyezze meg az RId kódot.) Ágy foglalása adott osztályon előfoglalásból.
3.4.4.3.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o A web-es SZÁRNY alkalmazás felületén kérdezzen le egy élő előfoglalást. Jegyezze meg az eseményazonosítóját. o Adja meg a D-ID-t és az eseményazonosítót, valamint egy új törzsszámot. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKod (üres) - dId (a megadott) - eventCode (a megadott) - torzsSzam (a megadott) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) - RId (a foglalás SZÁRNY azonosítója) - DId (az osztály SZÁRNY azonosítója) A getBedResInfoWs-el lekérdezheti az osztály foglalásait, a web-s felületen eltűnik az előfoglalás. szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
19/28
3.4.5. Ágy felszabadítása - putBedFreeWs
Egy adott intézmény adott osztályán egy foglalás, vagy egy előfoglalás felszabadítását végezheti el az intézmény ennek a szolgáltatásnak a használatával. A szolgáltatás hívásakor megadandó adatok:
Osztály egyedi azonosítója
Osztály SZÁRNY azonosítója
Foglalás SZÁRNY azonosítója
Törzsszám
A szolgáltatás által visszaadott adatok:
Hibakód (sikeres végrehajtás esetén 0)
Hibaszöveg
Csak olyan foglalás szabadítható fel, ahol a törzsszám ki van töltve. A felszabadítás elsősorban az R-ID alapján történik. Ha ez meg van adva, akkor nem vesz figyelembe más paramétert, ez alapján elvégzi a felszabadítást. A felszabadítás végezhető D-ID, vagy FIN kód alapján is, de mindegyikhez meg kell adni a törzsszámot. (A felszabadított tétel bekerül a naplóállományba is, onnan lekérdezhető.) Használati esetek: Ágy felszabadítása R-ID-val
3.4.5.1.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válassza ki a putBedFreeWs API-t. o Ellenőrizze, hogy a D-ID (osztály SZÁRNY azonosítója), a FIN kód (osztály azonosító) , az R-ID és a törzsSzám paraméter lesz kitölthető. o Az első lekérdezés válaszadataiból válasszon ki egy R-ID-t és adja meg, a D-ID-t, FIN kódot és a TörzsSzámot hagyja üresen. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKod (üres) szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
20/28
- dId (üres) - rId (a megadott) - torzsSzam (üres) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) Ellenőrizze a SZÁRNY alkalmazásban, hogy a felszabadított tétel a Naplóba is bekerült.
Ágy felszabadítása adott osztályon FIN kód és törzsszámmal.
3.4.5.2.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válasszon ki egy törzsSzámot, adja meg a hozzá tartozó FIN-kódot, a D-ID-t és az R-ID-t hagyja üresen. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKod (a megadott) - dId (üres) - rId (üres) - torzsSzam (a megadott) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) Ellenőrizze a SZÁRNY alkalmazásban, hogy a felszabadított tétel a Naplóba is bekerült.
3.4.6. Ágy előfoglalása - putBedPreResWs
Egy adott intézmény adott osztályán egy ágy előfoglalását végezheti el a mentésirányítás, ill. az intézmény ennek a szolgáltatásnak a használatával. A szolgáltatás hívásakor megadandó adatok:
Osztály egyedi azonosítója
Osztály SZÁRNY azonosítója
Eseményazonosító
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
21/28
Törzsszám
A szolgáltatás által visszaadott adatok:
Osztály SZÁRNY azonosítója
Előfoglalás SZÁRNY azonosítója
Hibakód (sikeres végrehajtás esetén 0)
Hibaszöveg
Az eseményazonosítót és a törzsszámot is használja az előfoglaláshoz. Az előfoglalás ebben az esetben is csak a rendszerben beállított időintervallumig él, utána automatikusan lejár és a tétel törlődik, az ágy felszabadul. (Naplótétel képződik.) A Menetirányítás és az intézményi előfoglalási időintervallum külön paraméter, egymástól eltérő érték lehet. Rendszerszinten ez két paramétert jelent. Pl.: Mentésirányítási - 2 óra, Intézményi – 24 óra. Ezzel az intézmény előző nap este előfoglalhatja az előjegyzett betegek ágyait. Az ágyszám karbantartó előfoglalást az intézményén belül bármelyik osztályra adhat, nem csak az általa kezelt osztályra. A rendszer enged az ágyszám kereten túl, „negatívba” is előfoglalni. Erről figyelmeztetés érkezik (-1). Az előfoglalás végezhető D-ID, vagy FIN kód alapján is, de mindegyikhez meg kell adni az eseményazonosítót, vagy a törzsszámot. Használati esetek: Egy adott osztályhoz előfoglalás adat felvitele D-ID kód alapján.
3.4.6.1.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válassza ki a putBedPreResWs API-t. o Ellenőrizze, hogy csak a D-ID (osztály SZÁRNY azonosítója), és a FIN kód (osztály azonosító), valamint az EventCode, és a Törzsszám paraméter lesz kitölthető. o A D-ID-t adja meg, és a FIN kódot hagyja üresen. o Adja meg az eseményazonosítót. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKód (üres) - did (a megadott) - EventCode (a megadott) - Törzsszam (üres)
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
22/28
A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) - rId (a foglalás azonosítója) - dId (az osztály SZÁRNY azonosítója) Ellenőrizzük az előfoglalást a getBedPreResInfoWS-el. FIN kóddal történő előfoglalásnak is hasonlóak a lépései.
Egy adott osztályhoz előfoglalás adat felvitele FIN kód alapján.
3.4.6.2.
Lépései: o Adjon meg egy ágyszám karbantartó usert és annak a jelszavát. o Válassza ki a putBedPreResWs API-t. o Ellenőrizze, hogy csak a D-ID (osztály SZÁRNY azonosítója), a FIN kód (osztály azonosító), az EventCode, és a Törzsszám paraméter lesz kitölthető. o A FIN kódot adja meg, és a D-ID-t hagyja üresen. o Adja meg az eseményazonosítót. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKód (a megadott) - did (üres) - EventCode (a megadott) - Törzsszam (üres) A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) - rId (a foglalás azonosítója) - dId (az osztály SZÁRNY azonosítója) Ellenőrizzük az előfoglalást a getBedPreResInfoWS-el.
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
23/28
3.4.7. Ágyszámok szinkronizálása – putBedSyncWs
Az intézmény ezzel a funkcióval megadhatja egy adott osztályra, vagy a teljes intézményre (az általa kezelt minden osztályra) a nála nyilvántartott aktív ágyfoglalásokat törzsszám szerint. Ezt átadva a SZÁRNY rendszer összehasonlítja a saját nyilvántartásával, és azt a kapottakhoz igazítja. Ezzel a SZÁRNY kezdeti adatfeltöltése is megoldható. A szinkronizálást ritkán használt műveletnek terveztük, esetenként pl. éjszaka futtatva teheti rendbe az esetleg kapcsolati hiba miatt inkonzisztenssé vált adatokat a két rendszer között. Ez a szolgáltatás nem az on-line működés része, ezért csak bizonyos időszakban, rendszerparaméterben meghatározhatóan (pl. éjszaka 01-02-ig) lehet használni. A használat száma is külön rendszerparaméterrel van korlátozva. (Az intézménykódot a bejelentkezett felhasználó alapján a felhasználó nyilvántartásból tudja a rendszer.) Ha a fejtételben megadja a FINkódot, vagy a DID-t, akkor a teljes adatcsomag a megadott osztályra vonatkozik. Ha nem, akkor az adatcsomag a teljes intézményre, ill. a bejelentkezett user által kezelhető összes osztályra vonatkozik. Ha a D-ID van csak megadva akkor az alapján hajtja végre a keresést, ha csak a FINkód van megadva akkor az alapján hajtja végre a keresést. Ha mindkettő meg van adva, akkor a D-ID alapján keres. A kapott tételeket osztálykód és törzsszám szerint összeveti a SZÁRNY nyilvántartásával, és a hiányzókat felveszi, a fölöslegeseket felszabadítja, az egyezőket nem változtatja. A beszúrt tételben a felvétel dátuma a szinkronizálás dátuma lesz. A törölt tételnél a Naplóban a felszabadítás dátuma a szinkronizálás dátuma lesz. Ha a fejnél nem adunk meg semmit, akkor a tételeknél kötelező legalább egy osztálykód-törzsszám párosnak lennie, mert az hibát eredményez. Tehát egyszerre nem lehet az összes osztály minden foglalásadatát törölni. Ellenőrzések: Ha megadja a FINkódot és a DID-t is, akkor azoknak ugyanarra az osztályra kell vonatkozniuk. Ha megadja a fejtételben az osztálykódot, akkor az összes tételben is ugyanannak a kódnak kell szerepelnie. Ha vannak tételek, akkor egyik tételben sem lehet a törzsszám üres. A megadott törzsszámnak az intézmény aktív foglalásaiban egyedinek kell lennie. Csak olyan osztálykódot adhat meg, aminek kezeléséhez van jogosultsága. Hiba esetén az adatcsomagból egyetlen tételt sem dolgoz fel. A szolgáltatás hívásakor megadandó adatok: szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
24/28
Osztály FINkód azonosítója
Osztály SZÁRNY azonosítója
Foglalásonként:
Osztály FINkód azonosítója
Osztály SZÁRNY azonosítója
Törzsszám
A szolgáltatás által visszaadott adatok:
Hibakód (sikeres végrehajtás esetén 0)
Hibaszöveg
Statisztika a feldolgozott tételekről: o Talált tételek száma o Törölt tételek száma o Beszúrt tételek száma o A foglalások új száma
Használati esetek: Egy adott osztályhoz foglalások szinkronizálása
3.4.7.1.
Lépései:
o Válasszon ki egy olyan osztály DID-t, ahol nincs foglalás. o A sync fej D-ID-t adja meg, és a sync fej FIN kódot hagyja üresen. o Adja meg a fenti DID-t a tételhez is. Adjon meg egy új törzsszámot. Nyomja meg a „Hozzáad” gombot. o A Hozzáadott foglalások száma 1. o Adjon meg egy másik törzsszámot is. Nyomja meg a „Hozzáad” gombot. o Nyomja meg a „Küldés” gombot. Az eredmény ellenőrzése: A kérésben elküldésre kerül: - Username (a megadott user) - Password (a megadott jelszó) - finKód (üres) - did (a megadott) A Válaszban érkezett: szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
25/28
- hibaSzöveg („Feldolgozva”) - hibaKód (0) - statisztika Pl: (Tárolt foglalások száma: 0. 0 foglalás törölve. 2 foglalás beszúrva. Foglalások új száma: 2) Az eredményt ellenőrizze a getBedResInfoWs-el. Intézményi foglalások szinkronizálása
3.4.7.2. Lépései:
o A tesztadatbázisban korlátozzuk a tesztuser intézményében a kezelt osztályok számát 2-re. o Az osztályokhoz vigyünk fel néhány foglalást. o A getBedInfoWs-el ellenőrizzük le, hogy mely osztályokhoz van hozzáférése. o A két osztály foglalásadatait kérdezzük le a getBedResInfoWs-el. o Válassza ki az egyik osztály DID-t. o A sync fej-ben a DID-t és a sync fej FIN kódot hagyja üresen. o Adja meg a DID-t a tételhez. Adja meg a törzsszámot. Nyomja meg a „Hozzáad” gombot. o (A Hozzáadott foglalások száma 1-re változik.) o Adjon meg egy másik törzsszámot is. Nyomja meg a „Hozzáad” gombot. o Töltse fel így az osztály összes foglalását. o Adja meg a másik osztály DID-t a tételhez. Adja meg a törzsszámot. Nyomja meg a „Hozzáad” gombot. o (A Hozzáadott foglalások száma tovább nő.) o Adjon meg egy másik törzsszámot is. Nyomja meg a „Hozzáad” gombot. o Töltse fel így az osztály összes foglalását. o Nyomja meg a „Küldés” gombot. A Válaszban érkezett: - hibaSzöveg („Feldolgozva”) - hibaKód (0) - statisztika egyező adatok esetén: (Tárolt foglalások száma:X. 0 foglalás törölve. 0 foglalás beszúrva. Foglalások új száma: X) eltérő adatok esetén (pl:Tárolt foglalások száma:X. 1 foglalás törölve. 1 foglalás beszúrva. Foglalások új száma: X) Az eredményt ellenőrizze a getBedResInfoWs-el.
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
26/28
3.5.
Saját xml küldése A program paraméterek bekérése nélkül, „szabadon” összeállított, a szöveg boxba beírt xml elküldésének, és a rendszer által küldött válasz üzenet megtekintésének lehetősége. Meg kell adni a szervert és a tesztelni kívánt funkciót, majd a szövegdobozba be kell írni, vagy másolni a saját XML üzenetet. A „Saját küldése” gombra kattintás után megjelenik a szerver válasza is. A Törlés gombbal a szövegdoboz tartalmát törölheti. (A „Küldés” gomb itt nem használható.) A ws ekkor is ugyanazokat az ellenőrzéseket végzi a megadott adatokban, mintha paraméterekkel adtuk volna meg, és a kérés xml-t a program állította volna elő.
3.6.
Hibakezelés 3.6.1. A rendszer által kezelt hibák
Hibakód -1 0 1 2 3 8 9 10 100 101 102 103 104 105 106 107 108 500 501 502 503 504 505 506 507 508 509 510 511
Szöveg Feldolgozva de a szabad ágyak száma negatívba ment át! Feldolgozva (API-nál) Végzetes hiba történt! A rendszer pillanatnyilag nem elérhető! A megadott paraméterekkel a rendszer ezen funkciójának a használatához nem jogosult! Hibás bejelentkezés, vagy nem megfelelő xml A bejelentkezés jelenleg nem elérhető. A felhasználó letiltásra került Hiba a felhasználó megállapításakor! Nincs ilyen nevű felhasználó! Hiba történt a felhasználóhoz rendelt intézmény megállapításakor. Finkod alapján nem található az osztály! Finkod alapján több osztály található! Nem található a megadott foglalás! Hiba történt az ágy felszabadításakor. Hiba történt az előfoglalás foglalássá váltása közben. Hiba történt a TAJ szám frissítésnél. Hibás formátum a dId csak számot tartalmazhat! Hibás formátum az rId csak számot tartalmazhat! A dId csak pozitív szám lehet! Rossz érték került megadásra! Csak a TAJ szám frissíthető! A foglalás felszabadítása előtt adja meg a TAJ számotl! Nem adott meg törzsszámot! A Törzsszám megadása kötelező! A Törzsszám nem lehet hosszabb mint 20 karakter! Az eseményazonosító nem lehet hosszabb mint 20 karakter! A törzsszám minimum 1 maximum 20 karakter lehet! Az eseményazonosító minimum 1 maximum 20 karakter lehet!
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
27/28
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 999
Az eseményazonosító vagy a törzsszám megadása kötelező! Nincs elég szabad ágy az előfoglaláshoz! Ilyen törzsszámmal már létezik foglalás az intézményben! A fejlécben megadott Did nem egyezik meg mindenhol a rekordoknál is külön külön megadott Did-val! A fejlécben megadott FIN-kód nem egyezik meg mindenhol a rekordoknál is külön külön megadott FIN-kód-val! A törzsszám nincs megadva mindenhol! Hiba: nem található a megadott FIN-kódhoz osztályazonosító! Hiba: a megadott FIN-kód alapján az osztályazonosító nem egyértelműen meghatározható! Hiba az osztályazonosító megállapításakor! Hiba: a megadott osztályazonosító nem található a rendszerben! Hiba: a küldött adatok közt szerepel 20 karakternél hosszabb törzsszám! Hiba a rekordok törlésénél! Hiba a rekordok beillesztésénél! Hiba: a küldött adatok közt duplikátum található! Hiba: a fejlécben küldött FIN-kód nem felel meg a küldött osztályazonosítónak! Hiba: az intézményhez tartozó FIN-kód nem megállapítható! Hiba: nincs joga beszúrni! Hiba: semmilyen adatot nem küldött! Hiba: nem adott meg osztályt! Hiba: a foglaláshoz nem található megfelelő esetazonosítójú előfoglalás! Hiba: A DID vagy a FIN-kód megadása kötelező! Hiba: a küldött FIN-kód nem felel meg a küldött osztályazonosítónak! Hiba: Nem adott meg elegendő adatot. Hiba: Az adott intézmény érvénytelen! Hiba: Az adott osztályhoz nincs elegendő joga negatívba előfoglalni! Hiba: A szinkronizálási funkció ebben az időszakban nem elérhető! Rendszerhiba: érvénytelen intervallumparaméterek, értesítse a SZARNY rendszergazdákat! Hiba: A szinkronizálási funkciót a mai nap nem használhatja többször!
Egyéb hiba
szarny-api teszteloi alkalmazas leirasv1.7
API TESZTELŐ ALKALMAZÁS LEÍRÁS
28/28