ЕСОЗ - публічна документація

[DRAFT] patch_patients_composition__compositionId__erln [API-006-001-001-0210]

Owned by Serhii Boldin (SoE eHealth)
Last updated: yesterday at 8:33 PM by Anastasiia Prokhorova (SoE eHealth)
1 min read

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

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] patch_patients_composition__compositionId__erln [API-006-001-001-0210]

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

Purpose

This method allows to re-send the composition to ERLN (Electronic Register of temporary disability conclusions of the Pension Fund of Ukraine). Used only for the type of compositions - Тemporary Disability

Used in processes:

  1. Re-sending Тemporary Disability Composition to ERLN

Logic

This method allows to re-send Тemporary Disability Composition to ERLN in cases when the previous attempt of ERLN registration was unsuccessful, the description of the error is available and if all checks is passed.

Precondition:

  • 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

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

compositionId

 

String ($uuid)

(path)

Composition object ID

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

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

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

N/A

Response structure examples

See on API-specification

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

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

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

 

404

No conclusion found

  1. ERLN task was not found

  2. Composition not found

 

6

 

404

Not Found

 

 

7

Специфічні

8

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

ЕСОЗ - публічна документація