Versions Compared

Old Version 2

changes.mady.by.user Aleksandr Virny

Saved on

compared with

New Version Current

changes.mady.by.user Igor Gorielov (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Table of Contents

Purpose

This API is designed to search divisions on public portal and patient cabinet

Specification

Page Properties
idAPI_Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-portal-and-reports/divisions/search-divisions

Посилання на Apiary

...

або Swagger

Resource

/reports/stats/divisions

Посилання на ресурс, наприклад: /api/persons/create

Scope

API paragraph not found

Scope для доступу

Components

Divisions

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

il/api

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Internal

Потрібно зазначити тип методу за ступенем доступності

Logic

  1. Filter divisions by query params

  2. Render related entities (legal entity, addresses)

  3. Outer join healthcare services. If there are no related healthcare services - render empty array in response

Filters

See on Apiary

Authorize

API paragraph not found

Headers

Наприклад:

Content-Type:application/json

Request data validation

Processing

API paragraph not found

Request structure

See on Apiary

Response structure

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "asSbcy12sYs8c",
      "name": "Aдоніс",
      "type": "CLINIC",
      "addresses": {
        "type": "RESIDENCE",
        "country": "UA",
        "area": "Житомирська",
        "region": "Бердичівський",
        "settlement": "Київ",
        "settlement_type": "CITY",
        "settlement_id": "b075f148",
        "street_type": "STREET",
        "street": "вул. Ніжинська",
        "building": "15",
        "apartment": "23",
        "zip": "02090"
      },
      "contacts": {
        "email": "email@example.com",
        "phones": [
          {
            "type": "MOBILE",
            "number": "+380503410870"
          }
        ]
      },
      "coordinates": {
        "latitude": 30.1233,
        "longitude": 50.32423
      },
      "legal_entity": {
        "name": "Заклад Ноунейм",
        "short_name": "Ноунейм",
        "public_name": "Ноунейм",
        "type": "PRIMARY_CARE",
        "owner_property_type": "STATE",
        "legal_form": "140",
        "edrpou": "5432345432",
        "kveds": "[\"86.10\", \"47.73\"]",
        "addresses": [
          {
            "type": "RESIDENCE",
            "country": "UA",
            "area": "Житомирська",
            "region": "Бердичівський",
            "settlement": "Київ",
            "settlement_type": "CITY",
            "settlement_id": "b075f148",
            "street_type": "STREET",
            "street": "вул. Ніжинська",
            "building": "15",
            "apartment": "23",
            "zip": "02090"
          }
        ],
        "phones": [
          {
            "type": "MOBILE",
            "number": "+380503410870"
          }
        ],
        "email": "email@example.com",
        "nhs_verified": "false",
        "owner": {
          "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
          "position": "P1",
          "employee_type": "OWNER",
          "party": {
            "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
            "first_name": "Петро",
            "second_name": "Миколайович",
            "last_name": "Іванов"
          }
        }
      },
      "healthcare_services": [
        {
          "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
          "division_id": "8be63914-a278-470b-b868-1af5b9087332",
          "legal_entity_id": "483af06f-d4c6-4c9e-8d9b-680b5ef7270d",
          "license_id": "cdcf456b-e235-4850-9f00-27cc3453d346",
          "speciality_type": "FAMILY_DOCTOR",
          "providing_condition": "OUTPATIENT",
          "category": {
            "coding": [
              {
                "system": "HEALTHCARE_SERVICE_CATEGORIES",
                "code": "MSP"
              }
            ]
          },
          "type": {
            "coding": [
              {
                "system": "HEALTHCARE_SERVICE_PHARMACY_DRUGS_TYPES",
                "code": "SALE"
              }
            ]
          },
          "status": "ACTIVE",
          "comment": "Заведено помилково",
          "coverage_area": [
            "2c0110a9-0bea-4b16-af8e-6e2e149a5bfc"
          ],
          "available_time": [
            {
              "days_of_week": [
                "mon"
              ],
              "all_day": true,
              "available_start_time": "08:30:00",
              "available_end_time": "19:00:00"
            }
          ],
          "not_available": [
            {
              "description": "Санітарний день",
              "during": {
                "start": "2018-08-02T10:45:16.000Z",
                "end": "2018-08-02T11:00:00.000Z"
              }
            }
          ],
          "licensed_healthcare_service": {
            "status": "ACTIVE",
            "updated_at": "2022-04-20T19:14:13Z"
          },
          "is_active": true,
          "inserted_at": "2017-04-20T19:14:13Z",
          "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
          "updated_at": "2017-04-20T19:14:13Z",
          "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
        }
      ]
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response