Purpose
This WS is designed to return healthcare service details.
Key points
Only authenticated and authorized user with an appropriate scope can get healthcare services list.
WS returns only details of healthcare service related to the same legal entity as the user.
Specification
Page Properties |
---|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/healthcare-services/get-healthcare-service-details-by-id | Посилання на Apiary або Swagger | Resource | /api/healthcare_services/{{id}} | Посилання на ресурс, наприклад: /api/persons/create | Scope | healthcare_service:read | Scope для доступу | Components | ePrescriptionHealthcare services | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? |
|
Logic
Get data from healthcare_services by id (PRM DB).
Render a response according to specification.
Preconditions
API paragraph not found
...
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:read. 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 |
|
...