Dokumentacja API Statystyki NFZ - Refundacja Apteczna 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": [
        ...
    ]
}

provisions-data

Obiekt reprezentujący szczegóły wykonań refundacji apteczych

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

Właściwość Typ Opis
sums provisions-sums Sumy poszczególnych wartości
data array [provision] Lista wykonań refundacji aptecznych

provisions-sums

Obiekt reprezentujący sumy poszczególnych wartości wykonań refundacji aptecznych

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

Właściwość Typ Opis
quantity number Suma opakowań
refund number Suma refundacji NFZ
donation number Suma dotacji Ministerstwa Zdrowia w ramach programu 75+
contribution-of-patient number Suma kosztów pacjenta
value number Suma całkowitych kosztów produktów leczniczych

provision

Obiekt reprezentujący dane statystyczne dotyczące wykonanie refundacji aptecznej

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

Właściwość Typ Opis
type string Typ obiektu
attributes provision-attributes Lista atrybutów wykonania

provision-attributes

Szczegóły przedstawiające atrybuyty wykonania

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

Właściwość Typ Opis
medicine-product string Nazwa produktu leczniczego
international-name string Nazwa międzynarodowa produktu leczniczego
code string Kod EAN lub GETIN produktu leczniczego
dose string Informacje dotyczące dawki
pack string Informacje dotyczące opakowania
quantity number Ilość zrefundowanych opakowań
refund number Kwota refundacji NFZ
donation number Dotacja Ministerstwa Zdrowia w ramach programu 75+
contribution-of-patient number Dopłata pacjenta
value number Całkowity koszt produktu leczniczego; koszt refundacji NFZ + dopłata pacjenta + dotacja MZ (75+)

monthly-provision

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

Struktura monthly-provision 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
quantity number Ilość zrefundowanych opakowań
refund number Kwota refundacji NFZ
donation number Dotacja Ministerstwa Zdrowia w ramach programu 75+
contribution-of-patient number Dopłata pacjenta
value number Całkowity koszt produktu leczniczego; koszt refundacji NFZ + dopłata pacjenta + dotacja MZ (75+)

yearly-provision

Dane statystyczne dotyczące rocznego wykonania refundacji aptecznych

Struktura yearly-provision 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
quantity number Ilość zrefundowanych opakowań
refund number Kwota refundacji NFZ
donation number Dotacja Ministerstwa Zdrowia w ramach programu 75+
contribution-of-patient number Dopłata pacjenta
value number Całkowity koszt produktu leczniczego; koszt refundacji NFZ + dopłata pacjenta + dotacja MZ (75+)

atc

Opbiekt reprezentujący grupę ATC

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

Właściwość Typ Opis
type string Typ obiektu
attributes atc-attributes Lista atrybutów grupy ATC

atc-attributes

Atrybuty grupy ATC

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

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

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

atc

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

medicine-product

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

active-substance

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