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

patch_patients_composition__compositionId__erln

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:

4. Re-sending Тemporary Disability Composition to ERLN

Specification

Link

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

Resource

/patients/composition/{compositionId}/erln

Scope

composition:create

Components

Compositions

Using Dictionaries

eHealth/resources

Using Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private/Internal

Public

 

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)

 

Input parameters

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

compositionId

 

String ($uuid)

(path)

Composition object ID

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

 

Request structure

See on SwaggerHub

 

Authorize

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

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

 

Headers

  • Content-Type: application/json

  • Authorization: Bearer {token}

  • api-key: {secret}

 

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

API paragraph not found

 

Response structure

See on SwaggerHub

Example:

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

Post-processing processes

API paragraph not found

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

200

The request was successfully submitted for processing

 

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

404

No conclusion found

  1. ERLN task was not found

  2. Composition not found

 

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