| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] REST API Invalidate Specimen [API-007-012-001-0500] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-012-001-0500 |
Microservices (namespace) | ME |
Component | Specimen |
Component ID | COM-007-012 |
Link на API-специфікацію | |
Resource |
/api/patients/{{patient_id}}/specimens/{{id}}/actions/invalidate | |
Scope | specimen:invalidate |
|---|---|
Protocol type | REST |
Request type | PATCH |
Sync/Async | Async |
Public/Private | Public |
Purpose
This WS allows to mark Specimen as unavailable.
...
Only authenticated and authorized employee with appropriate scope can update a Specimen.
DS isn't used here.
The specimen is invalidated asynchronously
Logic
Configuration parameters
N/A[DRAFT] BP-ESOZ-028-0009 [MIS] Позначення Зразка недоступним без взаємодії з пацієнтом
Configuration parameters
BLOCK_UNVERIFIED_PARTY_USERS
BLOCK_DECEASED_PARTY_USERS
Dictionaries
specimen_invalidate_reasonshttps://e-health-ua.atlassian.net/wiki/spaces/EH/pages/17629119370/RC.+Specimen+dictionaries+and+configurable+parameters#Dictionaries
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
...
Extract client_id from token
Check legal entity status (status = ACTIVE)
In case of error - return 409 ('client“client_id refers to legal entity that is not active'active”)
Validate data consistency
Ensure that submitted Specimen relates to the Patient (from URL)
in case of error - return 404 (not found“not found”)
Validate status transition
Get Specimen by id
Check Specimen’s status is available
in case of error - return 409 ('Specimen “Specimen is not in available status'status”)
Validate request
Validate request by schema and return 422 error code with the list of validation errors in case of fails. User fills following fields in the request:
...
Check that value is in allowed values from
specimen_invalidate_reasonsdictionary.in case of error - return 422 ('value “value is not allowed in enum'enum”)
Processing
Create job and return it’s id.
Update specimen record with following:
status = unavailable
status_reason = $.status_reason
updated_at = current datetime
updated_by = user_id from token
...
Response code | HTTP Status code | Message | Internal name | Description | |||
|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||
| 2 | 200401 | Invalid access token |
| Недійсний токен доступу | |||
| 3 | 401 | Invalid access token403 | Access denied. Party is not verified |
| У доступі відмовлено. Працівник не верифікований | ||
| 4 | 403403 | Access denied. Party is deceased |
| У доступі відмовлено. Працівник померлий | |||
| 5 | 403403 | Your scope does not allow to access this resource. Missing allowances: specimen:invalidate |
| Відсутня можливість доступу до цього ресурсу через брак наявності скоупу: specimen:invalidate | |||
| 6 | 404 | not found |
| Не знайдено | |||
| 7 | 409409 | client_id refers to legal entity that is not active |
| client_id відноситься до юридичної особи, яка неактивна в системі | |||
| 8 | 409 | Specimen is not in available status |
| 8 | 422 | Зразок не в статусі "доступний" | |
| 9 | 422 | value is not allowed in enum |
| Недопустиме значення | |||
Post-processing processes
...
Technical modules where the method is used
N/A