Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Page Properties
idAPI_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

id

String

Required

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

Request structure

API paragraph not found

...

  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

Headers

Наприклад:

Content-Type:application/json

...

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).

...

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:

...