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

[DRAFT] Deactivate division [API-005-006-001-0090]

Owned by Kateryna Yakovleva
Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)
1 min read

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

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

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Deactivate division [API-005-006-001-0090]

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

Purpose

This method should be used for the deactivation of the division

Logic

  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

N/A

Dictionaries

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

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Required

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

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

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

Validate healthcare service

Check that there are no active healthcare services related to this division

  1. Search for healthcare services with this division in status ACTIVE

    1. If search result contains any records - return 409 error (Division cannot be deactivated - active healthcare services exists)

Validate equipment

Check that there are no active records in equipment table related to this division

  1. Search for equipments with this division in ACTIVE status

    1. If search result contains any records - return 409 error (Division cannot be deactivated - active equipments exists)

Validate transition

Only ACTIVE division can be deactivated

Available transitions

  1. ACTIVE → INACTIVE

In other cases - return 409 error ('{current_status} division cannot be DEACTIVATED')

Processing

Save object to DB

Parameter

Source

Description

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

{ "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

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 Response

 

 

3

 

401

 Invalid access token

 

 

4

 

403

 Check that division belongs to the same legal entity as the user failed

 

 

5

 

403

Invalid scope

 

 

6

 

404

 Validation error

 

 

7

 

409

{current_status} division cannot be DEACTIVATED

 

 

8

 

409

Division cannot be deactivated - active healthcare services exists

 

 

9

 

409

 Validation error

 

 

10

Специфічні

11

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

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