Info |
---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
...
Page Properties | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
This web service is designed to cancel episode in case it was entered in error
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
...
parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | patient_id |
| String | Patient identifier |
|
2 | episode_id |
| String | Episode identifier |
|
Request structure
See on Apiary
See on API-specification (посилання на сторінку з API-специфікацією)
Expand | ||
---|---|---|
| ||
|
...
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 | API-key | {{secret}} | API-key:{{secret}} |
Request data validation
Authorize
Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case of error return 401
Check user scopes in order to perform this action (scope = 'episode:write')
Return 403 in case invalid scope(s)
Validate token
check value of ALLOW_OTHER_LE_EMPLOYEES_TO_MANAGE_EPISODE variable in charts configuration
if its value is equal to false, verify that user’s employees from care_manager belongs to one of the user_id from token
in case of error - return 422 ('User is not allowed to perform this action')
otherwise, verify that user’s employees from care_manager belongs to the same Legal Entity as author of the episode
in case of error - return 422 ('User is not allowed to perfom this action')
...
Response structure examples
See on Apiary
See on API-specification (посилання на сторінку з API-специфікацією)
Expand | ||
---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | ||||
---|---|---|---|---|---|---|---|---|
1 | Базові | |||||||
2 | 202 |
|
| |||||
3 | 401 |
| Access token validation failed | |||||
4 | 401 | Unauthorized | Помилка підтвердження | 5 | 403 |
| Invalid scope | |
6 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | |||
75 | 404 | Patient not found |
| |||||
86 | 422 |
| Validation failed | |||||
97 | 422 | Managing_organization does not correspond to user`s legal_entity | ||||||
108 | 422 | User is not allowed to perform this action | ||||||
119 | Специфічні | |||||||
12 | 422 | Only for active MPI record can be created medication request!10 |
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 | ||||
---|---|---|---|---|
|
...