Versions Compared

Old Version 3

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version 4

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-005-006-001-0090

Microservices (namespace)

IL

Component

Divisions

Component ID

COM-005-006

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/divisions/deactivate-division

Resource

{{host}}/api/divisions/{{id}}/actions/deactivate

Scope

division:deactivate

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

...

  1. Only authenticated and authorized user can use this service

  2. Only ACTIVE division can be deactivated

  3. Legal entity can deactivate only its own divisions

Configuration parameters

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

Dictionaries

Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY

Input parameters

...

parameters

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Required

d290f1ee-6c54-4b01-90e6-d701748f0851

2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Expand
titleExample
Code Block
...
Key
Value
Mandatory
Description
Example
1
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
2
Authorization
Bearer {{access_token}}
M
Перевірка користувача
Authorization:Bearer {{access_token}}
3
API-key
{{mis_client_secret}}
API-key:{{mis_client_secret}}
Request data validation
Authorize
  1. Verify the validity of access token
    Return 401 in case validation fails
  2. Check scopes in order to perform this action (scope = 'division:deactivate')
    1. Return 403 in case invalid scope(s)
Validate division
  1. Check that division with such ID exists in the system (is_active = true)
    1. In case of error - return 404
  2. Check that division belongs to the same legal entity as the user
    1. In case of error - return 403
...
Parameter
Source
Description
status
INACTIVE
 
updated_at
Timestamp: now()
Get current date-time
updated_by
Token: user_id
 
Deactivate Medical Program Provision
For PHARMACY legal entity type only. For related divisions deactivate linked active medical program provision entities (according to link).
Deactivate related active medical program provision entities:
  • set is_active = false
  • set deactivate_reason = AUTO_DIVISION_DEACTIVATION 
  • set updated_at, updated by
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Бориспільське відділення Клініки Ноунейм",
    "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",
    "working_hours": {
      "mon": [
        [
          "08.00",
          "12.00"
        ],
        [
          "14.00",
          "18.00"
        ]
      ],
      "tue": [
        [
          "08.00",
          "12.00"
        ]
      ],
      "wed": [
        [
          "08.00",
          "12.00"
        ]
      ],
      "thu": [
        [
          "08.00",
          "12.00"
        ]
      ],
      "fri": [
        [
          "08.00",
          "12.00"
        ]
      ]
    },
    "type": "CLINIC",
    "legal_entity_id": "c8aadb87-ecb9-41ca-9ad4-ffdfe1dd89c9",
    "external_id": "3213213",
    "location": {
      "latitude": 30.1233,
      "longitude": 50.32423
    },
    "status": "ACTIVE",
    "mountain_group": false,
    "dls_id": "2872985",
    "dls_verified": true
  }
}HTTP status codes
HTTP status codes
Only for active MPI record can be created medication request!
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
 Response
 
3
401
 Invalid access token
 
4
401
Unauthorized
Помилка підтвердження
5
403
 Check that division belongs to the same legal entity as the user failed
65
403
Invalid scope
7
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
86
404
 Validation error
97
409
{current_status} division cannot be DEACTIVATED
108
409
Division cannot be deactivated - active healthcare services exists
119
409
 Validation error
1210
Специфічні
13
422
11
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...