Dokumentacja API Statystyki NFZ - Leki w Chemioterapii 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": [
        ...
    ]
}

active-substance-costs-data

Obiekt reprezentujący szczegóły kosztów leków substancji czynnych w chemioterapii

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

Właściwość Typ Opis
sums sums Obiekt podsumowania
data array [active-substance-costs] Lista substancji czynnych stosowanych w chemioterapii

active-substance-costs

Koszty leków w podziale na substancje czynną

Struktura active-substance-costs dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
active-substance-code string Kod substancji czynnej
active-substance-name string Nazwa substancji czynnej
number-of-patients integer Liczba pacjentów
refund number Refundacja NFZ

active-substance-costs-by-gender-data

Obiekt reprezentujący szczegóły kosztów leków w chemioterapii w podziale na płeć pacjenta

Struktura active-substance-costs-by-gender-data dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
sums sums Obiekt podsumowania
data array [active-substance-costs-by-gender] Lista substancji czynnych stosowanych w programach lekowych

active-substance-costs-by-gender

Koszty substancji czynnych w podziale na grupy wiekowe

Struktura active-substance-costs-by-gender dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
active-substance-code string Kod substancji czynnej
active-substance-name string Nazwa substancji czynnej
gender-code integer Kod płci pacjenta
gender-name string Nazwa płci pacjenta
number-of-patients integer Liczba pacjentów
refund number Koszt refundacji

active-substance-costs-by-age-group-data

Obiekt reprezentujący szczegóły kosztów leków w programach lekowych w podziale na grupy wiekowe

Struktura active-substance-costs-by-age-group-data dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
sums sums Obiekt podsumowania
data array [active-substance-costs-by-age-group] Lista substancji czynnych stosowanych w programach lekowych

active-substance-costs-by-age-group

Koszty substnacji czynnych w podziale na grupy wiekowe

Struktura active-substance-costs-by-age-group dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
active-substance-code string Kod substancji czynnej
active-substance-name string Nazwa programu lekowego
age-group-code integer Kod grupy wiekowej
age-group-name string Nazwa grupy wiekowej
number-of-patients integer Liczba pacjentów
refund number Kwota refundacji

monthly-costs

Obiekt reprezentujący dane statystyczne dotyczące wykonań refundacji aptecznych w podziale na miesiące ????????

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

Właściwość Typ Opis
year integer Miesiąc w którym dokonano refundacji
month integer Miesiąc w którym dokonano refundacji
number-of-patients integer Liczba pacjentów
refund number Kwota refundacji NFZ

yearly-costs

Dane statystyczne dotyczące rocznego wykonania refundacji aptecznych ???????????????

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

Właściwość Typ Opis
year integer Miesiąc w którym dokonano refundacji
refund number Kwota refundacji NFZ
number-of-patients integer Liczba pacjentów

available-periods

Obiekt reprezentujący dostępne zakresy dat dla których dostepne są dane statystyczne dotyczące wykonań refundacji aptecznych

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

Właściwość Typ Opis
start-date string Minimalna data dla dostępnych danych statystycznych
end-date string Maksymalna data dla dostępnych danych statystycznych

active-substances

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