Versions Compared

Old Version 26

changes.mady.by.user Alexander Fedotov (SoE eHealth)

Saved on

compared with

New Version 27

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

...

See on SwaggerHub (2.39.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

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

...

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