1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Request structure
6 Authorize
7 Headers
8 Request data validation
- 8.1 Validate transition
9 Processing
10 Response structure
11 Post-processing processes
12 HTTP status codes

Purpose

Use this method to deactivate msp

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/legal-entities/deactivate-legal-entity	Посилання на Apiary або Swagger
Resource	/api/legal_entities/{{id}}/actions/deactivate	Посилання на ресурс, наприклад: /api/persons/create
Scope	legal_entity:deactivate	Scope для доступу
Components	Legal Entities	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Private (NHS)	Потрібно зазначити тип методу за ступенем доступності

Logic

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
id		String	Required	d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure

API paragraph not found

Authorize

Verify the validity of access token
Check user scope legal_entity:deactivate in order to perform this action
1. In case error - return 401 error

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate transition

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 https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583404010/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

Example:

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

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response
401		Invalid scope
409	Invalid transition