| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
...
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
This method allows to receive active person declarations issued by current legal entity (based on access_token). It can be used to check if Patient has active declarations in other Legal Entities
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
PHONE_TYPE
+DOCUMENT_TYPE
+DOCUMENT_RELATIONSHIP_TYPE
EMPLOYEE_TYPE
COUNTRYEDUCATION_DEGREEQUALIFICATION_TYPE
SPECIALITY_TYPE
SPEC_QUALIFICATION_TYPE
+DIVISION_TYPE
+ADDRESS_TYPE
SETTLEMENT_TYPE
STREET_TYPE
GENDER
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id |
| String |
|
|
| 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 | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {{access_token}} | M | Перевірка користувача | Authorization:Bearer {{access_token}} |
| 3 | api-key | {{secret}} |
...
Request data validation
Authorize
Request to process the request using a token in the headers
Validate mandatory query params
person_id (id)
Verify the validity of access token
Check user scopes in order to perform this action
Get legal_entity_id and division_id from current context
...
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
If no records found - return empty list
If record found and declarations.division_id = context.division_id - return short declaration details
...
Response code | HTTP Status code | Message | Internal name | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||||||
| 2 | 200 |
| Short declaration info if active declaration found AND issued by legal entity that is available for | ||||||||
| 3 | 401 | UnauthorizedПомилка підтвердження | 4 | 403 |
| if active declaration found issued by other (not available by access scopes) legal entity | |||||
| 54 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | 6 | 404 |
| if active declaration not found | ||
| 75 | |||||||||||
| 86 | Специфічні | ||||||||||
| 9 | 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 | ||||
|---|---|---|---|---|
|
...