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

FHIR Resursų API

Bendros operacijos

• GET /fhir/{resource} – paieška (search)
• GET /fhir/{resource}/{id} – gavimas pagal id (read)
• POST /fhir/{resource} – naujo resurso sukūrimas (write)
• PUT /fhir/{resource}/{id} – resurso atnaujinimas (update)

Rekomenduojame visais atvejais resursus kurti ir redaguoti naudojant POST /fhir transakciją: Transakcijos API.

Paieška

Paieškos operacijos metu grąžinamas Bundle resursas, kuriame pateikiami rezultatai pagal nurodytus paieškos kriterijus ir prieigos teises. Galimi paieškos parametrai pateikiami prie kiekvieno endpointo atskirai.

ServiceRequest

Paieškos parametrai

GET /fhir/ServiceRequest - paieška

Grąžinamas Bundle resursas, kuriame pateikiami užsakyti tyrimai pagal pateiktus paieškos kriterijus ir prieigos teises.

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.

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.

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

Gaunamas ServiceRequest resursas pagal pateiktą Elab posistemės ID.

Užklausos pavyzdžiai

1. GET /fhir/ServiceRequest/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų ServiceRequest resursą.

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

Pateikiamas atnaujintas ServiceRequest resursas.

Užklausos pavyzdžiai

1. PUT užklausoje pateikiamas atnaujintas ServiceRequest resursas. Sėkmingos užklausos metu grąžinamas atnaujintas ServiceRequest resursas.

Specimen

Paieškos parametrai

GET /fhir/Specimen - paieška

Grąžinamas Bundle resursas, kuriame pateikiami ėminiai pagal pateiktus paieškos kriterijus ir prieigos teises.

Užklausos pavyzdžiai

1. GET fhir/Specimen?type=P&subject.identifier=http://esveikata.lt/Identifier/Patient/ESPBI|123456

   Gauti paciento, kurio ESPBI Id yra 123456, ėminius pagal ėminio tipą P. Identifikatoriaus paieškos parametras yra šifruojamas HTTP URL formatu (angl. url encode).

2. GET fhir/Specimen?subject=Patient/c7e6842e-1947-4e41-b285-bb6f000051cb&type=P

   Gauti paciento, kurio ELAB UUID identifikatorius yra c7e6842e-1947-4e41-b285-bb6f000051cb, ėminius pagal ėminio tipą P. Identifikatoriaus paieškos parametras yra šifruojamas HTTP URL formatu (angl. url encode).

3. GET fhir/Specimen?_id=c7e6842e-1947-4e41-b285-bb6f000051cb

   Gauti ėminį, kurio ELAB UUID identifikatorius yra c7e6842e-1947-4e41-b285-bb6f000051cb.

POST /fhir/Specimen - naujo resurso pateikimas

Pateikiamas naujas ėminys.

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.

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

Gaunamas Specimen resursas pagal pateiktą Elab posistemės ID.

Užklausos pavyzdžiai

1. GET /fhir/Specimen/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų Specimen resursą.

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

Pateikiamas atnaujintas Specimen resursas.

Užklausos pavyzdžiai

1. PUT užklausoje pateikiamas atnaujintas Specimen resursas. Sėkmingos užklausos metu grąžinamas atnaujintas Specimen resursas.

DiagnosticReport

Paieškos parametrai

GET /fhir/DiagnosticReport - paieška

Grąžinamas Bundle resursas, kuriame pateikiami atsakymo protokolai pagal pateiktus paieškos kriterijus ir prieigos teises.

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.

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.

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

Gaunamas DiagnosticReport resursas pagal pateiktą Elab posistemės ID.

Užklausos pavyzdžiai

1. GET /fhir/DiagnosticReport/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų DiagnosticReport resursą.

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

Pateikiamas atnaujintas DiagnosticReport resursas.

Užklausos pavyzdžiai

1. PUT užklausoje pateikiamas atnaujintas DiagnosticReport resursas. Sėkmingos užklausos metu grąžinamas atnaujintas DiagnosticReport resursas.

Observation

Paieškos parametrai

GET /fhir/Observation - paieška

Grąžinamas Bundle resursas, kurį sudaro panalių ir analičių atsakymai pagal pateiktus paieškos kriterijus ir prieigos teises.

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ė. 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.

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

Gaunamas Observation resursas pagal pateiktą Elab posistemės ID.

Užklausos pavyzdžiai

1. GET /fhir/Observation/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų Observation resursą.

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

Pateikiamas atnaujintas Observation resursas.

Užklausos pavyzdžiai

1. PUT užklausoje pateikiamas atnaujintas Observation resursas. Sėkmingos užklausos metu grąžinamas atnaujintas Observation resursas.

HealthcareService

Paieškos parametrai

GET /fhir/HealthcareService - paieška

Grąžinamas Bundle resursas, kuriame pateikiami įstaigų atliekami tyrimai pagal pateiktus paieškos kriterijus ir prieigos teises.

Užklausos pavyzdžiai

1. GET /fhir/HealthcareService?organization=Organization/86482a1f-4040-46a0-9d93-437529aca459&_count=15&_offset=2

   Gauti 15 nurodytos įstaigos atliekamus tyrimus, įmanant tyrimus nuo 2 įrašo.

2. GET /fhir/HealthcareService?organization=Organization/86482a1f-4040-46a0-9d93-437529aca459&_summary=count

   Gauti nurodytos įstaigos atliekamų tyrimų skaičių.

3. GET /fhir/HealthcareService?service-type=XLT00229-8

   Gauti tyrimus pagal tyrimo kodą.

Composition

Paieškos parametrai

GET /fhir/Composition - paieška

Grąžinamas Bundle resursas, kurį sudaro e200/a kompozicijos pagal pateiktus paieškos kriterijus ir prieigos teises.

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.

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.

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

Gaunamas Composition resursas pagal pateiktą Elab posistemės ID.

Užklausos pavyzdžiai

1. ​GET /fhir/Composition/24c3c782-96e1-4cfa-8d8e-879f304b2627 egzistuojančio resurso atveju grąžintų Composition resursą.

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

Pateikiamas atnaujintas Composition resursas.

Užklausos pavyzdžiai

1. ​PUT užklausoje pateikiamas atnaujintas Composition resursas. Sėkmingos užklausos metu grąžinamas atnaujintas Composition resursas.

Composition pasirašymas

Pasirašymo būdai aprašyti skyriuje Dokumentų pasirašymas.

PractitionerRole paieškos parametrai

Practitioner paieškos parametrai

Organization paieškos parametrai

DocumentReference paieškos parametrai

GET /fhir/DocumentReference - paieška

Grąžinamas Bundle resursas, kuriame pateikiami dokumentų nuorodos pagal pateiktus paieškos kriterijus ir prieigos teises.

Užklausos pavyzdžiai

1. GET /fhir/DocumentReference?date=gt2025-01-20&_offset=40&_count=10

   Gauti 10 dokumentų nuorodų, sukurtų vėliau nei 2025-01-20 imant dokumentų nuorodas nuo 40-ojo įrašo.

GET /fhir/DocumentReference/$get-pdf-document?compositionId={compositionId} - dokumento turinio gavimas pagal composition id

Atsakymo pavyzdžiai

Gaunamas Parameters resursas su dokumento turiniu.

Gaunamas atsakymas su šiomis reikšmėmis:

• documentReference - Nuoroda į FHIR sistemoje sukurtą DocumentReference resursą
• fileName - Failo pavadinimas
• data - Dokumento turinys užkoduotas Base64 formatu

Pavyzdys:

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "documentReference",
            "valueId": "DocumentReference/5e61540a-e664-494b-b94b-1b7769efdbb4/_history/1"
        },
        {
            "name": "fileName",
            "valueString": "e200-0b3c783e-1f04-496d-8cf1-57f15368d8bc.pdf"
        },
        {
            "name": "data",
            "valueString": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3VyYWJpdHVyIGVnZXQgYmxhbmRpdCBhbnRlLiBTZWQgYSBkaWFtIHZlbCBzZW0gZmFjaWxpc2lzIGltcGVyZGlldC4gTnVuYyBuZWMgdG9ydG9yIG5lYyBzYXBpZW4gYWxpcXVldCBncmF2aWRhIGV1IG5vbiB2ZWxpdC4gRHVpcyBmZXJtZW50dW0gc29kYWxlcyByaG9uY3VzLiBDcmFzIHZlbCBtZXR1cyBhbGlxdWFtLCBwdWx2aW5hciBvcmNpIHNhZ2l0dGlzLCBncmF2aWRhIG51bGxhLiBPcmNpIHZhcml1cyBuYXRvcXVlIHBlbmF0aWJ1cyBldCBtYWduaXMgZGlzIHBhcnR1cmllbnQgbW9udGVzLCBuYXNjZXR1ciByaWRpY3VsdXMgbXVzLg=="
        }
    ]
}

POST /fhir/DocumentReference/$upload-pdf-document - pasirašyto dokumento įkėlimas

Užklausos pavyzdžiai

Siunčiamas Parameters resursas su dokumento turiniu.

Gaunamas atsakymas su šiomis reikšmėmis:

• compositionId - Composition resurso id
• data - Dokumento turinys užkoduotas Base64 formatu

Pavyzdys:

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "compositionId",
            "valueId": "3b79ecf2-645a-4754-92cd-5cf1e220103e"
        },
        {
            "name": "data",
            "valueString": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gQ3VyYWJpdHVyIGVnZXQgYmxhbmRpdCBhbnRlLiBTZWQgYSBkaWFtIHZlbCBzZW0gZmFjaWxpc2lzIGltcGVyZGlldC4gTnVuYyBuZWMgdG9ydG9yIG5lYyBzYXBpZW4gYWxpcXVldCBncmF2aWRhIGV1IG5vbiB2ZWxpdC4gRHVpcyBmZXJtZW50dW0gc29kYWxlcyByaG9uY3VzLiBDcmFzIHZlbCBtZXR1cyBhbGlxdWFtLCBwdWx2aW5hciBvcmNpIHNhZ2l0dGlzLCBncmF2aWRhIG51bGxhLiBPcmNpIHZhcml1cyBuYXRvcXVlIHBlbmF0aWJ1cyBldCBtYWduaXMgZGlzIHBhcnR1cmllbnQgbW9udGVzLCBuYXNjZXR1ciByaWRpY3VsdXMgbXVzLg=="
        }
    ]
}

CodeSystem

Paieška aprašyta skyriuje Nomenklatūros ir klasifikatoriai.

Patient paieškos parametrai

GET /fhir/Patient - paieška

Užklausos pavyzdžiai

1. GET /fhir/Patient?identifier=http://esveikata.lt/Identifier/PersonalCode|{patient_personal_code}

   Gauti paciento duomenis pagal paciento asmens kodą.

2. GET /fhir/Patient?identifier=http://esveikata.lt/Identifier/Patient/ESI|{patient_esi}

   Gauti paciento duomenis pagal paciento ESI numerį.

3. GET /fhir/Patient?identifier=http://esveikata.lt/Identifier/Patient/ESPBI|{patient_espbi_id}

   Gauti paciento duomenis pagal paciento ESPBI FHIR ID.

4. GET /fhir/Patient?_id={patient_elab_uuid}

   Gauti pacientą pagal ELAB UUID.