| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
...
| id | page_properties_method_REST API |
|---|
...
Document type
...
Метод REST API
...
Guideline ID
...
GUI-0011
...
Author
...
@
...
Document version
...
1
...
Document status
...
DRAFT
...
Date of creation
...
ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
...
Date of update
...
ХХ.ХХ.ХХХХ (дата зміни версії)
...
Method API ID
...
API-001-001-001-0001
...
Microservices (namespace)
...
MPI
...
Component
...
Auth
...
Component ID
...
COM-001-001
...
Link на API-специфікацію
...
...
Resource
...
{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package
...
Scope
...
Protocol type
...
Request type
...
Sync/Async
...
Public/Private
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 parameters
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
composition_id
...
M
...
String ($uuid) (path)
...
Composition object ID
...
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
...
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
| Expand | ||
|---|---|---|
| ||
| Code Block | ||
| 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
This WS is designed to get declaration requests details
Key features
Only authenticated and authorized employee with appropriate scope can get declaration requests list.
The service can return only declaration request that was created in the same legal entity as the user or assigned to legal entity and shared
Logic
Get declaration request details from il.declaration_requests table by declaration request id from request
Generate URL to get signed_content (optional)
Generate URL only in case of:
channel = PIS and status APPROVED
Put url to urgent section
Render response according to specification.
Use ael service
Parameter | Source |
|---|---|
action | 'GET' |
bucket | 'DECLARATION_REQUESTS' |
resource_id | :DECLARATION_REQUEST_ID |
resource_name | signed_content |
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
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id |
| String | request identifier |
|
| 2 |
Request structure
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
Headers
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {{access_token}} | Authorization:Bearer {{access_token}} | ||
| 3 | X-Custom-PSK | {{secret}} | X-Custom-PSK:{{secret}} |
Request data validation
Authorize
Verify the validity of access token
in case of error - return 401 (“Invalid access token”) in case of validation fails
Verify that token is not expired
in case of error - return 401 (“Invalid access token”)
Check user scopes in order to perform this action (scope = 'declaration_request:read')
return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration_request:read”) in case of invalid scope(s)
Check that declaration request:
exists in il DB
is_shareable = true or channel = MIS
belongs to legal entity (get user from token, find employee associated with this user and ensure that this employee has at least one role in the same legal entity as in declaration request)
in case of error - return 404 ('not found')
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Print form is generated after approve declaration request, so in response on Get declaration request by id show fields contextand data_to_be_signed if DR approved.
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | 3 | 401 | Unauthorized | Помилка підтвердження |
| 4 | Специфічні | ||||
| 5 | 422 | Only for active MPI record can be created medication request!||||
| 1 | Базові | ||||
| 2 | 200 | Response |
| ||
| 3 | 401 |
| Access token validation failed | ||
| 4 | 401 | Invalid access token | |||
| 5 | 403 |
| Invalid scope | ||
| 6 | 403 | Your scope does not allow to access this resource. Missing allowances: declaration_request:read | |||
| 7 | 404 | not found | |||
| 8 | Специфічні | ||||
| 9 | |||||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...