Procesi, ki jih pokrivamo z javnimi vmesniki (Public API)

1. Kazalo vsebine

• Procesi, ki jih pokrivamo z javnimi vmesniki (Public API)
  • 1. Kazalo vsebine
  • 2. Povzetek
  • 3. Authentikacija in avtorizacija uporabnika
    • 3.1. pridobi varnostni žeton (JWT) za dostop do API-jev
  • 4. Osnovne funkcionalnosti portala za uporabnika GIS
    • 4.1. Preventivna obravnava ženske
      • A. preveri podatke ženske (opcijsko)
      • B. preveri podatke ginekologa in organizacije (opcijsko)
      • C. pridobi podatke o izvidih za žensko ter jih prikaže ginekologu ob odprtju kartoteke:
    • 4.2. Vnos anamneze in laboratorijskega zahtevka za test odvzetega vzorca
      • A. preveri podatke ženske (opcijsko)
      • B. v primeru, da preverjanje ženske pokaže, da ženske ni v sistemu Zora, GIS ustvari novo (neformalno) žensko
      • C. pripravi e-zahtevek za laboratorijska naročila (vključno s številkami odvzetih vzorcev), ki so bila narejena v sklopu obravnave.
  • 5. Osnovne funkcionalnosti portala za uporabnika LIS
    • 5.1. Prevzem laboratorijskega naročila
      • A. LIS s pomočjo API vrne podatke uporabniku za ustrezno laboratorijsko naročilo z ustreznega e-zahtevka.
      • B. Prevzame laboratorijsko naročilo/e-zahtevek in zabeleži laboratorijsko številko.
    • 5.2 Ročni vnos laboratorijskega naročila
      • A. LIS s pomočjo API vrne podatke uporabniku za ustrezno laboratorijsko naročilo z ustreznega e-zahtevka.
      • B. v kolikor laboratorijskega naročila ne najde, naredi ročni vnos e-zahteveka za laboratorijska naročila.
      • C. Prevzame laboratorijsko naročilo/e-zahtevek in zabeleži laboratorijsko številko.
    • 5.3 Zavrnitev laboratorijskega naročila
      • A. LIS s pomočjo API poišče ustrezen e-zahtevek in ga zavrne na portalu.
    • 5.3 Vnos izvida
      • A. LIS s pomočjo API preveri izvid s predogledom sinoptičnega izvida
      • B. LIS s pomočjo API zabeleži podatke izvida na portalu.
      • C. LIS s pomočjo API prenese končni sinoptični izvid po preteku časovnega obdobja za možnost popravljanja izvida (opcijsko)

2. Povzetek

Funkcionalnosti portala Zorica (v nadaljevanju portal) so preko javnih vmesnikov (Public API) na voljo tudi uporabnikom, ki pri svojem delu ne uporabljajo direktno portala, temveč svoj lasten informacijski sistem:

• GIS: Informacijski sistem, ki ga uporablja uporabnik v ginekološki ambulanti.
• LIS: Informacijski sistem, ki ga uporablja uporabnik v laboratoriju za podporo svojemu delu.

GIS ali LIS s pomočjo API-ja omogočimo dostop do branja, prevzemanja in pošiljanja podatkov na portal pri procesih vabljenja, obveščanja, vnosov zahtevkov za laboratorijske izvide ter samih izvidov. Za presejalni program je ključna vključenost ginekologov in laboratorijev pri vnosu strukturiranega izvida.

Specifikacija opisuje primere uporabe, za katere je predvidena uporaba API-jev.

3. Authentikacija in avtorizacija uporabnika

Za dostop do API-jev je potrebna ustrezna avtorizacija, ki se izvaja preko JSON Web Token (JWT). Uporabnik se mora prijaviti v sistem, da pridobi JWT, ki ga nato uporablja za avtentikacijo pri klicih API-jev. Vsak API zahteva, da se JWT posreduje v glavi zahteve (header) kot del avtentikacijskega procesa.

3.1. pridobi varnostni žeton (JWT) za dostop do API-jev

• Obtain a new OAuth access token: pridobivanje novega žetona in osveževanje veljavnosti žetona.

4. Osnovne funkcionalnosti portala za uporabnika GIS

Spodaj so navedeni primeri uporabe, pri katerih se predvideva integracija preko API vmesnikov.

4.1. Preventivna obravnava ženske

V sklopu obravnave in vnosa laboratorijskega zahtevka za test odvzetega vzorca so na voljo naslednje operacije:

A. preveri podatke ženske (opcijsko)

• Check patient: Preverjanje podatkov ženske s parametroma id (EMŠO) in (v primeru formalne ženske tudi) hicIdNumber.

B. preveri podatke ginekologa in organizacije (opcijsko)

• Check gynecologist and organization: Preverjanje podatkov ginekologa in organizacije z vsemi parametri (nekateri so neobvezni).

C. pridobi podatke o izvidih za žensko ter jih prikaže ginekologu ob odprtju kartoteke:

• Find reports: Iskanje osnovnih podatkov o zahtevku in izvidu (različni parametri).
• Transfer Cytology report: s parametrom requestId (koda e-zahtevka) za prenos sinoptičnega izvida citologije.
• Transfer HPV report: s parametrom requestId (koda e-zahtevka) za prenos sinoptičnega izvida HPV.

4.2. Vnos anamneze in laboratorijskega zahtevka za test odvzetega vzorca

Uporabnik pri obravnavi prebere podatke ženske, pregleda laboratorijske izvide, vnese podatke anamneze ter laboratorijsko naročilo, kjer si izbere vrsto preiskave; CITO, HPV.

Pri zaključku obravnave GIS za obravnavano žensko:

A. preveri podatke ženske (opcijsko)

• Check patient: Preverjanje podatkov ženske s parametroma id (EMŠO) in (v primeru formalne ženske tudi) hicIdNumber.

B. v primeru, da preverjanje ženske pokaže, da ženske ni v sistemu Zora, GIS ustvari novo (neformalno) žensko

• Search for informal patients: iskanje neformalne ženske s parametrom birthDate
• Create an informal patient: ustvarjanje nove neformalne ženske.

C. pripravi e-zahtevek za laboratorijska naročila (vključno s številkami odvzetih vzorcev), ki so bila narejena v sklopu obravnave.

• Create a new Cytology request: z vsemi podatki za citološki zahtevek.
• Create a new HPV request: z vsemi podatki za HPV zahtevek.

5. Osnovne funkcionalnosti portala za uporabnika LIS

Spodaj so navedeni primeri uporabe, pri katerih se predvideva integracija preko API vmesnikov.

5.1. Prevzem laboratorijskega naročila

Uporabnik LIS dobi vzorec in spremni dokument laboratorijskega naročila. V LIS sistemu poišče ustrezno laboratorijsko naročilo. Prevzame laboratorijsko naročilo, v kolikor ga je našel, in mu dodeli laboratorijsko številko.

A. LIS s pomočjo API vrne podatke uporabniku za ustrezno laboratorijsko naročilo z ustreznega e-zahtevka.

• Get an existing request: s parametri requestingOrganizationId, organizationIdType (BPI ali ZZZS) in specimenNumber.

B. Prevzame laboratorijsko naročilo/e-zahtevek in zabeleži laboratorijsko številko.

• Claim request: s parametrom requestId (koda e-zahtevka).

5.2 Ročni vnos laboratorijskega naročila

Uporabnik LIS dobi vzorec in spremni dokument laboratorijskega naročila. V LIS sistemu poišče ustrezno laboratorijsko naročilo. V kolikor laboratorijskega naročila ne najde, naredi ročni vnos in mu ob vnosu dodeli laboratorijsko številko. LIS s pomočjo API na portal zabeleži e-zahtevek za laboratorijska naročila. Prevzame laboratorijsko naročilo in zabeleži laboratorijsko številko.

A. LIS s pomočjo API vrne podatke uporabniku za ustrezno laboratorijsko naročilo z ustreznega e-zahtevka.

• Get an existing request: s parametri requestingOrganizationId, organizationIdType (BPI ali ZZZS) in specimenNumber.

B. v kolikor laboratorijskega naročila ne najde, naredi ročni vnos e-zahteveka za laboratorijska naročila.

• Create a new Cytology request: z vsemi podatki za citološki zahtevek.
• Create a new HPV request: z vsemi podatki za HPV zahtevek.

C. Prevzame laboratorijsko naročilo/e-zahtevek in zabeleži laboratorijsko številko.

• Claim request: s parametrom requestId (koda e-zahtevka).

5.3 Zavrnitev laboratorijskega naročila

Uporabnik LIS dobi vzorec in spremni dokument laboratorijskega naročila. V LIS sistemu poišče ustrezno laboratorijsko naročilo. Pregleda in zavrne laboratorijsko naročilo, v kolikor ga je našel in mu NE dodeli laboratorijske številke. V kolikor laboratorijskega naročila ne najde, ne naredi ročni vnos laboratorijskega naročila.

A. LIS s pomočjo API poišče ustrezen e-zahtevek in ga zavrne na portalu.

• Reject request: s parametrom requestId (koda e-zahtevka).

5.3 Vnos izvida

Uporabnik LIS v svojem sistemu obdela vzorec in naredi izvid. Ko je izvid dokončno avtoriziran (avtoriziran in je preteklo določeno časovno obdobje za možnost popravljanja izvida), LIS za laboratorijsko naročilo zabeleži podatke izvida.

A. LIS s pomočjo API preveri izvid s predogledom sinoptičnega izvida

• Get Cytology synoptic report preview: s parametrom requestId (koda e-zahtevka) za predogled sinoptičnega izvida citologije.
• Get HPV synoptic report preview: s parametrom requestId (koda e-zahtevka) za predogled sinoptičnega izvida HPV.

B. LIS s pomočjo API zabeleži podatke izvida na portalu.

• Create a new Cytology report: s parametrom requestId (koda e-zahtevka) z vsemi strukturiranimi podatki za citološki izvid.
• Create a new HPV report: s parametrom requestId (koda e-zahtevka) z vsemi strukturiranimi podatki za HPV izvid.

C. LIS s pomočjo API prenese končni sinoptični izvid po preteku časovnega obdobja za možnost popravljanja izvida (opcijsko)

• Transfer Cytology report: s parametrom requestId (koda e-zahtevka) za prenos sinoptičnega izvida citologije.
• Transfer HPV report: s parametrom requestId (koda e-zahtevka) za prenos sinoptičnega izvida HPV.