1 Purpose
- 1.1 Key points
2 Specification
3 Logic
4 Filters
5 Request structure
6 Authorize
7 Headers
8 Response structure
9 HTTP status codes

Purpose

This WS allows to get a list of Groups of Diagnoses without details by legal entity employees. Used to get id, name and description of the Group of Diagnoses.

Key points

This is a REST method used by MIS.
Authorization is not needed to get Diagnoses Groups list (as dictionaries).

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-groups-of-diagnoses/get-groups-of-diagnoses-list/get-groups-of-diagnoses-list	Посилання на Apiary або Swagger
Resource	api/diagnoses_groups	Посилання на ресурс, наприклад: /api/persons/create
Scope	API paragraph not found	Scope для доступу
Components	Medical events	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Async	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

Filter active diagnoses_groups by search params (name, code)
Render found diagnoses_groups with following params only:
1. id
2. name
3. code
4. description

Filters

See on Apiary

Request structure

See on Apiary

Authorize

Is not needed

Headers

Content-Type:application/json

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
      "name": "Some name",
      "code": "H00",
      "description": "Some description"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response

E-Health

Get Groups of Diagnoses list_EN