| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
...
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
Get approval by patient_id and approval id from approvals collection (MongoDB)
Render a response according to specification.
Block “authentication_method_current” represents the type of auth method and the telephone number (for methods with ability to specify it)
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 | |
|---|---|---|---|---|---|
| 1 | patient_id |
| String | identifier of the patient |
|
| 2 | id |
| String | identifier of the approval |
|
...
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | Authorization:Bearer c2778f3064753ea70de870a53795f5c9 |
| 3 | api-key | uXhEczJ56adsfh3Ri9SUkc4en | Секретний ключ | api-key:uXhEczJ56adsfh3Ri9SUkc4en |
Request data validation
Authorize
Verify the validity of access token
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 = 'approval:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: approval:read') in case of invalid scope(s)
Request to process the request using a token in the headers
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
...
Extract user_id from token.
Check user has an active declaration with a patient from URL (can get all approvals) or approval is granted to user (can get own approval: granted_to OR created_by):
Return 200 with empty array in case the employee doesn't have an active declaration with the patient or approval is granted to user
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
...
Response code | HTTP Status code | Message | Internal name | Description | |||
|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||
| 2 | 200 | ||||||
| 3 | 401 | Invalid access token | |||||
| 4 | 403 | Your scope does not allow to access this resource. Missing allowances: approval:read | |||||
| 5 | 404 | Not found | |||||
| 36 | 404 | Person is not found | |||||
| 47 | Специфічні | ||||||
| 5 | 422 | Only for active MPI record can be created medication request!8 | |||||
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 | ||||
|---|---|---|---|---|
|
...