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

[DRAFT] Deactivate Legal Entity [API-005-009-002-0180]

Owned by Kateryna Yakovleva
Last updated: Dec 24, 2024 by Anzhela Kovalenko (SoE eHealth)
3 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 Legal Entity [API-005-009-002-0180]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-005-009-002-0180

Microservices (namespace)

IL

Component

Legal Entities

Component ID

COM-005-009

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/legal-entities/deactivate-legal-entity

Resource

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

Scope

legal_entity:deactivate

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Private

Purpose

Use this method to deactivate msp

Logic

3da6cc4e-7a81-4fa1-84e9-7d435c113eef.png

 

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

N/A

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

  2. Check user scope legal_entity:deactivate in order to perform this action

    1. In case error - return 401 error

Validate transition

  1. Validate transition according to Available transitions. Deactivation of an legal_entity is possible if parameters have the following values: is_active = true & status = ACTIVE or SUSPENDED.

    1. In case error return Error 409 message "Invalid transition".

Processing

Deactivate employees

Invoke PRM API to get list of active employees by legal_entity_id. Employees list contains active employees where status=APPROVED and is_active = true.

For each employee check active declarations and deactivate it (if exist) according to Deactivate Employee | Deactivate declarations

To deactivate each employee from the list (except OWNER).

Terminate Contract and Contract Requests

Find contracts by contractor_legal_entity_id=$legal_entity_id  and status='VERIFIED' 

  • set prm.contracts.status=TERMINATED and  status_reason='auto_deactivation_legal_entity'

Find contract requests by contractor_legal_entity_id=$legal_entity_id  and status in  (`NEW`, `IN_PROCESS`, `APPROVED`, `PENDING_NHS_SIGN`, `NHS_SIGNED`)

  • set prm.contract_requests.status=TERMINATED and  status_reason='auto_deactivation_legal_entity'

Deactivate Legal Entity

Change legal_entity status to CLOSED

Deactivate Medical Program Provision

For PHARMACY legal entity type only (according to link).

For related divisions deactivate linked active medical program provision entities:

  • set is_active = false

  • set deactivate_reason = AUTO_LEGAL_ENTITY_DEACTIVATION (according to PROVISION_DEACTIVATE_REASON dictionary)

  • 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": { "name": "Клініка Ноунейм", "short_name": "Ноунейм", "public_name": "Ноунейм", "type": "MSP", "owner_property_type": "STATE", "legal_form": "140", "edrpou": "5432345432", "kveds": [ "86.1" ], "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", "website": "www.msp.com.ua", "receiver_funds_code": "12345", "beneficiary": "Борисов Борис Борисович", "medical_service_provider": { "licenses": [ { "license_number": "fd123443", "issued_by": "Кваліфікацйна комісія", "issued_date": "2017-02-28", "expiry_date": "2017-02-28", "active_from_date": "2017-02-28", "what_licensed": "реалізація наркотичних засобів", "order_no": "ВА43234" } ], "accreditation": { "category": "SECOND", "issued_date": "2017-02-28", "expiry_date": "2017-02-28", "order_no": "fd123443", "order_date": "2017-02-28" } }, "archive": [ { "date": "2017-02-28", "place": "вул. Грушевського 15" } ], "security": { "redirect_uri": "redirect_uri" }, "is_active": true, "inserted_by": "A65C8369-CE3A-44D6-839B-8856E3DC4CA3", "inserted_at": "2005-10-30 10:45", "created_by_mis_client_id": "A65C8369-CE3A-44D6-839B-8856E3DC4CA3", "updated_at": "1991-08-19T00:00:00.000Z", "updated_by": "userid" } }

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 scope

 

4

 

409

Invalid transition

 

 

5

Специфічні

6

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

N/A

 

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