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

Input parameters

Input parameter

Values

Type

Description

Example

compositionId

String ($uuid)

(path)

Composition object ID

Request structure*

See on SwaggerHub

Request body

Request body with signed Composition. Signed content must conform to the dummyCancelationSchema

Example

Request body example

{
  "data": "string"
}

Authorize*

API paragraph not found

Headers*

API paragraph not found

Validation data request*

API paragraph not found

Processing*

API paragraph not found

Response structure*

See on SwaggerHub

Example:

Response example

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

API 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

cancelComposition

Purpose*

Specification*

Logic*

Input parameters

Request structure*

Authorize*

Headers*

Validation data request*

Processing*

Response structure*

Post-processing processes*

HTTP status codes*