1 Purpose
- 1.1 Key points
2 Specification
3 Logic
4 Input parameters
5 Authorize
6 Headers
7 Request data validation
- 7.1 Validate Group of Diagnoses
8 Response structure
9 HTTP status codes

Purpose

This WS is designed to return Group of Diagnoses details.

Key points

This is a REST method used by MIS.
Authorization is not needed to get Group of Diagnoses details.

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-groups-of-diagnoses/get-group-of-diagnoses-details/get-group-of-diagnoses-details	Посилання на Apiary або Swagger
Resource	/api/diagnoses_groups/{{id}}	Посилання на ресурс, наприклад: /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

Get data from prm DB:
1. diagnoses_groups by id
2. diagnoses_group_codes by diagnoses_group_id
Render a response according to specification.

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter

Values

Type

Description

Example

Id

String

Group of Diagnoses identifier.

Required

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

Authorize

Is not needed

Headers

Content-Type:application/json

Request data validation

Validate Group of Diagnoses

Check that Group of Diagnoses with such ID exists in the system (is_active = true)
1. In case of error - return 404 "Group of Diagnoses not found"

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
404	Group of Diagnoses not found

E-Health

Get Group of Diagnoses details_EN