Versions Compared

Old Version 5

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

Saved on

compared with

New Version 6

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

Saved on

Key

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

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

...

Page Properties
idpage_properties_method_REST API

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-006-001-001-0210

Microservices (namespace)

MC

Component

Compositions

Component ID

COM-006-001

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

https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/main/patch_patients_composition__compositionId__erln

Resource

{{host}}/patients/composition/{{compositionId}}/erln

Scope

composition:create

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private

Public

...

  • Composition status is “FINAL”

  • Previous attempt of ERLN registration was unsuccessful (“ERROR” integration status)

  • The description of the error is available (statusMessage isn’t empty)

  • Temporarily disabled person is identified in the System (section.focus.type.coding.code = person)

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

compositionId

 

String ($uuid)

(path)

Composition object ID

4fd87fa2-1beb-44ff-a7cc-c1759e1c6e9b

2

Request structure

...

structure

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

Expand
titleExample
Code Block
...
Key
Value
Mandatory
Description
Example
1
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
2
Authorization
Bearer c2778f3064753ea70de870a53795f5c9
M
Перевірка користувача
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3
Authorization
Bearer {token}
Authorization: Bearer {token}
42
api-key
{secret}
api-key: {secret}
Request data validation
Authorize
Check user scopes in order to perform this action (scope = 'composition:create')
  • return 401 (Unauthorized) in case of invalid scope(s)
Validation data request
  1. Searching for the last scheduled ERLN task for this composition
    1. In case of error (ERLN task not found) - return 404 ('Not Found')
  2. Searching for the composition
    1. In case of error (composition was not found) - return 404 ('Not Found')
  3. Check the composition’s type
    1. In case of error (composition’s type isn’t Тemporary Disability) - return 400 ('Bad Request')
  4. Check the composition’s status
    1. In case of error (composition’s status isn’t “FINAL”) - return 400 ('Bad Request')
  5. Check the composition’s integration status
    1. In case of error (composition’s integration status isn’t “ERROR”) - return 400 ('Bad Request')
  6. Check the previous task status
    1. In case of error (task status is still in progress) - return 400 ('Bad Request')
In case if all previous checks were passed the function creates a new call task into ERLN, and completes its work with code 200
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 API-specification (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example
 Expand
titleExample
 Code Block
{
  "data": {
    "eta": "2022-10-24T12:35:49.956Z",
    "id": "89678f60-4cdc-4fe3-ae83-e8b3ebd35c59",
    "links": [
      {
        "entity": "eHealth/resources"
      }
    ],
    "status": "PENDING"
  }
}HTTP status codes
...
Only for active MPI record can be created medication request!
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
The request was successfully submitted for processing
 
3
400
Bad Request
4
400
This request is not allowed to be resubmitted (inappropriate status or type of request)
  1. Composition’s type isn’t Тemporary Disability
  2. Composition’s status isn’t “FINAL”
  3. Composition’s integration status isn’t “ERROR”
  4. Previous task status is still in progress
5
401
Unauthorized
Помилка підтвердження
6
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
7
404
No conclusion found
  1. ERLN task was not found
  2. Composition not found
86
404
Not Found
97
Специфічні
10
422
8
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
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...