Purpose

This method is designed to cancel an existing composition

Specification

Link	https://app.swaggerhub.com/apis/ehealthua/compositions/2.32.2#/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

Input parameters

See on SwaggerHub (2.32.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"
}

Request structure

See on SwaggerHub (2.32.2)

Authorize

API paragraph not found

Headers

Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}

Validation data request

API paragraph not found

Processing

API paragraph not found

Response structure

See on SwaggerHub (2.32.2)

Example:

Response example

{
  "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"
  }
}

Post-processing processes

API paragraph not found

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

cancelComposition

Purpose

Specification

Logic

Input parameters

Request structure

Authorize

Headers

Validation data request

Processing

Response structure

Post-processing processes

HTTP status codes