Dokumentacja API Terminy Leczenia wersja 1.3

Schematy

Na wzór schema.org w API została wykorzystana metadana @context (dostępna w sekcji meta odpowiedzi na żądanie). Ponieważ specyfika danych prezentowanych w API jest na tyle zawiła, że nie mogliśmy wykorzystać gotowych schematów, przygotowaliśmy własne.

Celem poniższych schematów jest określenie kontekstu zwracanych danych. Przykładem problemu określenia znaczenia zwracanych danych jest rzeczownik kolejka, który bez kontekstu ma kilka znaczeń np. kolejka górska, kolejka wąskotorowa, kolejka do sklepu. Dzięki określeniu schematu w łatwy sposób można określić dokładne znaczenie zwracanych danych.

W tej sekcji dostępne są pliki json schema dla poszczególnych encji danych wraz z opisem. Zgodnie ze strukturą dane zwracane są w sekcji data. Pełna struktura dostępna jest również w formie pliku swagger.json. 

            
{
    "meta": {
        "@context": "string",
        "count": 0,
        "page": 0,
        "limit": 0
    },
    "links": {
        "first": "string",
        "prev": "string",
        "self": "string",
        "next": "string",
        "last": "string"
    },
    "data": [
        ...
    ]
}

queue

Szczegóły pierwszego wolnego terminu leczenia

Struktura queue dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
type string Typ obiektu
id string Unikalny identyfikator
attributes queue-attributes Lista atrybutów dla pierwszego wolnego terminu leczenia

queue-attributes

Szczegóły przedstawiające atrybuty pierwszego wolnego terminu leczenia

Struktura queue-attributes dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
case integer Kategoria medyczna, do której jest kwalifikowany pacjent na podstawie informacji m.in. o jego stanie zdrowia, chorobach współistniejących, rokowaniach co do dalszego przebiegu choroby, wykazywana najczęściej na skierowaniu. Przyjmuje wartości: 1 = przypadek stabilny (w innych przypadkach niż stan nagły i przypadek pilny), 2 = przypadek pilny (jeśli istnieje konieczność pilnego udzielenia świadczenia).
benefit string Nazwa świadczenia zdrowotnego (procedury medycznej, programu lekowego, świadczenia w poradni specjalistycznej, w oddziale szpitalnym, w pracowni diagnostycznej, w ośrodku opieki pozaszpitalnej), dla którego dany świadczeniodawca prowadzi listę oczekujących.
many-places string Znacznik wskazujący, czy świadczeniodawca udziela dane świadczenie zdrowotne w innych miejscach w ramach zawartej umowy z NFZ. Przyjmuje wartości: N = nie udziela świadczenia w innych miejscach, Y - udziela świadczenie w innych miejscach
provider string Nazwa świadczeniodawcy, który udziela dane świadczenie w ramach zawartej umowy z NFZ
provider-code string Kod świadczeniodawcy, który udziela dane świadczenie w ramach zawartej umowy z NFZ
regon-provider string Numer REGON świadczeniodawcy, który udziela dane świadczenie w ramach zawartej umowy z NFZ
nip-provider string Numer NIP świadczeniodawcy, który udziela dane świadczenie w ramach zawartej umowy z NFZ
teryt-provider string Kod TERYT świadczeniodawcy, który udziela dane świadczenie w ramach zawartej umowy z NFZ
place string Nazwa miejsca udzielania świadczeń w szpitalu/przychodni
address string Adres miejsca udzielania świadczeń w szpitalu/przychodni
locality string Miejscowość miejsca udzielania świadczeń w szpitalu/przychodni
phone string Telefon do miejsca udzielania świadczeń w szpitalu/przychodni
teryt-place string Kod TERYT miejsca udzielania świadczeń w szpitalu/przychodni
registry-number string Numer księgi rejestrowej
id-resort-part-VII string VII część kodu resortowego miejsca udzielania świadczeń
id-resort-part-VIII string VIII część kodu resortowego miejsca udzielania świadczeń
benefits-for-children string Znacznik wskazujący, czy w miejscu udzielania świadczeń udzielane są świadczenia dla dzieci. Przyjmuje wartości: N = nie, Y = tak
covid-19 string Znacznik wskazujący, czy świadczeniodawca zwolniony jest ze sprawozdawczości z powodu prowadzonia leczenia na COVID-19 w mjescu udzielania świadczeń. Przyjmuje wartości: N = nie, Y = tak
toilet string Znacznik wskazujący, czy w miejscu udzielania świadczeń znajduje się łazienka dla niepełnosprawnych. Przyjmuje wartości: N = nie, Y = tak
ramp string Znacznik wskazujący, czy w miejscu udzielania świadczeń znajduje się podjazd dla niepełnosprawnych. Przyjmuje wartości: N = nie, Y = tak
car-park string Znacznik wskazujący, czy przy miejscu udzielania świadczeń znajduje się parking. Przyjmuje wartości: N = nie, Y = tak
elevator string Znacznik wskazujący, czy w miejscu udzielania świadczeń znajduje się winda. Przyjmuje wartości: N = nie, Y = tak
latitude number Szerokość geograficzna miejsca udzielania świadczeń
longitude number Długość geograficzna miejsca udzielania świadczeń
statistics statistics Informacje statystyczne dotyczące listy oczekujących
dates first-available-date Daty pierwszego wolnego terminu leczenia
benefits-provided benefits-provided Szczegóły dot. liczby wykonań świadczeń

statistics

Informacje statystyczne dotyczące listy oczekujących

Struktura statistics dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
provider-data provider-data
computed-data computed-data

first-available-date

Daty pierwszego wolnego terminu leczenia

Struktura first-available-date dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
applicable boolean Wyróżnik określający czy dla świadczenia występuje pierwszy wolny termin
date string Data pierwszego wolnego terminu udzielenia świadczenia
date-situation-as-at string Data aktualizacji pierwszego wolnego terminu udzielenia świadczenia

benefits-provided

Informacje o ilosci wykonanych świadczeń

Struktura benefits-provided dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
type-of-benefit integer Typ świdczenia którgo dotyczy ilość wykonanych świadczeń 1 - świadczenia z zakresu endoprotezoplastyki
year integer Rok w którym ilość świadczeń została wykonana
amount integer Ilość wykonanych świadczeń

provider-data

Informacje statystyczne dostarczone przez świadczeniodawcę

Struktura provider-data dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
awaiting integer Liczba osób wpisanych na listę oczekujących na świadczenie zdrowotne wg stanu na koniec miesiąca. W liczbie tej nie uwzględniane są osoby kontynuujące leczenie oraz osoby z uprawnieniami do korzystania ze świadczeń poza kolejnością
removed integer Liczba osób skreślonych w ciągu miesiąca z listy oczekujących z powodu udzielenia świadczenia
average-period integer Średnia liczba dni oczekiwania na świadczenie zdrowotne. NULLABLE
update string Miesiąc aktualizacji danych dotyczących liczby osób wpisanych na listę oczekujących na świadczenie zdrowotne, liczby osób skreślonych w ciągu miesiąca z listy oczekujących z powodu udzielenia świadczenia oraz średniej liczby dni oczekiwania na świadczenie zdrowotne

computed-data

Informacje statystyczne obiczone i dostarczone przez NFZ

Struktura computed-data dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
average-period integer Średnia liczba dni oczekiwania na świadczenie zdrowotne. NULLABLE
update string Miesiąc aktualizacji danych dotyczących liczby osób wpisanych na listę oczekujących na świadczenie zdrowotne, liczby osób skreślonych w ciągu miesiąca z listy oczekujących z powodu udzielenia świadczenia oraz średniej liczby dni oczekiwania na świadczenie zdrowotne

error

Struktura error dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
id string
error-result string
error-reason string
error-solution string
error-help string
error-code integer

many-places

Szczegóły dotyczące wielu miejsc

Struktura many-places dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
type string Typ obiektu
attributes many-places-attributes Lista atrybutów dla miejsca

many-places-attributes

Szczegóły przestawiające atrybuty znacznika wskazującego, czy świadczeniodawca udziela dane świadczenie zdrowotne w innych miejscach w ramach zawartej umowy z NFZ

Struktura many-places-attributes dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
benefit string Nazwa świadczenia zdrowotnego (procedury medycznej, programu lekowego, świadczenia w poradni specjalistycznej, w oddziale szpitalnym, w pracowni diagnostycznej, w ośrodku opieki pozaszpitalnej), dla którego dany świadczeniodawca prowadzi listę oczekujących.
provider string Nazwa świadczeniodawcy, który udziela dane świadczenie w ramach zawartej umowy z NFZ
places array [many-places-queue] Lista terminów leczenia dla danego świadczeniodwcy w innych miejscach w ramach zawartej umowy z NFZ Schema: https://api.nfz.gov.pl/app-itl-api/schema/queue

many-places-queue

Szczegóły listy pierwszych wolnych terminów leczenia w innych miejscach dla wybranego świadczenia udzielanego przez konkretnego świadczeniodawcę

Struktura many-places-queue dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
id string Unikalny identyfikator
type string
attributes placeAttributes Atrybuty miejsca udzielania świadczeń

version-response

Szczegóły dotyczące wersji API

Struktura version-response dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
api-version api-version Określa numer wersji API

api-version

Szczegóły dotyczące wersji api

Struktura api-version dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
major integer Numer major wersji
minor integer Numer minor wersji
patch integer Numer patch wersji
date-mod string Data modifikacji zasobu
deprecated boolean Określa czy dana wersja jest przestarzała

error-response

Struktura zawierająca listę błędów, które wystąpiły w opowiedzi na zapytanie HTTP.

Struktura error-response dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis

error

Opis błędu, który wystąpił w odpowiedzi na zapytanie HTTP.

Struktura error dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis

version-response

Szczegółowy opis wersji API.

Struktura version-response dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis

api-version

Wersja API

Struktura api-version dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis

benefit

Uwaga! benefit jest to model słownikowy. Zwracany jest w postaci ciągu znaków (String) w sekcji data.

locality

Uwaga! locality jest to model słownikowy. Zwracany jest w postaci ciągu znaków (String) w sekcji data.

place

Uwaga! place jest to model słownikowy. Zwracany jest w postaci ciągu znaków (String) w sekcji data.

provider

Uwaga! provider jest to model słownikowy. Zwracany jest w postaci ciągu znaków (String) w sekcji data.

street

Uwaga! street jest to model słownikowy. Zwracany jest w postaci ciągu znaków (String) w sekcji data.