Versions Compared

Old Version 23

changes.mady.by.user Kateryna Haleta (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Kateryna Haleta (SoE eHealth)

Saved on

Key

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

...

QES - qualified electronic signature (KEP)

Specification

Link

https://app.swaggerhub.com/apis/ehealthua/compositions/2.

32

39.2#/main/cancelComposition

Resource

/patients/composition/{compositionId}/cancel

Scope

composition:cancel

Components

Compositions

Using Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private/Internal

Public

Logic

...

View file
namecancelcomposition.bpmn

Configurable parameters

Link to configurable parameters

...

EMAL_REPLACEMENT_FLOW_DISABILITY_ALLOWED_CANCELLATION_REASONS: “INCORRECT_CATEGORY,INCORRECT_DISABILITY_PERIOD,INCORRECT_INOXICATION,INCORRECT_PATIENT,INCORRECT_TRITMENT_VIOLATION”

Input parameters

See on SwaggerHub (2.3239.2)

Input parameter

Values

Type

Description

Example

compositionId

String ($uuid)

(path)

Composition object ID

89edcfb2-3479-4565-885b-d0ce7f9d081e

Request body

String($uuid)
(path)

Request body with signed composition.

{
"data": "string"
}

Dictionaries

Expand
titleCOMPOSITION_CANCELLATION_REASONS_TEMP_DISABILITY

Code

Translate (UA)

INCORRECT_CATEGORY

Помилкове зазначення категорії

INCORRECT_DISABILITY_PERIOD

Помилкове зазначення строків непрацездатності

INCORRECT_INOXICATION

Помилкове зазначення відміток щодо алкогольного та/або наркотичного сп’яніння

INCORRECT_OTHER

Помилкове зазначення інших відомостей

INCORRECT_PATIENT

Помилка ідентифікації

INCORRECT_TRITMENT_VIOLATION

Помилкове зазначення інформації щодо порушення режиму

Expand
titleCOMPOSITION_CANCELLATION_REASONS_NEWBORN

Code

Translate (UA)

INCORRECT_PATIENT

Невірно ідентифікований пацієнт

TYPO

Механічна помилка введення даних

Request structure

See on SwaggerHub (2.3239.2)

Authorize

Check user scopes in order to perform this action (scope = 'composition:cancel')

...

  1. For conclusions that have the relatesTo.code=REPLACES attribute set, a verification of the MC record to which the relatesTo link is reffered

    1. if the MC referred to by the current MC is not found — the task completes its execution with the code CANT_CANCEL_NOT_FOUND (1137)

    2. if the MC referred to by the current MC does not have the AMENDED status - the task completes its execution with the code CANT_CANCEL_NONAMENDED_COMPOSITION (1136). In an ideal situation, this code should never occur

    3. if the checks are passed, the MC to which the link is set changes its status from AMENDED to FINAL.

  2. The body of the cancellation request signed by QES is stored in the Ceph object storage.

  3. The MС status is set to ENTERED_IN_ERROR.

  4. If the authorization method is specified, an SMS is sent.

  5. The task of canceling the MC in the ERLN is planned.

Response structure

See on SwaggerHub (2.3239.2)

Example:

Expand
titleResponse example
Code Block
{
  "data": {
    "eta": "2022-10-24T13:14:01.656Z",
    "id": "89edcfb2-3479-4565-885b-d0ce7f9d081e",
    "links": [
      {
        "entity": "eHealth/resources",
        "href": "composition/1aecb5c4-60c8-4773-900a-64d01b382ce9"
      }
    ],
    "status": "PENDING"
  }
}

HTTP status codes

HTTP status code

Message

What caused the error

200

In case of successful cancellation of the Composition

Successful cancellation

400

Invalid request format

Error during formation or incorrect use of parameters in the request

401

The user role does not allow the operation to be performed

The role or scopes assigned to the user who generated the request do not allow such an operation to be done.

404

The object of the Composition was not found

The object of the Composition was not found or incorrect ID

500

Subordinate service error

Subordinate service error