Dokumentacja API Terminy Leczenia 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": [
        ...
    ]
}
            
        

queue

Obiekt przedstawiający listę szczegółów dotyczących pierwszego wolnego terminu udzielenia świadczenia opieki zdrowotnej.

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

Właściwość Typ Opis
        
            
        

queue-attributes

Obiekt przedstawiający atrybuty pierwszego wolnego terminu udzielenia świadczenia opieki zdrowotnej.

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

Właściwość Typ Opis
        
            
        

statistics

Obiekt przedstawiający informacje statystyczne dotyczące list oczekujących na świadczenie opieki zdrowotnej.

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

Właściwość Typ Opis
        
            
        

first-available-date

Obiekt przedstawiający listę szczegółów dotyczących daty pierwszego wolnego terminu udzielenia świadczenia opieki zdrowotnej.

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

Właściwość Typ Opis
        
            
        

benefits-provided

Obiekt przedstawiający atrybuty ilości wykonanych świadczeń.

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

Właściwość Typ Opis
        
        

many-places

Obiekt przedstawiający listę szczegółów dotyczących znacznika wskazującego, czy świadczeniodawca udziela dane świadczenie zdrowotne w innych miejscach w ramach zawartej umowy z NFZ.

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

Właściwość Typ Opis
        
            
        

many-places-attributes

Obiekt przedstawiający atrybuty znacznika wskazującego, czy świadczeniodawca udziela dane świadczenie zdrowotne w innych miejscach w ramach zawartej umowy z NFZ.

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

Właściwość Typ Opis
        
            
        

many-places-queue

Obiekt przedstawiający atrybuty znacznika wskazującego, czy świadczeniodawca udziela dane świadczenie zdrowotne w innych miejscach w ramach zawartej umowy z NFZ.

Struktura many-places-queue dostępna jest także w SwaggerUI oraz w pliku json schema.

Właściwość Typ Opis
        
            
        

error-response

Struktura zawierająca listę błędów, które wystąpiły w opowiedzi na zapytanie HTTP.

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

Właściwość Typ Opis
        
            
        

error

Opis błędu, który wystąpił w odpowiedzi na zapytanie HTTP.

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

Właściwość Typ Opis
        
            
        

version-response

Szczegółowy opis wersji API.

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

Właściwość Typ Opis
        
            
        

api-version

Wersja API

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

Właściwość Typ Opis
        
            
        

benefit

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

locality

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

place

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

provider

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

street

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