ЕСОЗ - публічна документація
[DRAFT] searchCompositions [API-006-001-001-0215]
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
- 1 Properties of a REST API method document
- 2 Purpose
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Authorize
- 10 Processing
- 11 Response structure examples
- 12 HTTP status codes
- 13 Post-processing processes
- 14 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
---|---|
Document title | [DRAFT] searchCompositions [API-006-001-001-0215] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-006-001-001-0215 |
Microservices (namespace) | MC |
Component | Compositions |
Component ID | COM-006-001 |
Link на API-специфікацію | https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/main/searchCompositions |
Resource | {{host}}/patients/{{patientId}}/composition |
Scope | composition:search |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This method is designed to search for a composition by the specified parameters and get a list of results that match these parameters.
Logic
Configuration parameters
N/A
Dictionaries
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | subject |
| string($uuid) | subject's MPI ID (patientID - incompatible with focus) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
2 | focus |
| string($uuid) | subject's MPI ID (patientID - incompatible with subject) | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
Request structure
See on API-specification
Headers
Request data validation
Authorize
Check user scopes in order to perform this action (scope = 'composition:search')
return 401 (Unauthorized) in case of invalid scope(s)
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 |
| 200 | Search results |
|
|
3 | Специфічні | ||||
4 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
ЕСОЗ - публічна документація