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

drug-costs-by-drug-program-data

Obiekt reprezentujący szczegóły kosztów leków w programach lekowych

Struktura drug-costs-by-drug-program-data dostępna jest także w SwaggerUI oraz w pliku json schema.

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

drug-costs-by-drug-program

Koszty leków w podziale na program lekowy

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

Właściwość Typ Opis
drug-program-code string Kod programu lekowego
drug-program-mz-code string Kod programu lekowego wg. rozporządzenia Ministra Zdrowia
drug-program-name string Nazwa programu lekowego
number-of-patients integer Liczba pacjentów w programie lokowym
refund number Refundacja NFZ
            
            
        

drug-costs-by-active-substance-data

Obiekt reprezentujący szczegóły kosztów leków w programach lekowych w podziale na substancje czynne

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

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

drug-costs-by-active-substance

Koszty leków w podziale na substancje czynną

Struktura drug-costs-by-active-substance 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
            
            
        

drug-costs-by-drug-program-and-active-substance-data

Obiekt reprezentujący szczegóły kosztów leków w programach lekowych w podziale na substancje czynne

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

Właściwość Typ Opis
sums sums Obiekt podsumowania
data array [drug-costs-by-drug-program-and-active-substance] Lista .......
            
            
        

drug-costs-by-drug-program-and-active-substance

Koszty leków w podziale na program lekowy i substancje czynną

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

Właściwość Typ Opis
drug-program-code string Kod programu lekowego
drug-program-mz-code string Kod programu lekowego wg. rozporządzenia Ministra Zdrowia
drug-program-name string Nazwa programu lekowego
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
            
            
        

drug-costs-by-gender-data

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

Struktura drug-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 [drug-costs-by-gender] Lista substancji czynnych stosowanych w programach lekowych
            
            
        

drug-costs-by-gender

Koszty leków w podziale na grupy wiekowe

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

Właściwość Typ Opis
drug-program-code string Kod programu lekowego
drug-program-mz-code string Kod programu lekowego wg. rozporządzenia Ministra Zdrowia
drug-program-name string Nazwa programu lekowego
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
            
            
        

drug-costs-by-age-group-data

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

Struktura drug-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 [drug-costs-by-age-group] Lista substancji czynnych stosowanych w programach lekowych
            
            
        

drug-costs-by-age-group

Koszty leków w podziale na grupy wiekowe

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

Właściwość Typ Opis
drug-program-code string Kod programu lekowego
drug-program-mz-code string Kod programu lekowego wg. rozporządzenia Ministra Zdrowia
drug-program-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 kwoty refundacji NFZ i licznby pacjentów 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

Obiekt reprezentujący dane statystyczne dotyczące kwoty refundacji NFZ i licznby pacjentów w podziale na lata

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
            
            
        

drug-programs

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

active-substances

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