| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
...
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
This web service returns episodes, that patient gave approvals to read by a current employee.
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
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id |
| String | Patient identifier |
|
| 2 | page |
| Number | Page number |
|
| 3 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
| 4 | code |
| String | current diagnosis code |
|
...
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json |
| Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {{access_token}} |
| Перевірка користувача | Authorization:Bearer {{access_token}} |
| 3 | API-key | {{secret}} |
| Секретний ключ | API-key:{{secret}} |
Request data validation
Authorize
Describe the Request to process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the APIthe 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 error return 401
Check user scopes in order to perform this action (scope = 'episode:read')
Return 403 in case invalid scope(s)
Processing
Select list of employees from PRM related to the current user in the current legal_entity, using data from the token
Select all active approvals from Medical Events, where these employees referenced as a `granted_to`
Select all the episodes from ME that are referenced as `granted resources` in the approvals from step 2.
Show episodes to the client ordered by inserted_at
...
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 | ||||
|---|---|---|---|---|
|
...