ЕСОЗ - публічна документація
[DRAFT] getIntegrationData [API-006-001-001-0217]
- Serhii Boldin (SoE eHealth) (Unlicensed)
- Anzhela Kovalenko (SoE eHealth)
- Anastasiia Prokhorova (SoE eHealth)
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
- 1 Properties of a REST API method document
- 2 Purpose
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Authorize
- 10 Processing
- 11 Response structure examples
- 11.1 Response examples:
- 12 HTTP status codes
- 13 Post-processing processes
- 14 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] getIntegrationData [API-006-001-001-0217] |
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-0217 |
Microservices (namespace) | MC |
Component | Compositions |
Component ID | COM-006-001 |
Link на API-специфікацію | https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/main/getIntegrationData |
Resource | {{host}}/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/integrationData |
Scope | composition:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
The method is designed to obtain information on the integration processes of interaction with third-party registries in the context of compositions. When composition data is transferred to an external registry and processed there, the method returns the status of data processing by the third-party registry.
Integration with the following third-party registries is implemented:
Electronic sick leave register (ERLN) - for MVTN (temporary desability).
State register of acts of civil status of citizens (DRACSG) - for MVN (newborn).
Also, the method transmits integration data of DIIA processing.
Getting integration data processes depends on the type of composition.
Used in processes:
Create/Sign composition (general process)
Refinement (preperson -> person) for MVTN
Creating "a replacement" composition
Logic
An authorized user with MIS creates and signs a composition, information from which can be used in a third-party registry.
The signed composition is stored in the ESOZ.
An authorized user can make a request and receive in response the status of processing in a third-party register.
Configuration parameters
Link to page with configurable parameters
VAR NAME:
EMAL_INTEGRATION_NEWBORN_CLIENTS_MEMBER_CODE_NAMES (Mapping request components by getComposition MVN (integration data))
Dictionaries
COMPOSITION_PROCESSING_STATUS (parameter “integrationStatus“ in response)
COMPOSITION_PROCESSING_SYSTEMS (parameter “component“ in response):
COMPOSITION_PROCESSING_TASKS (parameter “type“ in response):
COMPOSITION_PROCESSING_TASK_STATUS (parameter “taskStatus“ in response):
ERLN_RESULT_CODES (parameters “statusCode“ and “statusMessage“ in response - for ERLN only):
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 |
Request structure
See on API-specification
Headers
Request data validation
Authorize
A token in the headers.
Check user scopes in order to perform this action (scope = 'composition:read')
return 401 (Unauthorized) in case of invalid scope(s)
Processing
N/A
Response structure examples
See on API-specification
In addition to parameters from the Dictionaries, the response contains the following subparameters, depending on parameter values:
“updatedAt” - the date of the last update of the status of the integration process
“details“ - the data set defined by the integration component:
“component“: “MJU_DRACZ“
"type": "NEWBORN_POST_COMPOSITION"
“personId“ - the identifier of the created record about the identified child.
“component“: “ERLN“
"type": "CREATE_ERLN_RECORD”
“SL_NUM” - ELN registration number
“SL_REG_DATETIME” - ELN registration date and hour
“SL_STOP” - ELN closing date
“SL_START” - ELN open (extension) date
“IC_NUM” - Number of temporary disability case
"type": "CANCEL_ERLN_RECORD”
"SL_NUM" - ELN registration number
"SL_REG_DATETIME" - ELN registration date and hour
"IC_NUM" - Number of temporary disability case
Response examples:
Creation of composition type “temp_disability“. Response with information on the ERLN integration process:
Creation of composition type “newborn“. Response with information on DIIA integration process:
Creation of composition type “newborn“. Response with information on DRACSG integration process:
Cancellation of composition type “temp_disability“. Response with information on the ERLN integration process:
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 200 | Composition found | If the request is completed and the information is found |
|
| 3 |
| 404 | Composition not found | In case the information is not found for any reason |
|
| 4 | Специфічні | ||||
| 5 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
ЕСОЗ - публічна документація