| Info |
|---|
| Info |
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
...
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
Get client_id from token as legal entity identifier
Define all the divisions of the legal entity
Get and render all the records with defined divisions from medical_program_provision table filtered by search params.
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 | composition_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | |||||
| 2 |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | Тип контенту | Content-Type:application/json | |
| 2 | Authorization | Bearer F3GF124Df565FDS234SDF34 | Перевірка користувача | Authorization:Bearer F3GF124Df565FDS234SDF34 | |
| 3 | api-key | aDGFDFGT46S5gFGD | Секретний ключ | api-key:aDGFDFGT46S5gFGD |
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 = 'medical_program_provision:read')
return 403 “Your scope does not allow to access this resource. Missing allowances: medical_program_provision:read” in case of invalid scope(s)
Request to process the request using a token in the headers
Validate legal entity
Extract client_id from token.
Check client scopes in order to perform this action (scope = 'medical_program_provision:read')
in case of error - return 403 “Your scope does not allow to access this resource. Missing allowances: medical_program_provision:read”
Check legal entity status (status = ACTIVE, SUSPENDED)
In case of error - return 422 “Legal entity is not active”
...
Response code | HTTP Status code | Message | Internal name | Description | |||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||||
| 2 | 200 | ||||||||
| 3 | 401 | Invalid access token | |||||||
| 4 | 401 | UnauthorizedПомилка підтвердження | 5 | 403 | Your scope does not allow to access this resource. Missing allowances: medical_program_provision:read | ||||
| 65 | 422 | Legal entity is not active | |||||||
| 76 | Специфічні | ||||||||
| 8 | 422 | Only for active MPI record can be created medication request!7 | |||||||
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 | ||||
|---|---|---|---|---|
|
...