/

[DRAFT] Get Services Dictionary [API-011-001-007-0403]

ЕСОЗ - публічна документація

[DRAFT] Get Services Dictionary [API-011-001-007-0403]

Owned by Mykhailo Troinin (SoE eHealth) (Unlicensed)

Last updated: Dec 27, 2024 by Anzhela Kovalenko (SoE eHealth)

2 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
- 3.1 Service logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get Services Dictionary [API-011-001-007-0403]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-011-001-007-0403
Microservices (namespace)	PRM
Component	Dictionaries and Registers
Component ID	COM-011-001
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-programs/medical-program/get-services-dictionary
Resource	{{host}}/api/services
Scope
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This web service returns a catalog of services that could be submitted to eHealth

Logic

Filter services by search params.
Render found services with all fields from PRM DB.

Service logic

Service returns all services grouped by service_groups (skipping services and service groups if them service_inclusion.is_active = false) filtered by submitted parameters from redis (origin PRM DB)

Get service_group
Get services
Get service_inclusions (where service_inclusion.is_active = true)
Filter list above by submitted search parameters
Render a response according to specification with found service entities.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

N/A

Response structure examples

See on API-specification

Node 1

service_groups w/o sub-groups, w/o parent_group_id

service_groups with sub-groups, w/o parent_group_id

services which aren't included in any service_groups

Node 2

service_groups with parent_group_id with service_groups of the first node

services which are included in the service_groups of the Node 1

Node 3

service_groups with parent_group_id with service_groups from the second node

services which are included in the service_groups of the Node 2

Node 4

service_groups with parent_group_id with service_groups from the third node

services which are included in the service_groups of the Node 3

Node 5

services which are included in the service_groups of the Node 4

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "e5a5d991-0bf7-476f-b3cf-bec73f044b2e",
    "name": "`Ультразвукові дослідження'",
    "code": "FJ",
    "is_active": true,
    "request_allowed": false,
    "inserted_at": "2018-08-02T10:45:16.000Z",
    "inserted_by": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e",
    "updated_at": "2018-08-02T10:45:16.000Z",
    "updated_by": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e",
    "groups": [
      {
        "id": "75a5d991-0bf7-476f-b3cf-bec73f044b2e",
        "name": "`Ультразвукові дослідження в гастроентерології'",
        "code": "2FJ",
        "is_active": true,
        "request_allowed": false,
        "inserted_at": "2018-08-02T10:45:16.000Z",
        "inserted_by": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e",
        "updated_at": "2018-08-02T10:45:16.000Z",
        "updated_by": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e",
        "services": [
          {
            "id": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e",
            "name": "`Ультразвукове дослідження черевного відділу стравоходу'",
            "code": "JF2 01",
            "is_active": true,
            "parent_id": "null",
            "category": "imaging",
            "is_composition": false,
            "request_allowed": true,
            "inserted_at": "2018-08-02T10:45:16.000Z",
            "inserted_by": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e",
            "updated_at": "2018-08-02T10:45:16.000Z",
            "updated_by": "d5a5d991-0bf7-476f-b3cf-bec73f044b2e"
          }
        ]
      }
    ]
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200	Response
3	Специфічні
4

Post-processing processes

N/A

Technical modules where the method is used

ЕСОЗ - публічна документація