Dokumentacja API Umowy NFZ wersja 1.2

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

agreement-plan-month-data

Szczególy umowy

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

Właściwość Typ Opis
header agreement-month-header Nagłówek odpowiedzi
month agreement-plan-month Miesiąc w planie umowy
packages array [agreement-package] Lista pakietów w miesiącu umowy

agreement-month-header

Nagłówek odpowiedzi planu umowy w rozbicu na miesiące

Struktura agreement-month-header dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
year integer Rok
branch string Oddział wojewódzki
provider-code string Kod świadczeniodawcy
provider-name string Nazwa świadczeniodawcy
order string Wyróżnik
agreement-code string Kod umowy
service-type-name string Nazwa rodzaju świadczenia
contract-product-code string Produkt kontraktowy

agreement-plan-month

Szczegóły planu umowy w rozbiciu na miesiąc

Struktura agreement-plan-month dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
id string Identyfikator miesiąca
type string Typ obiektu
attributes agreement-plan-month-attributes Atrybuty miesiąca
links base-links Linki

agreement-package

Szczegóły pakietu umowy

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

Właściwość Typ Opis
type string Typ obiektu
attributes agreement-package-attributes Atrybuty miesiąca

agreement-plan-month-attributes

Atrybuty miesiąca w planie umowy

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

Właściwość Typ Opis
unit-count number Sumaryczna liczba kontraktu dla produktu
month integer Miesiąc
price number Sumaryczna kwota kontraktu dla produktu
avg-price number Średnia cena produktu
packages-type string Typ pakietów

agreement-package-attributes

Atrybuty pakietu umowy

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

Właściwość Typ Opis
unit-product-code string Kod produktu kontraktowego
unit-product-name string Nazwa produktu kontraktowego
weight number Waga efektywna

agreement-plan-data

Szczególy umowy

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

Właściwość Typ Opis
header agreement-plan-header Nagłówek odpowiedzi
agreement-plan agreement-plan Umowa
months array [agreement-plan-month] Lista planów umowy

agreement-plan-header

Nagłówek planu umowy

Struktura agreement-plan-header dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
year integer Rok
branch string Oddział wojewódzki
provider-code string Kod świadczeniodawcy
provider-name string Nazwa świadczeniodawcy
agreement-code string Kod umowy
service-type-name string Nazwa rodzaju świadczenia

agreement-plan

Szczegóły planu umowy

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

Właściwość Typ Opis
id string Identyfikator umowy
type string Typ obiektu
attributes agreement-plan-attributes Atrybuty planu umowy
links base-links Linki

agreement-plan-attributes

Atrybuty planu umowy

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

Właściwość Typ Opis
product-code string Kod produktu kontraktowego
product-name string Nazwa produktu kontraktowego
order integer Wyróżnik produktu w planie umowy
unit-count number Sumaryczna liczba kontraktu dla produktu
price number Sumaryczna kwota kontraktu dla produktu
avg-price number Średnia cena produktu
date-from string Data początku obowiązywania produktu kontraktowego w planie umowy
date-to string Data końca obowiązywania produktu kontraktowego w planie umowy

agreement-list-data

Dane dotyczące listy umów

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

Właściwość Typ Opis
agreements array [agreement] Lista umów

agreement

Szczegóły umowy podpisanej ze świadczeniodawcą

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

Właściwość Typ Opis
id string Identyfikator umowy
type string Typ obiektu
attributes agreement-attributes Atrybuty umowy
links base-links Linki

agreement-attributes

Atrybuty umowy

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

Właściwość Typ Opis
code string Kod umowy
technical-code string Techniczny kod umowy przekazywany w ramach UMX, używany w ramach wymiany danych z NFZ
origin-code string Kod pierwotny umowy
service-type string Rodzaj świadczenia
service-name string Nazwa rodzaju świadczenia
amount number Kwota
updated-at string Data aktualizacji danych w centrali
provider-code string Kod świadczeniodawcy
provider-nip string Numer NIP
provider-regon string Numer REGON
provider-registry-number string Numer księgi rejestrowej
provider-name string Nazwa świadczeniodawcy
provider-place string Miejscowość świadczeniodawcy
year integer Rok
branch string Oddział świadczeniodawcy

agreement-data

Szczególy umowy

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

Właściwość Typ Opis
agreement agreement Umowa
plans array [agreement-plan] Lista planów umowy
orthopedic-supplies array [orthopedic-supply] Lista środków ortopedycznych

available-year

Dostępny minimalny i maksymalny rok za który dostępne są dane

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

Właściwość Typ Opis
start-year integer Rok początkowy
end-year integer Rok końcowy

dictionary-entry-list-data

Dane dotyczące listy pozycji ze słownika

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

Właściwość Typ Opis
entries array [dictionary-entry] Lista pozycji ze słownika

dictionary-entry

Pozycja słownikowa

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

Właściwość Typ Opis
type string Typ obiektu
attributes dictionary-entry-attributes Atrybuty pozycji słownikowej

dictionary-entry-attributes

Atrybuty pozycji słownikowej

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

Właściwość Typ Opis
code string Kod pozycji
name string Nazwa pozycji
year integer Rok

dictionary-provider-entry-list-data

Dane dotyczące listy pozycji ze słownika śwadczeniodawców

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

Właściwość Typ Opis
entries array [dictionary-provider-entry] Lista pozycji ze słownika

dictionary-provider-entry

Pozycja słownikowa świadczeniodawcy

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

Właściwość Typ Opis
type string Typ obiektu
attributes dictionary-provider-entry-attributes Atrybuty pozycji słownika świadczeniodawców

dictionary-provider-entry-attributes

Atrybuty pozycji słownika świadczeniodawców

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

Właściwość Typ Opis
branch string Oddział Wojewódzki NFZ
code string Kod świadczeniodawcy
name string Nazwa świadczeniodawcy
nip string Numer NIP
regon string Numer REGON
registry-number string Numer księgi rejestrowej
post-code string Kod pocztowy
street string Ulica
place string Miejscowość
phone string Numer telefonu
commune string Gmina

provider-list-data

Dane dotyczące listy świadczeniodawców

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

Właściwość Typ Opis
providers array [provider] Lista świadczeniodawców

provider

Szczegóły świadczeniodawcy

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

Właściwość Typ Opis
type string Typ obiektu
attributes provider-attributes Atrybuty umowy
links base-links Linki

provider-attributes

Atrybuty świadczeniodawcy

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

Właściwość Typ Opis
branch string Oddział Wojewódzki
code string Kod świadczniodawcy
name string Nazwa świadczeniodawcy
nip string Numer NIP
regon string Regon
registry-number string Numer księgi rejestrowej
post-code string Kod pocztowy
street string Ulica
place string Miejscowość
phone string Numer telefonu
commune string Gmina
amount number Sumaryczna kwota zobowiązań

provider-data

Szczegóły świadczeniodawcy

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

Właściwość Typ Opis
provider provider Szczegóły świadczeniodawcy
agreements array [agreement] Lista umów świadczeniodawcy

version

Szczegóły dotyczące wersji API

Struktura version 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