Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

4. Re-sending Тemporary Disability Composition to ERLN

Specification

Link

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

Resource

/patients/composition/{compositionId}/erln

Scope

composition:create

Components

Compositions

Using Dictionaries

API paragraph not foundeHealth/resources

Using Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private/Internal

Public

...

Input parameter

Values

Type

Description

Example

compositionId

String ($uuid)

(path)

Composition object ID

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

Request structure

See on SwaggerHub

Authorize

API paragraph not found

Headers

API paragraph not foundCheck 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')

...

API paragraph not found

Response structure

See on SwaggerHub

Example:

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

...