Versions Compared

Old Version 2

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова)
Info
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API
Scope

Document type

Метод REST API

Document title

[DRAFT] REST API getAsyncJobStatus [API-006-001-001-0209]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-001006-001-001-00010209

Microservices (namespace)

MPIMC

Component

AuthCompositions

Component ID

COM-001006-001

Link на API-специфікацію

https://ehealthmisapi1app.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-detailsswaggerhub.com/apis/ehealthua/compositions/Prod#/async/getAsyncJobStatus

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

patients/composition/job/{{asyncJobId}}

Scope

composition:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input 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

Logic

Creation of composition: Asynchronous tasks

...

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

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

2

Input parameter

Mandatory

Type

Description

Example

1

composition_idasyncJobId

 M 

String ($uuid) (path)Composition object

Async Job Object ID

 89678f6089678f60-4cdc-4fe3-ae83-e8b3ebd35c59

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example SwaggerHub

Expand
titleExampleGET
Code Block
/patients/composition/job/{asyncJobId}

Headers

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

Description of the REST API response structure, example

Request data validation

Parameters validation:

  • asyncJobId (correct composition ID needed)

    • 404 - in case of error

Processing

N/A

Response structure examples

See on SwaggerHub

Expand
titleSchema

compositionAsyncJobStateResponse{

description:

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

data*

compositionAsyncJobStateData{

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

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

links* [compositionAsyncJobListItem{

entity*string
example: eHealth/resources 

}]

status* string

Enum:
[ PENDING, FAILED, DONE ] }

}

Example:

Expand
titleExample Value
Code Block
languagejson
{
  "data": {
    "eta": "2022-10-24T12:35:49.956Z",
    "id": "89678f60-4cdc-4fe3-ae83-e8b3ebd35c59",
    "links": [
      {
        "entity": "eHealth/resources"
      }
    ],
    "status": "PENDING"
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

Не знайдено медичний висновок

3

401

Unauthorized

Помилка підтвердження

4

Специфічні

5

422

Only for active MPI record can be created medication request!200

Task found

Correct answer with one of the possible statuses: PENDING, FAILED, DONE

3

400

Invalid request format

Error in query syntax or other error

4

404

Task not found

The task with the specified ID does not exist or was not found

5

Специфічні

6

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"

...