| Info |
|---|
| Note |
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
|
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input The method is designed for getting an HTML template of informational reference for print.
The template can be getted only by a user who has access to the MC.
The template can be getted by MC in any status (PRELIMINARY, FINAL, AMENDED, ENTERED_IN_ERROR).
Generation works by the MAN component.
Saving the generated content at the component level is not expected. If it is necessary to get the information reference again, then a new request is made and it is generated anew.
Used in processes:
Create/Sign composition (general process)
Refinement (preperson -> person) for MVTN
Creating "a replacement" composition
Logic
...
Configuration parameters
Link to configurable parameters
VAR_NAME: EMAL_PRINT_FORM_ALLOWED_TEMPLATE_IDS_BY_CATEGORY
“1001” for information reference by CATEGORIES of TYPE=TEMP_DISABILITY
“1000“ for information reference by CATEGORIES of TYPE=NEWBORN
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | composition_idcompositionId | M | String($uuid) (path) | Composition object ID | 89678f60 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Description of the REST API response structure, example
...
| title | Example |
|---|
...
patientId |
| String($uuid) (path) | Patient object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | |
| 3 | episodeId |
| String($uuid) (path) | Episode of Care object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 4 | encounterId |
| String($uuid) (path) | Encounter object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 5 | templateId | 1000, 1001 | String(query) | ID of the template (man service) used to render the form | 1000 |
Request structure
See on API-specification
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
Headers
Request data validation
Authorize
Check user scopes in order to perform this action (scope = 'composition:read')
return 401 (Unauthorized) in case of invalid scope(s)
The compositionId in the request is checked:
IF it is valid
THEN the process continues
ELSE an error 404 is returned.
Processing
N/A
Response structure examples
See on API-specification
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||||
| 2 | 1000200 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | 3 | 401 | Unauthorized | Помилка підтвердження | Form exists | ||
| 3 | 404 |
| Form not found | |||||||||
| 4 | Специфічні | |||||||||||
| 5 | 422Only for active MPI record can be created medication request! | |||||||||||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...