...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents | ||
|---|---|---|
|
Document type | Метод REST API |
|---|---|
Document title | [Document status] REST API [Назва методу] [ID методу] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-010-001-0311 |
Microservices (namespace) | ME |
Component | Service request |
Component ID | COM-007-010 |
Link на API-специфікацію | |
Resource | {{host}}/api/patients/{{patient_id}}/service_requests/{{service_request_id}} |
Scope | service_request:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
...
This method returns the details of the service request by identifier. without specifying the episode of care
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id |
| String | Unique patient identifier |
|
| 2 | service_request_id |
| String | Unique service request identifier |
|
Request structure
See on Apiary
See on API-specification (посилання на сторінку з API-специфікацією)
| Expand | ||
|---|---|---|
| ||
|
...
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer {token} |
|
| Authorization: Bearer {token} |
| 3 | api-key | {secret} | api-key: {secret} |
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
Get Service request by person_id and service_request_id from service_request (MongoDB)
Validate data consistency:
Ensure that requested Service requests have ABAC context
Return 403 ('Access denied') in case of error
Render a response according to specification with found Service requests entities.
Response structure examples
See on Apiary
See on API-specification (посилання на сторінку з API-специфікацією)
| Expand | ||
|---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 |
|
| ||
| 3 | 401 | Unauthorized |
| Помилка підтвердження | |
| 4 | 403 | Access denied | |||
| 5 | 403 | invalid scopes | |||
| 6 | 404 |
| Service request not found | ||
| 7 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 8 | Специфічні | ||||
| 9 |
| 422 | Only for active MPI record can be created medication request! |
|
|
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||
...