Versions Compared

Version Old Version 5 New Version Current
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова) (
Info
Note

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

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document statusDRAFT] REST API [Назва методу] [ID методуGet Forbidden group details [API-001-001-002-0008]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-001-001-002-0008

Microservices (namespace)

ABAC

Component

Approvals/ABAC

Component ID

COM-001-001

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-forbidden-groups/get-forbidden-group-listdetails/get-forbidden-group-details

Resource

{{host}}/api/forbidden_groups/{{id}}

Scope

forbidden_group:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

Return forbidden group details filtered by ID with active codes and active services in eHealth.

Logic

This web service returns forbidden group details filtered by ID with active codes and active services in eHealth.

...

  1. This is a REST method used by MIS

  2. Authorization is not needed to get Forbidden group list (as dictionaries)

Logic

This web service returns forbidden group details filtered by ID with active codes and active services in eHealth.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in ConfluenceN/A

Dictionaries

N/A

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

 

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

2

Request structure

See on API-specification

Expand
titleExample
Code Block

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

...

languagejson
Headers
Headers 
Request data validation
N/A
Processing
N/A
Response structure examples
...
 Expand
titleExample
 Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
      "name": "Some name",
      "creation_reason": "Some text",
      "deactivation_reason": "Some text",
      "forbidden_group_codes": [
        {
          "id": "f016a994-4826-48ae-be65-8d459a75f021",
          "code": "G30.9",
          "system": "eHealth/ICD10_AM/condition_codes",
          "creation_reason": "Some text"
        }
      ],
      "forbidden_group_services": [
        {
          "id": "b8bc70e1-783c-4b25-a90e-0da9217d84d9",
          "service_id": "b2e4464e-609e-480c-a32c-6db4fbb04cf1",
          "service_group_id": "d838dbea-0ca0-4295-bf46-819dc069b8d4",
          "creation_reason": "Some text"
        }
      ]
    }
  ]
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
200
3
200
4
401
Специфічні
Unauthorized
Помилка підтвердження
5
Специфічні
6
422
Only for active MPI record can be created medication request!
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...