Purpose

The method is designed to get the execution task status of an asynchronous job: it returns the composition creation asynchronous job status after the signComposition request has been executed.

Used in processes:

Create/Sign composition (general process)

RC_4. Re-sending MVTN to ERLN

RC_5. Extension / reduction MVTN

RC_6. Refinement (preperson -> person) for MVTN

RC_7. Creating "a replacement" composition

Specification

Link	https://app.swaggerhub.com/apis/ehealthua/compositions/2.32.2#/async/getAsyncJobStatus
Resource	/patients/composition/job/{{asyncJobId}}
Scope	composition:read
Components	Compositions
Using Dictionaries	API paragraph not found
Using Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal	Public

Logic

Input parameters

Input parameter	Values	Type	Description	Example
asyncJobId		String	Async Job Object ID

Request structure

See on SwaggerHub

Authorize

API paragraph not found

Headers

API paragraph not found

Validation data request

Parameters validation:

asyncJobId

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	Task found
400	Invalid request format
404	Task not found

getAsyncJobStatus

Purpose

Specification

Logic

Input parameters

Request structure

Authorize

Headers

Validation data request

Processing

Response structure

Example:

Post-processing processes

HTTP status codes