Versions Compared

Key

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

Purpose

This process is designed to deactivate declaration manually (for NHS admin or patient authorized via Cabinet).

Specification

Page Properties
Тип протоколу, який використовується запитом, наприклад: SOAP |

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-ops-db/declarations/terminate-declarations-by-employee-or-person

Посилання на Apiary або Swagger

Resource

/declarations/terminateПосилання на ресурс, наприклад: /api/persons/create

Scope

declaration:terminateScope для доступу

Components

Declarations

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Microservices

il/api

ops/api

Protocol type

REST

Request type

PATCH

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

InternalПотрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

...

  1. Verify the validity of access token

  2. Check user scopes declaration:terminate in order to perform this action

    1. In case error - generate 401 response.

...

One of parameter  person_id or employee_id must be set. Also can be added the description field: reason_description.

Patient via cabinet can terminate only his own active declaration.

...