| Note |
|---|
| Info |
REST API method / Метод REST API (настанова) Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
|
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
No
Input parameters
Description of 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 (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
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 1f1fa-1f1e6 Sign Medication Request Request.
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
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
No
Technical modules where the method is used
List of pages describing technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...