ЕСОЗ - публічна документація
REST API Get Medication Request Printout Form [API-005-008-002-0152]
- 1 Properties of a REST API method document
- 2 Purpose
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Authorize
- 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 Medication Request Printout Form [API-005-008-002-0152] |
Guideline ID | GUI-0011 |
Author | @Iryna Lishtaba (SoE eHealth) |
Document version | 1 |
Document status | DRAFT |
Date of creation | 03.03.2025 |
Date of update | 04.03.2025 |
Method API ID | API-005-008-002-0152 |
Microservices (namespace) | IL |
Link на API-специфікацію | |
Resource | {{host}}/api/persons/{{person_id}}/medication_requests/{{id}}/printout_form |
Scope | medication_request:details |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This WS allows to generate Printout form by medication request id.
Logic
Процеси роботи з випискою електронних рецептів
Configuration parameters
Access to the method is defined by the scope medication_request:details. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | person_id | M | String | person_id of a patient | 5e661b15-a39a-4713-b18e-ba03a4a48ecc |
| 2 | id | M | String | Medication request identifier | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Request structure
See on API-specification
Headers
Request data validation
Perform Get medication requests details with corresponding validations.
Authorize
Verify the validity of access token
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 scopes in order to perform this action (scope = 'medication_request:details')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: medication_request:details') in case of invalid scope(s).
Access to the resource is also managed by ABAC rules (EN) .
Processing
Get Medication request by ID
Perform Get medication requests details with corresponding validations.
Generate Printout form
Invoke MAN to render printout form.
Request mapping:
Parameter | Source |
|---|---|
id | MEDICATION_REQUEST_REQUEST_PRINTOUT_FORM_TEMPLATE_ID |
Logic of generation of fields for the printout form is described in Sign Medication Request Request.
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: medication_request:details |
| Для вашої ролі відсутній доступ до цього ресурсу. Необхідний доступ на отримання деталей рецепта |
| 4 | Специфічні | ||||
| 5 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
Related content
ЕСОЗ - публічна документація