Versions Compared

Old Version 14

changes.mady.by.user Alexander Fedotov (SoE eHealth)

Saved on

compared with

New Version 15

changes.mady.by.user Alexander Fedotov (SoE eHealth)

Saved on

Key

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

...

  • The method can only be executed by a user with access to composition.

  • The method can only be executed for a composition with the status:

    • FINAL

    • AMENDED

    • ENTERED-IN-ERROR

Logic*

Потрібно по пунктах описати логіку методу API або додати діаграму

Global and configurable parameters

Потрібно вказати посилання на сторінки з описом глобальних та конфігураційних параметрів

Input parameters

Input parameter

Values

Type

Description

Example

compositionId

 

String($uuid) (path)

Composition object ID

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

patientId

 

String($uuid) (path)

Patient object ID

89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

episodeId

 

String($uuid) (path)

Episode of Care object ID

89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

encounterId

 

String($uuid) (path)

Encounter object ID

89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

...

  • Content-Type: application/json

  • Authorization: Bearer {token}

  • api-key: {secret}

Request data validation*

Валідація даних

Наприклад:

  1. Validate request using JSON schema

    1. In case validation failed - generate 422 error

Processing*

Потрібно описати процеси, які відбуваються з даними

1. Using global parameters

Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри

Response structure*

See on SwaggerHub

...

  • Creation of composition type “newborn“. Response with information on DIIA and DRACSG integration process:

Expand
titleResponse example
Code Block
[
  {
    "component": "MJU_DRACS",
    "details": {
      "personId": "fe88454e-7867-4795-8ab5-1fa54493a3d6",
    },
    "integrationStatus": "DONE",
    "taskStatus": "DONE",
    "type": "NEWBORN_POST_COMPOSITION",
    "updatedAt": "2022-09-14T08:35:03.383Z"
  }
]
Code Block
[
  {
    "component": "DIIA",
    "details": {
      "documentId": "АЕ123219",
      "documentType": 1,
      "compositionTitle": "XXT7-5BBE-827X-X7MA"
    },
    "integrationStatus": "DONE",
    "taskStatus": "DONE",
    "type": "NEWBORN_GET_COMPOSITION",
    "updatedAt": "2022-09-14T07:47:00.388Z"
  },
  {
    "component": "MJU_DRACS",
    "details": {
      "personId": "8cd52d25-1136-47ef-a0a7-efac9b941b67"
    },
    "integrationStatus": "DONE",
    "taskStatus": "DONE",
    "type": "NEWBORN_POST_COMPOSITION",
    "updatedAt": "2022-09-14T08:35:11.330Z"
  }
]

  • Cancellation of composition type “temp_disability“. Response with information on the ERLN integration process:

Expand
titleResponse example
Code Block
[
  {
    "component": "ERLN",
    "details": {
      "SL_NUM": "520-2000002848-1",
      "SL_REG_DATETIME": "2022-09-22T12:36:08Z",
      "SL_STOP": "2022-09-30T00:00:00Z",
      "SL_START": "2022-09-20T00:00:00Z",
      "IC_NUM": "520"
    },
    "integrationStatus": "DONE",
    "statusCode": 1101,
    "statusMessage": "ЕЛН створено успішно",
    "taskStatus": "DONE",
    "type": "CREATE_ERLN_RECORD",
    "updatedAt": "2022-09-22T09:37:07.290Z"
  },
  {
    "component": "ERLN",
    "details": {
      "SL_NUM": "520-2000002848-2",
      "SL_REG_DATETIME": "2022-09-22T12:36:08Z",
      "IC_NUM": "520"
    },
    "integrationStatus": "DONE",
    "statusCode": 5101,
    "taskStatus": "DONE",
    "type": "CANCEL_ERLN_RECORD",
    "updatedAt": "2022-09-22T09:39:33.749Z"
  }
]

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes*

HTTP status code

Message

What caused the error

 200

 

 

 404

 

 

...