ЕСОЗ - публічна документація
REST API Get Specimen details [API-007-012-001-0495]
Analytics
- 1 Properties of a REST API method document
- 2 Purpose
- 2.1 Key points
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Authorization
- 9.2 Validate Patient
- 9.3 Validate Specimen
- 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 | REST API Get Specimen details [API-007-012-001-0495] |
Guideline ID | GUI-0011 |
Author | @Serhii.Matiushyn |
Document version | 1 |
Document status | PROD |
Date of creation | 30.01.2025 |
Date of update | 18.02.2025 |
Method API ID | API-007-012-001-0495 |
Microservices (namespace) | ME |
Link на API-специфікацію | https://esoz.docs.apiary.io/#reference/medical-events/specimen/get-specimen-details |
Resource | {{host}}/api/patients/patient_id/specimens/{{id}} |
Scope | specimen:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This WS allows to get a single Specimen by its identifier.
Key points
Only authenticated and authorized employee with appropriate scope can get a Specimen.
Method returns a single Specimen that belongs to the specified patient.
ABAC rules are used here.
Logic
[DRAFT] BP-ESOZ-028-0003 [MIS] Отримання інформації Зразка при взаємодії з пацієнтом
Service returns specified Specimen related to the patient:
Get Specimen by ID from specimens collection (MongoDB)
Render a response according to specification
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique patient identifier |
|
| 2 | id | M | String | Unique specimen identifier | |
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 = 'specimen:read')
return 403 “Your scope does not allow to access this resource. Missing allowances: specimen:read” in case of invalid scope(s)
Access to the resource is also managed by ABAC module
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Validate Specimen
Get Specimen identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check Specimen belongs to patient
Return 404 ('not found') 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: specimen:read |
| Відсутня можливість доступу до цього ресурсу через брак наявності скоупу: specimen:read |
| 4 |
| 404 | not found |
| Не знайдено |
Post-processing processes
N/A
Technical modules where the method is used
Related content
ЕСОЗ - публічна документація