ЕСОЗ - публічна документація
[DRAFT] [NEW] Get Composition Configurations by search params [API-007-011-001-0480]
- Serhii.Matiushyn
- Anzhela Kovalenko (SoE eHealth)
REST API method / Метод REST API (настанова) (remove the link block before publishing the document)
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] [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) | ME |
Component | Compositions_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 |
|
Purpose
This method allows to get composition_configurations that are used for request validation on Create Composition method.
Logic
Service logic
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
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 |
|
|
|
|
|
| 2 |
|
|
|
|
|
Request structure
See on API-specification
Headers
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 from COMPOSITION_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 from COMPOSITION_CATEGORIES dictionary
Return 422 ("Incorrect value for query parameter category”) in case of error
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 401 | Invalid access token |
|
|
| 3 |
| 403 | Your scope does not allow to access this resource. Missing allowances: composition:read |
|
|
| 4 |
| 422 | Incorrect value for query parameter |
|
|
| 5 |
| 422 | Incorrect value for query parameter category |
|
|
| 6 |
| 422 | Required query parameter |
|
|
| 7 | Специфічні | ||||
| 8 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 |
| |
|
|
ЕСОЗ - публічна документація