Versions Compared

Old Version 23

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

Saved on

compared with

New Version Current

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

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Creation of composition: Asynchronous tasks

...

Expand
titleSequence:

  1. MIS/Medical employee->Compositions: Creating or updating compositions POST patients/composition/

  2. Compositions->Compositions: AsyncJob planning

  3. Compositions->MIS/Medical employee: AsyncJob scheduled (eta)

  4. MIS/Medical employee->MIS/Medical employee: asynJob.data.eta timer on

  5. MIS/Medical employee-->Compositions: GET /patients/composition/job/{asyncJobId}

  6. Compositions-->MIS/Medical employee: AsincJob pending (eta)

  7. MIS/Medical employee-->MIS/Medical employee: asynJob.data.eta timer on

  8. Compositions->Compositions: AsyncJob completed

  9. MIS/Medical employee->Compositions: GET /patients/composition/job/{asyncJobId}

  10. Compositions->MIS/Medical employee: AsincJob completed (compositionAsyncJobStateData.links)

  11. MIS/Medical employee->Compositions: GET /patients/{patientId}/encounter/{encounterId}/composition/{compositionId}

  12. Compositions->MIS/Medical employee: The composition is received

Input parameters

Input parameter

Values

Type

Description

Example

asyncJobId

String

Async Job Object ID

89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

Request structure

See on SwaggerHub

{ "data": { "eta": "
Expand
titleExample Value
Code Block
GET

/patients/composition/job/{asyncJobId}

Authorize

Check user scopes in order to perform this action (scope = 'composition:read')

  • return 401 (Unauthorized) in case of invalid scope(s)

Headers

  • Content-Type: application/json

  • Authorization: Bearer {token}

  • api-key: {secret}

Validation data request

Parameters validation:

  • asyncJobId (correct composition ID needed)

    • 404 - in case of error

Response structure

See on SwaggerHub

Expand
titleSchema

compositionAsyncJobStateResponse{

description:

Стан планування/виконання асинхронної задачі

data*

compositionAsyncJobStateData{

eta* string($datetime)
example: 2022-10-24T12:35:49.956Z

", "id": "

id* string($uuid)
example: 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

", "links": [ { "entity": "eHealth/resources" } ], "status": "PENDING" } }

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

links* [compositionAsyncJobListItem{

entity*string
example: eHealth/resources 

}]

status* string

Enum:
[ PENDING, FAILED, DONE ] }

}

Example:

Expand
titleResponse exampleExample Value
Code Block
{
  "data": {
    "ideta": "3fa85f642022-5717-4562-b3fc-2c963f66afa6",
    "status": "PENDING",
    "eta": "string10-24T12:35:49.956Z",
    "doneAtid": "string89678f60-4cdc-4fe3-ae83-e8b3ebd35c59",
    "links": [
      {
        "entity": "eHealth/compositionresources",
      }
 "href": "composition/0daaad78-6cfb-11ea-9cd6-afab698838bc",    ],
    "errorstatus": "string"
      }
    ]PENDING"
  }
}

Post-processing processes

...

HTTP status codes
HTTP status code
Message
What caused the error
200
Task found 
Correct answer with one of the possible statuses: PENDING, FAILED, DONE
400
Invalid request format 
Error in query syntax or other error
404
Task not found
The task with the specified ID does not exist or was not found