Purpose
This WS is designed to update previously created healthcare service for the division of legal entity
...
Only authenticated and authorized user with an appropriate scope can update healthcare service.
Healthcare service can be updated for PRIMARY_CARE, EMERGENCY, OUTPATIENT or PHARMACY legal entity.
Healthcare service can be updated for legal entities in ACTIVE or SUSPENDED statuses.
Only active healthcare service can be updated.
Only comment, available_time, restricted_periods fields can be updated.
Specification
| Page Properties |
|---|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/healthcare-services/update-healthcare-service | Посилання на Apiary або Swagger | Resource | /api/healthcare_services/{{id}} | Посилання на ресурс, наприклад: /api/persons/create | Scope | healthcare_service:write | Scope для доступу | Components | Healthcare services | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | PATCH | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? |
|
Logic
Update healthcare service in healthcare_services table (PRM DB) with data from request and additional fields:
comment = $.comment;
available_time = $.available_time;
not_available = $.not_available;
updated_at = now();
updated_by = user_id from access token.
Preconditions
API paragraph not found
Global and configurable parameters
No
Healthcare services hould be created
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
id | | String | Healthcare service identifier. Optional. | d290f1ee-6c54-4b01-90e6-d701748f0851 |
...
No
Dictionaries
API paragraph not found
Request structure
Example:
...
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
}
} |
|
Post-processing processes
...
HTTP status codes
| Page Properties |
|---|
HTTP status code | Message | What caused the error |
|---|
200 | Response | | 401 | Invalid access token | | 403 | Your scope does not allow to access this resource. Missing allowances: healthcare_service:write. forbidden
| 2. Healthcare service belongs to legal entity id from access token check failed. | 404 | Not found | Healthcare service exists in PRM DB check failed | 409 | | | 422 | Error Should not be present when all_day = true. Should be present when all_day = false. Should be greater then start.
| |
|
...