Dokumentacja API Umowy NFZ wersja 1.2

Metadane

Do każdego poprawnego wyniku żądania HTTP (bez błędów) dodawane są metadane. W dużym uproszeniu są to dane opisujące dane. Należą one do jednego z trzech głównych elementów zwracanych w opdowiedzi na zapytania (data, errors, meta).

Dostępne są następujące rodzaje metadanych:

@context

Pole zawiera adres url pod którym znajdują się szczegółowe informację dotyczące schematu dla zwracanego wyniku. 

    {
        "meta": {
            "@context": "https://api.nfz.gov.pl/app-umw-api/schemas/#plans",
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

count

Zasoby zwracające listę wyników (np. zasób /plans/{id} nie zwróci tej metadanej) są stronicowane, dlatego w odpowiedzi na te żądania, zwracana jest liczba wszystkich znalezionych wyników w polu count. 

    {
        "meta": {
            ...
            "count": 20,
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

page

Tak jak w przypadku count metadana page jest zwracana tylko dla zasobów zwracających listę wyników. Określa ona przesunięcie (offset), w widoku danych. 

    {
        "meta": {
            ...
            "page": 2,
            ...
      },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

limit

Metadana limit tak samo jak count i page zwracana jest tylko dla zasobów zawierających listę wyników. Określa ona liczbę wyników zwracanych na jednej stronie. 

    {
        "meta": {
            ...
            "limit": 20
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

title

Nazwa zasobu informacyjnego, która umożliwia jego identyfikację. 

    {
        "meta": {
            ...
            "title": "plans"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

url

Identyfikator lokalizacji do pobrania zasobu informacyjnego w przypadku, gdy stanowi osobny plik. 

    {
        "meta": {
            ...
            "url": "https://api.nfz.gov.pl/app-umw-api/schema/agreement"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

provider

Opis dostawcy zasobu informacyjnego - Narodowy Fundusz Zdrowia. 

    {
        "meta": {
            ...
            "provider": "Narodowy Fundusz Zdrowia"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

date-published

Data i czas publikacji zasobu, z dokładnością do jednej sekundy. Data i czas zgodnie ze standardem ISO-8601. 

    {
        "meta": {
            ...
            "date-published": "2019-08-22T09:21:33+01:00"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

date-modified

Data ostatniej modyfikacji zasobu z dokładnością do jednej sekundy. Data i czas zgodnie ze standardem ISO-8601. 

    {
        "meta": {
            ...
            "date-modified": "2019-08-22T09:21:33+01:00"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

description

Opis zasobu informacyjnego. 

    {
        "meta": {
            ...
        "description": "Zasób zwraca listę planów umowy podpisanej przez NFZ ze świadczeniodawcą określoną parametrami wyszukiwania."
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

keywords

Słowa kluczowe, czyli zestaw słów lub wyrażeń zwięźle opisujących zasób informacyjny. 

    {
        "meta": {
            ...
            "keywords": "Narodowy Fundusz Zdrowia, umowy, umowy NFZ, świadczeniodawcy, plan, środki pomocnicze"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

language

Określa język zasobu. 

    {
        "meta": {
            ...
            "language": "PL"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

content-type

Określa informację o rodzaju zasobu i jego kodowaniu. 

https://api.nfz.gov.pl/app-umw-api/plans?branch=07
 
    {
        "meta": {
            ...
            "content-type": "application/json; charset=utf-8"
            ...
        },
        "links": {
            ...
        },
        "data": [
            ...
        ]
    }

is-part-of

Określenie przynależności do grupy np. zasobów. 

    {
        "meta": {
            ...
            "is-part-of": "Umowy"
            ...
        },
        "links": {
           ...
        },
        "data": [
            ...
        ]
    }

version

Wskazuje wersję API 

    {
        "meta": {
            ...
            "version": "1.0"
            ...
        },
        "links": {
           ...
        },
        "data": [
            ...
        ]
    }