/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [Document statusDRAFT] REST API [Назва методу] [ID методуNEW] Get Composition Configurations by search params [API-007-011-001-0480] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-011-001-0480 |
Microservices (namespace) | MPIME |
Component | AuthCompositions_ME |
Component ID | COM-007-011 |
Link на API-специфікацію | |
Resource | {{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package |
Scope | |
Protocol type | REST |
Request type | |
Sync/Async | |
Public/Private |
...
Select composition_configurations records from PRM filtered by type and category from the request
Exclude from composition_configurations.settings json elements where check = “Any”
Return response to the client according to schema
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 N/A
Dictionaries
N/A
Input 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 | ||
|---|---|---|
| ||
|
Headers
...
...
Request data validation
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
...
...
...
...
Request data validation
Authorization
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 and client scopes in order to perform this action (scope = 'composition:read')
return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)
Validate query parameters
Validate required query parameter type is filled
Return 422 ("Required query parameter
typeis missing”) in case of error
Validate value in query parameter type is fromCOMPOSITION_TYPES dictionary
Return 422 ("Incorrect value for query parameter
type") in case of error
Validate required query parameter category is filled
Return 422 ("Required query parameter category is missing”) in case of error
Validate value in query parameter category is fromCOMPOSITION_CATEGORIES dictionary
Return 422 ("Incorrect value for query parameter category”) in case of error
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | |||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||||
| 2 | 401 | Invalid access token | |||||||
| 3 |
| 401 | Unauthorized |
| Помилка підтвердження4 | 403 | Your scope does not allow to access this resource. Missing allowances: composition:read | ||
| 5 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | ||||
| 6 | 4 | 422 | Incorrect value for query parameter | ||||||
| 75 | 422 | Incorrect value for query parameter category | |||||||
| 86 | 422 | Required query parameter | |||||||
| 97 | Специфічні | ||||||||
| 10 |
| 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 N/A
Technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||
...