1f

Dokumentacja API Statystyki NFZ - Świadczenia wersja 1.0


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": [
        ...
    ]
}
            
        

index-of-tables

Obiekt reprezentujący indeks (listę) wszystkich dostępnych tabel statystycznych

Struktura index-of-tables dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
type string Typ obiektu
attributes index-attributes Lista atrybutów ineksu tabel statystycznych
            
            
        

index-attributes

Szczegóły przedstawiające atrybuyty indeksu tabel statystycznych

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

Właściwość Typ Opis
product-code string Kod produktu
product-name string Nazwa produktu
years array [index-year] Agregat tabel statystycznych dla konkretnego roku
            
            
        

index-year

Agregat tabel statystycznych dla konkretnego roku

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

Właściwość Typ Opis
year integer Rok zebranych danych statystycznych
tables array [table] Lista dostępnych tabel statystycznych za cały rok
periods array [period] Okresy niepełnego roku dla którego występują tabele statystyczne
            
            
        

table

Tabela statystyczna

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

Właściwość Typ Opis
id string Unikalny identyfikator. Potrzebny w celu wyświetlenia tabeli poprzez wywołanie odpowiedniej metody
type string Typ obiektu
attributes table-attributes Lista atrybutów tabeli statystycznej
links baseLinks Linki do zasobów
            
            
        

period

Okres dla którego dostępne są tabele statystyczne

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

Właściwość Typ Opis
date-from string Data początku okresu
date-to string Data końca okresu
tables array [table] Lista dostępnych tabel statystycznych w okresie
            
            
        

table-attributes

Szczegóły przedstawiające atrybuty tabeli statystycznej

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

Właściwość Typ Opis
header string Tytuł tabeli
resource-name string Nazwa zasobu zawierającego szczegóły
additional-infromation additional-information Dodatkowe informacje
            
            
        

additional-information

Dodatkowe informacje na temat tabeli statystycznej

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

Właściwość Typ Opis
divided-by-branches boolean Znacznik określający czy tabela jest podzilona na Oddziały Wojewódzkie NFZ
divided-by-hospital-types boolean Znacznik określający czy tabela jest podzilona na typy szpitali
divided-by-products boolean Znacznik określający czy tabela jest podzilona na rodzaj produktu
            
            
        

basic-data

Obiekt reprezentujący tabele statystyczną dotyczącą podstawowych danych o hospitalizacji

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes basic-data-attributes Lista atrybutów tabeli statystycznej
            
            
        

basic-data-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [basic-data-values] Podstawowe dane statystyczne
            
            
        

basic-data-values

Szczegóły tabeli statystycznej danych podstawowych

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

Właściwość Typ Opis
branch string Oddział wojewódzki - występuje tylko jeśli dane są rozbite na OW 01 – Dolnośląski 02 – Kujawsko-Pomorski 03 – Lubelski 04 – Lubuski 05 - Łódzki 06 – Małopolski 07 – Mazowiecki 08 – Opolski 09 – Podkarpacki 10 – Podlaski 11 – Pomorski 12 – Śląski 13 – Świętokrzyski 14 – Warmińsko-mazurski 15 – Wielkopolski 16 – Zachodniopomorski
hospital-types string Typ szpitala - występuje tylko jeśli dane są rozbite na OW 1 - gminny, powiatowy, miejski 2 - niepubliczny 3 - kliniczny 4 - wojewódzki 5 - inny
number-of-patients integer Liczba pacjentów
number-of-hospitalizations integer Liczba hospitalizacji
ratio-of-rehospitalizations number Współczynnik rehospitalizacji
percentage number Udział hospitalizacji (%)
percentage-of-sections number Udział hospitalizacji w sekcji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
duration-of-hospitalization-mode integer Dominanta czasu pobytu
average-value-of-hospitalization number Średnia wartość hospitalizacji (zł)
average-value-of-hospitalization-points number Średnia wartość jednostek hospitalizacji (pkt)
average-value-of-drg number Średnia wartość grupy (zł)
average-value-of-drg-points number Średnia wartość jednostek grupy (pkt)
            
            
        

gender

Obiekt reprezentujący tabele statystyczną dotyczącą hospitalizacji w podziale na płeć pacjenta

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes gender-attributes Lista atrybutów tabeli statystycznej
            
            
        

gender-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [hospitalization-by-patient-gender] Dane statystyczne
            
            
        

hospitalization-by-patient-gender

Dane statystyczne dotyczące hospitalizacji w podziale na płeć pacjenta

Struktura hospitalization-by-patient-gender dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
branch string Oddział wojewódzki - występuje tylko jeśli dane są rozbite na OW 01: Dolnośląski 02: Kujawsko-Pomorski 03: Lubelski 04: Lubuski 05 - Łódzki 06: Małopolski 07: Mazowiecki 08: Opolski 09: Podkarpacki 10: Podlaski 11: Pomorski 12: Śląski 13: Świętokrzyski 14: Warmińsko-mazurski 15: Wielkopolski 16: Zachodniopomorski
hospital-types string Typ szpitala - występuje tylko jeśli dane są rozbite na OW 1: gminny, powiatowy, miejski 2: niepubliczny 3: kliniczny 4: wojewódzki 5: inny
gender-code integer Kod płci 0 płeć nieokreślona 1: mężczyzna 2: kobieta 9: nieznana
gender-name string Nazwa płci
number-of-hospitalizations integer Liczba hospitalizacji
percentage number Udział hospitalizacji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
            
            
        

admission-type

Obiekt reprezentujący tabele statystyczną dotyczącą hospitalizacji w podziale na tryb przyjęcia pacjenta

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes admission-type-attributes Lista atrybutów tabeli statystycznej
            
            
        

admission-type-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [hospitalization-by-patient-admission-type] Dane statystyczne
            
            
        

hospitalization-by-patient-admission-type

Dane statystyczne dotyczące hospitalizacji dla trybu przyjęcia pacjenta

Struktura hospitalization-by-patient-admission-type dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
branch string Oddział wojewódzki - występuje tylko jeśli dane są rozbite na OW 01: Dolnośląski 02: Kujawsko-Pomorski 03: Lubelski 04: Lubuski 05 - Łódzki 06: Małopolski 07: Mazowiecki 08: Opolski 09: Podkarpacki 10: Podlaski 11: Pomorski 12: Śląski 13: Świętokrzyski 14: Warmińsko-mazurski 15: Wielkopolski 16: Zachodniopomorski
hospital-types string Typ szpitala - występuje tylko jeśli dane są rozbite na OW 1: gminny, powiatowy, miejski 2: niepubliczny 3: kliniczny 4: wojewódzki 5: inny
type-of-admission-code integer Kod trybu przyjęcia pacjenta
type-of-admission-name string Nazwa trybu przyjęcia pacjenta
number-of-hospitalizations integer Liczba hospitalizacji
percentage number Udział hospitalizacji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
            
            
        

discharge-type

Obiekt reprezentujący tabele statystyczną dotyczącą hospitalizacji w podziale na tryb wypisu pacjenta

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes discharge-type-attributes Lista atrybutów tabeli statystycznej
            
            
        

discharge-type-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [hospitalization-by-discharge-type] Dane statystyczne
            
            
        

hospitalization-by-discharge-type

Dane statystyczne dotyczące hospitalizacji dla na trybu wypisu pacjenta

Struktura hospitalization-by-discharge-type dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
branch string Oddział wojewódzki - występuje tylko jeśli dane są rozbite na OW 01: Dolnośląski 02: Kujawsko-Pomorski 03: Lubelski 04: Lubuski 05 - Łódzki 06: Małopolski 07: Mazowiecki 08: Opolski 09: Podkarpacki 10: Podlaski 11: Pomorski 12: Śląski 13: Świętokrzyski 14: Warmińsko-mazurski 15: Wielkopolski 16: Zachodniopomorski
hospital-types string Typ szpitala - występuje tylko jeśli dane są rozbite na OW 1: gminny, powiatowy, miejski 2: niepubliczny 3: kliniczny 4: wojewódzki 5: inny
type-of-discharge-code integer Kod trybu wypisu
type-of-discharge-name string Nazwa trybu wypisu
number-of-hospitalizations integer Liczba hospitalizacji
percentage number Udział hospitalizacji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
            
            
        

age

Obiekt reprezentujący tabele statystyczną dotyczącą hospitalizacji w podziale na wiek pacjenta

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes age-attributes Lista atrybutów tabeli statystycznej
            
            
        

age-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [hospitalization-by-patient-age] Dane statystyczne
            
            
        

hospitalization-by-patient-age

Dane statystyczne dotyczące hospitalizacji dla grupy wiekowe pacjenta

Struktura hospitalization-by-patient-age dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
branch string Oddział wojewódzki - występuje tylko jeśli dane są rozbite na OW 01: Dolnośląski 02: Kujawsko-Pomorski 03: Lubelski 04: Lubuski 05 - Łódzki 06: Małopolski 07: Mazowiecki 08: Opolski 09: Podkarpacki 10: Podlaski 11: Pomorski 12: Śląski 13: Świętokrzyski 14: Warmińsko-mazurski 15: Wielkopolski 16: Zachodniopomorski
hospital-types string Typ szpitala - występuje tylko jeśli dane są rozbite na OW 1: gminny, powiatowy, miejski 2: niepubliczny 3: kliniczny 4: wojewódzki 5: inny
age-group-code integer Kod grupy wiekowej 1: poniżej 1 2: 1 - 6 3: 7 - 17 4: 18 - 40 5: 41 - 60 6: 61 - 80 7: 81 i więcej 8: brak danych
age-group-name string Nazwa grupy wiekowej
number-of-hospitalizations integer Liczba hospitalizacji
percentage number Udział hospitalizacji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
            
            
        

contract-product

Obiekt reprezentujący tabele statystyczną dotyczącą hospitalizacji w podziale na zakres świadczeń

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes contract-product-attributes Lista atrybutów tabeli statystycznej
            
            
        

contract-product-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [hospitalization-by-healthcare-services] Dane statystyczne
            
            
        

hospitalization-by-healthcare-services

Dane statystyczne dotyczące hospitalizacji dla zakresu świadczeń

Struktura hospitalization-by-healthcare-services dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
branch string Oddział wojewódzki - występuje tylko jeśli dane są rozbite na OW 01: Dolnośląski 02: Kujawsko-Pomorski 03: Lubelski 04: Lubuski 05 - Łódzki 06: Małopolski 07: Mazowiecki 08: Opolski 09: Podkarpacki 10: Podlaski 11: Pomorski 12: Śląski 13: Świętokrzyski 14: Warmińsko-mazurski 15: Wielkopolski 16: Zachodniopomorski
hospital-types string Typ szpitala - występuje tylko jeśli dane są rozbite na OW 1: gminny, powiatowy, miejski 2: niepubliczny 3: kliniczny 4: wojewódzki 5: inny
contract-product-code integer Kod zakresu świadczeń
contract-product-name string Nazwa zakresu świadczeń
number-of-hospitalizations integer Liczba hospitalizacji
percentage number Udział hospitalizacji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
            
            
        

product-category

Obiekt reprezentujący tabele statystyczną dotyczącą hospitalizacji w podziale na płeć pacjenta

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes product-category-attributes Lista atrybutów tabeli statystycznej
            
            
        

product-category-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [product-category-nfz-categorized] Dane statystyczne
            
            
        

histogram

Obiekt reprezentujący histogram czasu pobytu

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes histogram-attributes Lista atrybutów histogramu
            
            
        

histogram-attributes

Szczegóły przedstawiające atrybuyty histogramu

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod grupy
name string Nazwa grupy
header string Tytuł tabeli statystycznej
data array [histogram-values] Dane histogramu
            
            
        

histogram-values

Dane statystyczne dotyczące hospitalizacji dla trybu przyjęcia pacjenta

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

Właściwość Typ Opis
branch string Oddział wojewódzki - występuje tylko jeśli dane są rozbite na OW 01: Dolnośląski 02: Kujawsko-Pomorski 03: Lubelski 04: Lubuski 05 - Łódzki 06: Małopolski 07: Mazowiecki 08: Opolski 09: Podkarpacki 10: Podlaski 11: Pomorski 12: Śląski 13: Świętokrzyski 14: Warmińsko-mazurski 15: Wielkopolski 16: Zachodniopomorski
hospital-types string Typ szpitala - występuje tylko jeśli dane są rozbite na OW 1: gminny, powiatowy, miejski 2: niepubliczny 3: kliniczny 4: wojewódzki 5: inny
contract-product-code string ?
contract-product-name string Kod produktu
points array [histogram-point] Punkty na hisotgramie
            
            
        

histogram-point

Obiekt reprezentujący punkty na histogramie

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

Właściwość Typ Opis
x integer x - czas pobytu
y integer y - ilość hospitalizacji
            
            
        

icd-procedure

Obiekt reprezentujący tabele statystyczną dotyczącą procedur ICD

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes icd-procedure-attributes Lista atrybutów tabeli statystycznej
            
            
        

icd-procedure-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [procedure] Dane statystyczne
            
            
        

procedure

Dane statystyczne dotyczące procedury ICD

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

Właściwość Typ Opis
procedure-code string Kod procedury
procedure-name string Nazwa procedury
number-of-hospitalizations integer Liczba hospitalizacji
percentage number Udział hospitalizacji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
            
            
        

icd-disease

Obiekt reprezentujący tabele statystyczną dotyczącą rozpoznań ICD

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

Właściwość Typ Opis
id string Unikalny identyfikator tabeli statystycznej
type string Typ obiektu
attributes icd-disease-attributes Lista atrybutów tabeli statystycznej
            
            
        

icd-disease-attributes

Szczegóły przedstawiające atrybuyty tabeli statystycznej

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

Właściwość Typ Opis
year integer Rok którego dotyczą dane
code string Kod świadczenia
name string Nazwa świadczenia
header string Tytuł tabeli statystycznej
data array [disease] Dane statystyczne
            
            
        

disease

Dane statystyczne dotyczące rozpoznania ICD

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

Właściwość Typ Opis
disease-code string Kod rozpoznania
disease-name string Nazwa rozpoznania
number-of-hospitalizations integer Liczba hospitalizacji
percentage number Udział hospitalizacji (%)
duration-of-hospitalization-mediana integer Mediana czasu pobytu
            
            
        

benefit

Szczegóły świadczenia zwracanego ze słownika

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

Właściwość Typ Opis
code string Kod świadczenia
name string Nazwa świadczenia
            
            
        

section

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