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
Specification
Link | |
Resource | /patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/integrationData |
Scope | composition:read |
Components | |
Microservices | API paragraph not found |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
Preconditions
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
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.
Configurable parameters
Link to page with configurable parameters
VAR NAME:
EMAL_INTEGRATION_NEWBORN_CLIENTS_MEMBER_CODE_NAMES (Mapping request components by getComposition MVN (integration data))
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 |
Dictionaries
COMPOSITION_PROCESSING_STATUS (parameter “integrationStatus“ in response)
COMPOSITION_PROCESSING_SYSTEMS (parameter “component“ in response):
DIIA
ERLN
MJU_DRACS
COMPOSITION_PROCESSING_TASKS (parameter “type“ in response):
CANCEL_ERLN_RECORD
CREATE_ERLN_RECORD
NEWBORN_GET_COMPOSITION
NEWBORN_POST_COMPOSITION
COMPOSITION_PROCESSING_TASK_STATUS (parameter “taskStatus“ in response):
DONE
FAILED
PENDING
ERLN_RESULT_CODES (parameters “statusCode“ and “statusMessage“ in response - for ERLN only):
Request structure
Description:
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)
Headers
Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}
Response structure
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 and DRACSG integration process:
Cancellation of composition type “temp_disability“. Response with information on the ERLN integration process:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Composition found | If the request is completed and the information is found |
404 | Composition not found | In case the information is not found for any reason |