REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-001-001-001-0001
Microservices (namespace)	MC
Component	Compositions
Component ID	COM-006-001
Link на API-специфікацію	https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/async/getAsyncJobStatus
Resource	{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package
Scope	composition:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

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

Logic

Creation of composition: Asynchronous tasks

Sequence:

MIS/Medical employee->Compositions: Creating or updating compositions POST patients/composition/
Compositions->Compositions: AsyncJob planning
Compositions->MIS/Medical employee: AsyncJob scheduled (eta)
MIS/Medical employee->MIS/Medical employee: asynJob.data.eta timer on
MIS/Medical employee-->Compositions: GET /patients/composition/job/{asyncJobId}
Compositions-->MIS/Medical employee: AsincJob pending (eta)
MIS/Medical employee-->MIS/Medical employee: asynJob.data.eta timer on
Compositions->Compositions: AsyncJob completed
MIS/Medical employee->Compositions: GET /patients/composition/job/{asyncJobId}
Compositions->MIS/Medical employee: AsincJob completed (compositionAsyncJobStateData.links)
MIS/Medical employee->Compositions: GET /patients/{patientId}/encounter/{encounterId}/composition/{compositionId}
Compositions->MIS/Medical employee: The composition is received

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 parameters

	Input parameter	Mandatory	Type	Description	Example
1	asyncJobId		String	Async Job Object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

Request structure

See on SwaggerHub

Description of the REST API request structure, example

GET

/patients/composition/job/{asyncJobId}

Headers

	Key	Value	Description	Example
1	Content-Type:	application/json	Тип контенту	Content-Type: application/json
2	Authorization	Bearer {token}	Перевірка користувача	Authorization: Bearer {token}
3	api-key	{secret}	Секретний ключ	api-key: {secret}

Request data validation

Parameters validation:

asyncJobId (correct composition ID needed)
- 404 - in case of error

Processing

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

Response structure examples

See on SwaggerHub

Schema

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:

Example Value

{
  "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	Description
1	Базові
2		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 modules where the method is used

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