eLab posistemės integracijos dokumentacija
0.3.3 - versija Lithuania flag

eLab posistemės integracijos dokumentacija - Local Development build (v0.3.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

FHIR Resursų API

Duomenų apsikeitimas gali būti vykdomas tiek XML tiek JSON formatais. Rekomenduojamas apsikeitimo formatas - JSON. Norint naudotis XML duomenų apsikeitimu formatu tą reikia nurodyti užklausoje naudojantis _format parametru, daugiau informacijos galima rasti čia.

ServiceRequest

Paieškos parametrai

Pavadinimas Aprašymas

authored

Pateikimo data ir laikas

code-concept

Užsakyto tyrimo kodas

identifier

Unikalus identifkatorius

patient

Pacientas (pagal jo id arba vieną iš paciento paieškos parametrų)

performer

Tyrimą atliekanti įstaiga

requester

Tyrimą pateikiantis specialistas/įstaiga - nuoroda į PractitionerRole resursą

requisition

Grupinio užsakymo

status

Statusas

_include/_revinclude

Parametras leidžiantis tos pačios užklausos metu grąžinti susijusius resursus. FHIR spec.

_format

Grąžinamų duomenų formatas (xml arba json)

_sort

Rikiavimas pagal pasirinkta kriterijų

_count

Grąžinamų rezultatų kiekis

_offset

Puslapiavimas, įrašo nr, nuo kurio imami rezultatai

condition

Paieška pagal diagnozę naudojant diagnozės kodą.

encounter

Apsilankymo id

GET /fhir/ServiceRequest - paieška

Grąžinamas Bundle resursas, kuriame pateikiami užsakyti tyrimai pagal pateiktus paieškos kriterijus ir prieigos teises. Tai yra FHIR R5 search operacija ServiceRequest resursui.

Užklausos pavyzdžiai

  1. GET /fhir/ServiceRequest?requisition=9e137286-4fc5-4fc8-bbc9-97ca9b59054f&_include=ServiceRequest:requester&_include:iterate=PractitionerRole:practitioner&_include:iterate=PractitionerRole:organization

    Gauti ServiceRequest pagal nurodytą requisition, įtraukiant PractitionerRole resursus pagal ServiceRequest:requester nuorodą, įtraukiant Practitioner ir Organization resursus pagal PractitionerRole:practitioner ir PractitionerRole:organization nuorodas.

  2. GET /fhir/ServiceRequest?patient.identifier=http%3A%2F%2Fesveikata.lt%2FIdentifier%2FPersonalCode%7C234234523455

    Gauti ServiceRequest pagal paciento asmens kodą. Pavyzdyje naudojama identifikatoriaus parametro reikšmė yra http://esveikata.lt/Identifier/PersonalCode|234234523455.

  3. GET /fhir/ServiceRequest?status=active

    Gauti pateiktus ServiceRequest.

POST /fhir/ServiceRequest - naujo resurso pateikimas

Pateikiamas naujas ServiceRequest resursas. Tai yra FHIR R5 write operacija ServiceRequest resursui.

Užklausos pavyzdžiai

  1. POST užklausoje pateikiamas ServiceRequest resursas be resurso ID. Sėkmingos užklausos metu grąžinamas sukurtas ServiceRequest resursas su priskirtu ID ir jo versijos numeriu.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

GET /fhir/ServiceRequest/{id} - resurso informacijos gavimas pagal id

Gaunamas ServiceRequest resursas pagal pateiktą Elab posistemės ID. Tai yra FHIR R5 read operacija.

Užklausos pavyzdžiai

  1. GET /fhir/ServiceRequest/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų ServiceRequest resursą.
  2. Neradus resurso grąžinama HTTP 404 klaida su OperationOutcome, nurodančiu klaidos pranešimus.

PUT /fhir/ServiceRequest/{id} - esamo resurso atnaujinimas

Pateikiamas atnaujintas ServiceRequest resursas. Tai yra FHIR R5 update operacija ServiceRequest resursui.

Užklausos pavyzdžiai

  1. PUT užklausoje pateikiamas atnaujintas ServiceRequest resursas. Sėkmingos užklausos metu grąžinamas atnaujintas ServiceRequest resursas.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

Specimen

Paieškos parametrai

Pavadinimas Aprašymas

collected

Ėminio paėmimo data ir laikas

collector

Ėminį paėmusio specialisto įdarbinimas. (pagal PractitionerRole resurso id arba vieną iš PractitionerRole resurso paieškos parametrų)

identifier

Identifikatorius (įeina ir registracijos kodas)

patient

Pacientas iš kurio buvo paimtas ėminys (pagal id arba vieną iš paciento paieškos parametrų)

status

Statusas

type

Ėminio tipas

_include/_revinclude

Parametras leidžiantis tos pačios užklausos metu grąžinti susijusius resursus. FHIR spec.

_format

Grąžinamų duomenų formatas (xml arba json)

_sort

Rikiavimas pagal pasirinkta kriterijų

_count

Grąžinamų rezultatų kiekis

_offset

Puslapiavimas, įrašo nr, nuo kurio imami rezultatai

encounter

Apsilankymo id

request

Tyrimo užsakymas, pagal kurį paimtas ėminys (resurso id arba vienas iš ServiceRequest paeiškos parametrų)

receivedTime

Ėminio gavimo laboratorijoje laikas

receivedBy

Ėminį priėmęs specialistas (PractitionerRole id arba vienas iš PractitionerRole paieškos parametrų)

GET /fhir/Specimen - paieška

Grąžinamas Bundle resursas, kuriame pateikiami ėminiai pagal pateiktus paieškos kriterijus ir prieigos teises. Tai yra FHIR R5 search operacija Specimen resursui.

Užklausos pavyzdžiai

  1. GET /fhir/Specimen?type=6-765&subject.identifier=http%3A%2F%2Fesveikata.lt%2FIdentifier%2FPatient%2FESPBI%7C104345325&_offset=40&_count=10

    Gauti 10 paciento, kurio ESPBI Id yra 104345325, ėminių pagal ėminio tipą 6-765 imant ėminius nuo 40-ojo įrašo. Identifikatoriaus paieškos parametras yra šifruojamas HTTP URL formatu (angl. url encode). Pavyzdyje naudojama iššifruota reikšmė yra http://esveikata.lt/Identifier/Patient/ESPBI|104345325.

POST /fhir/Specimen - naujo resurso pateikimas

Pateikiamas naujas ėminys. Tai yra FHIR R5 write operacija Specimen resursui.

Užklausos pavyzdžiai

  1. POST užklausoje pateikiamas Specimen resursas be resurso ID. Sėkmingos užklausos metu grąžinamas sukurtas Specimen resursas su priskirtu ID ir jo versijos numeriu.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

GET /fhir/Specimen/{id} - resurso informacijos gavimas pagal id

Gaunamas Specimen resursas pagal pateiktą Elab posistemės ID. Tai yra FHIR R5 read operacija.

Užklausos pavyzdžiai

  1. GET /fhir/Specimen/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų Specimen resursą.
  2. Neradus resurso grąžinama HTTP 404 klaida su OperationOutcome, nurodančiu klaidos pranešimus.

PUT /fhir/Specimen/{id} - esamo resurso atnaujinimas

Pateikiamas atnaujintas Specimen resursas. Tai yra FHIR R5 update operacija Specimen resursui.

Užklausos pavyzdžiai

  1. PUT užklausoje pateikiamas atnaujintas Specimen resursas. Sėkmingos užklausos metu grąžinamas atnaujintas Specimen resursas.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

DiagnosticReport

Paieškos parametrai

Pavadinimas Aprašymas

based-on

Pagal užsakytą tyrimą (id arba vienas iš ServiceRequest paieškos parametrų)

date

Atsakymo gavimo data ir laikas

identifier

Identifikatorius

patient

Pacientas (id arba vienas iš Patient paieškos parametrų)

performer

Vykdytojo įdarbinimas. (pagal PractitionerRole resurso id arba vieną iš PractitionerRole resurso paieškos parametrų)

result

Nuoroda į tyrimo penelę/analitę (Observation id arba vienas iš Observation paieškos parametrų)

results-interpreter

Rezultatus tvirtinęs asmuo ir įstaiga (PractitionerRole id arba vienas iš PractitionerRole paieškos parametrų)

specimen

Nuoroda į ėminį (Specimen id arba vienas iš Specimen paieškos parametrų)

status

Statusas

_include/_revinclude

Parametras leidžiantis tos pačios užklausos metu grąžinti susijusius resursus. FHIR spec.

_format

Grąžinamų duomenų formatas (xml arba json)

_sort

Rikiavimas pagal pasirinkta kriterijų

_count

Grąžinamų rezultatų kiekis

_offset

Puslapiavimas, įrašo nr, nuo kurio imami rezultatai

encounter

Apsilankymo id

issued

Tvirtinimo data ir laikas

sensitive

Jautrus tyrimo atsakymas

GET /fhir/DiagnosticReport - paieška

Grąžinamas Bundle resursas, kuriame pateikiami atsakymo protokolai pagal pateiktus paieškos kriterijus ir prieigos teises. Tai yra FHIR R5 search operacija DiagnosticReport resursui.

Užklausos pavyzdžiai

  1. GET /fhir/DiagnosticReport?date=gt2023-09-02&based-on.code-concept=7-635&performer.organization:.identifier=http%3A%2F%2Fesveikata.lt%2FIdentifier%2FESPBI%7C2342343

    Gauti tyrimams su kodu 7-635 pateiktus atsakymo protokolus, pateiktus nuo 2023-09-02, kurie buvo atlikti ESPBI Id 2342343 turinčioje įstaigoje. Identifikatoriaus paieškos parametras yra šifruojamas HTTP URL formatu (angl. url encode). Pavyzdyje naudojama iššifruota reikšmė yra http://esveikata.lt/Identifier/ESPBI|2342343.

POST /fhir/DiagnosticReport - naujo resurso pateikimas

Pateikiamas naujas tyrimo protokolas. Tai yra FHIR R5 write operacija DiagnosticReport resursui.

Užklausos pavyzdžiai

  1. POST užklausoje pateikiamas DiagnosticReport resursas be resurso ID. Sėkmingos užklausos metu grąžinamas sukurtas DiagnosticReport resursas su priskirtu ID ir jo versijos numeriu.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

GET /fhir/DiagnosticReport/{id} - resurso informacijos gavimas pagal id

Gaunamas DiagnosticReport resursas pagal pateiktą Elab posistemės ID. Tai yra FHIR R5 read operacija.

Užklausos pavyzdžiai

  1. GET /fhir/DiagnosticReport/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų DiagnosticReport resursą.
  2. Neradus resurso grąžinama HTTP 404 klaida su OperationOutcome, nurodančiu klaidos pranešimus.

PUT /fhir/DiagnosticReport/{id} - esamo resurso atnaujinimas

Pateikiamas atnaujintas DiagnosticReport resursas. Tai yra FHIR R5 update operacija DiagnosticReport resursui.

Užklausos pavyzdžiai

  1. PUT užklausoje pateikiamas atnaujintas DiagnosticReport resursas. Sėkmingos užklausos metu grąžinamas atnaujintas DiagnosticReport resursas.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

Observation

Paieškos parametrai

Pavadinimas Aprašymas

category

Tyrimo grupė

code

Analitės/panelės kodas

date

Tyrimo data ir laikas

method

Taikytas analizės metodas

performer

Tyrimą atlikęs gydytojas ir įstaiga (PractitionerRole id arba vienas iš PractitionerRole paieškos parametrų)

status

Statusas

_include/_revinclude

Parametras leidžiantis tos pačios užklausos metu grąžinti susijusius resursus. FHIR spec.

_format

Grąžinamų duomenų formatas (xml arba json)

_sort

Rikiavimas pagal pasirinkta kriterijų

_count

Grąžinamų rezultatų kiekis

_offset

Puslapiavimas, įrašo nr, nuo kurio imami rezultatai

issued

Tvirtinimo data ir laikas

resultsInterpreter

Rezultatus tvirtinęs gydytojas ir įstaiga (PractitionerRole id arba vienas iš PractitionerRole paieškos parametrų)

GET /fhir/Observation - paieška

Grąžinamas Bundle resursas, kurį sudaro panalių ir analičių atsakymai pagal pateiktus paieškos kriterijus ir prieigos teises. Tai yra FHIR R5 search operacija Observation resursui.

Užklausos pavyzdžiai

  1. GET /fhir/Observation?date=gt2023-09-02&method=ELCH

    Gauti paneles ir analites kurių atlikimo metodo kodas yra ELCH pateiktus nuo 2023-09-02.

POST /fhir/Observation - naujo resurso pateikimas

Pateikiama nauja analitė arba panelė. Tai yra FHIR R5 write operacija Observation resursui. Kadangi tyrimų panelės yra sudaromos iš keleto ir daugiau Observation resursų, FHIR transakcija yra tinkamesnis būdas joms pateikti.

Užklausos pavyzdžiai

  1. POST užklausoje pateikiama panelė arba panelė be resurso ID. Sėkmingos užklausos metu grąžinamas sukurtas Observation resursas su priskirtu ID ir jo versijos numeriu.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

GET /fhir/Observation/{id} - resurso informacijos gavimas pagal id

Gaunamas Observation resursas pagal pateiktą Elab posistemės ID. Tai yra FHIR R5 read operacija.

Užklausos pavyzdžiai

  1. GET /fhir/Observation/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų Observation resursą.
  2. Neradus resurso grąžinama HTTP 404 klaida su OperationOutcome, nurodančiu klaidos pranešimus.

PUT /fhir/Observation/{id} - esamo resurso atnaujinimas

Pateikiamas atnaujintas Observation resursas. Tai yra FHIR R5 update operacija Observation resursui.

Užklausos pavyzdžiai

  1. PUT užklausoje pateikiamas atnaujintas Observation resursas. Sėkmingos užklausos metu grąžinamas atnaujintas Observation resursas.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

Composition

Paieškos parametrai

Pavadinimas Aprašymas

author

Dokumento autorius (PractitionerRole id arba vienas iš PractitionerRole paieškos parametrų)

date

Paskutinio pakeitimo data

identifier

Identifikatorius

patient

Pacientas (Patient id arba vienas iš Patient paieškos parametrų)

status

Statusas

_include/_revinclude

Parametras leidžiantis tos pačios užklausos metu grąžinti susijusius resursus. FHIR spec.

_format

Grąžinamų duomenų formatas (xml arba json)

_sort

Rikiavimas pagal pasirinkta kriterijų

_count

Grąžinamų rezultatų kiekis

_offset

Puslapiavimas, įrašo nr, nuo kurio imami rezultatai

encounter

Apsilankymo id

custodian

Dokumentą pateikusi įstaiga (Organization id arba vienas iš Organization paieškos parametrų)

GET /fhir/Composition - paieška

Grąžinamas Bundle resursas, kurį sudaro e200/a kompozicijos pagal pateiktus paieškos kriterijus ir prieigos teises. Tai yra FHIR R5 search operacija Composition resursui.

Užklausos pavyzdžiai

  1. GET /fhir/Composition?date=gt2023-09-02&status=final&patient.identifier=http%3A%2F%2Fesveikata.lt%2FIdentifier%2FPatient%2FESPBI%7C104345325

    Gauti su pacientu, kurio ESPBI Id 104345325, susijusias kompozicijas su galutiniu final statusu pateiktas nuo 2023-09-02. Identifikatoriaus paieškos parametras yra šifruojamas HTTP URL formatu (angl. url encode). Pavyzdyje naudojama iššifruota reikšmė yra http://esveikata.lt/Identifier/Patient/ESPBI|104345325.

POST /fhir/Composition - naujo resurso pateikimas

Pateikiama nauja kompozicija. Tai yra FHIR R5 write operacija Composition resursui.

Užklausos pavyzdžiai

  1. POST užklausoje pateikiamas Composition resursas be resurso ID. Sėkmingos užklausos metu grąžinamas sukurtas Composition resursas su priskirtu ID ir jo versijos numeriu.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

GET /fhir/Composition/{id} - resurso informacijos gavimas pagal id

Gaunamas Composition resursas pagal pateiktą Elab posistemės ID. Tai yra FHIR R5 read operacija.

Užklausos pavyzdžiai

  1. GET /fhir/Composition/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų Composition resursą.
  2. Neradus resurso grąžinama HTTP 404 klaida su OperationOutcome, nurodančiu klaidos pranešimus.

PUT /fhir/Composition/{id} - esamo resurso atnaujinimas

Pateikiamas atnaujintas Composition resursas. Tai yra FHIR R5 update operacija Composition resursui.

Užklausos pavyzdžiai

  1. PUT užklausoje pateikiamas atnaujintas Composition resursas. Sėkmingos užklausos metu grąžinamas atnaujintas Composition resursas.
  2. Nesėkmingos užklausos metu grąžinama HTTP 4xx/5xx klaida su OperationOutcome, nurodančiu klaidos pranešimus.

Patient paieškos parametrai

Pavadinimas Aprašymas

identifier

Identifikatorius (Pvz. asmens kodas, ESPBI ID, ESI id ir t.t.)

family

Pavardė

given

Vardas

gender

Lytis

PractitionerRole paieškos parametrai

Pavadinimas Aprašymas

identifier

Identifikatorius (Pvz. ESPBI Practitioner id, spaudo numeris ir t.t.)

organization

Padalinys (Organization id arba vienas iš Organization paieškos parametrų)

practitioner

Specialistas (Practitioner id arba vienas iš Practitioner paieškos parametrų)

role

Įstaigoje atliekama rolė (PractitionerRole.code)

Practitioner paieškos parametrai

Pavadinimas Aprašymas

identifier

Identifikatorius (Asmens kodas)

Organization paieškos parametrai

Pavadinimas Aprašymas

identifier

Identifikatorius (Pvz. ESPBI id, JAR kodas, SveidraID ir t.t.)

active

Ar įstaiga yra aktyvi

partof

Tėvinė įstaiga, kurios dalimi yra ši įstaiga (Organization id arba vienas iš Organization paieškos parametrų)