Versions Compared

Old Version 5

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version 6

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

Key

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

Purpose*

This method is designed to cancel an existing composition

Specification*

Link

https://app.swaggerhub.com/apis/bugzi11a/emal/1.0.8#/main/cancelComposition

Resource

/patients/composition/{compositionId}/cancel

Scope

composition:cancel

Components

Compositions

Using Dictionaries

API paragraph not found

Using Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private/Internal

Public

Logic*

API paragraph not found

...

API paragraph not found

Global and configuration parameters

None

Input parameters

Input parameter

Values

Type

Description

Example

compositionId

String ($uuid)

(path)

Composition object ID

...

None

Request structure*

See on SwaggerHub

Request body

...

Expand
titleRequest body example
Code Block
{
  "data": "string"
}

Authorize*

API paragraph not found

Headers

...

API paragraph not found

...

*

API paragraph not found

Validation data request*

API paragraph not found

Processing*

API paragraph not found

Response structure*

See on SwaggerHub

Example:

Expand
titleResponse example
Code Block
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "PENDING",
    "eta": "string",
    "doneAt": "string",
    "links": [
      {
        "entity": "eHealth/composition",
        "href": "composition/0daaad78-6cfb-11ea-9cd6-afab698838bc",
        "error": "string"
      }
    ]
  }
}

Post-processing processes*

NoneAPI paragraph not found

HTTP status codes*

HTTP status code

Message

What caused the error

200

In case of successful cancellation of the Composition

 

400

Invalid request format

401

The user role does not allow the operation to be performed

404

The object of the Composition was not found

500

Subordinate service error

Backward compatibility

...