...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Purpose
This method intended to get all Medication dispenses for the PHARMACY users
Logic
Service returns specified Medication dispenses related to the legal entity from token:
Get Medication dispenses from medication_dispenses DB (OPS).
Filter list above by submitted search parameters.
Render a response according to specification.
Configuration parameters
Access to the method is defined by the scope medication_dispense:read_pharm. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
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
...
composition_id
...
M
...
String ($uuid) (path)
...
Composition object ID
...
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
...
...
...
...
...
...
Properties of a REST API method document
...
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-005-008-001-0138
...
Microservices (namespace)
...
IL
...
Component
...
ePrescription
...
Component ID
...
COM-005-008
...
Link на API-специфікацію
...
...
Resource
...
{{host}}/api/pharmacy/medication_dispenses
...
Scope
...
medication_dispense:read_pharm
...
Protocol type
...
REST
...
Request type
...
GET
...
Sync/Async
...
Sync
...
Public/Private
...
Public
| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
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-005-008-001-0138 |
Microservices (namespace) | IL |
Component | ePrescription |
Component ID | COM-005-008 |
Link на API-специфікацію | |
Resource | {{host}}/api/pharmacy/medication_dispenses |
Scope | medication_dispense:read_pharm |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This method intended to get all Medication dispenses for the PHARMACY users
Logic
Service returns specified Medication dispenses related to the legal entity from token:
Get Medication dispenses from medication_dispenses DB (OPS).
Filter list above by submitted search parameters.
Render a response according to specification.
Configuration parameters
Access to the method is defined by the scope medication_dispense:read_pharm. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id | O | String | Medication dispense ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 2 | medication_request_id | O | String | Medication request ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 3 | legal_entity_id | O | String | Legal entity ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 4 | division_id | O | String | Division ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 5 | status | O | String | Status | PROCESSED |
| 6 | dispensed_from | O | String | date of dispense | 2017-09-01 |
| 7 | dispensed_to | O | String | date of dispense | 2017-10-01 |
| 8 | care_plan_id | O | String | care plan identifier | 8838982b-6a77-4cb5-87cd-cdb82eb55364 |
| 9 | page | O | Number | Page number | 2 |
| 10 | page_size | O | Number | A limit on the number of objects to be returned, between 1 and 300. Default: 50 | 50 |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
...
Request data validation
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
...
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Request data validation
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_dispense:read_pharm')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: medication dispense:read') in case of invalid scope(s).
Validate User
Extract client_id (legal_entity_id) from token.
Return empty array in case employee has no access to medication dispense.
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
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
...
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||||||
| 2 | 200 | Response |
| 3 | 401 | Invalid access token | Недійсний токен доступу | 4 | 401 | Unauthorized |
| Помилка підтвердження | ||
| 5 | 3 | 403 | Your scope does not allow to access this resource. Missing allowances: medication _ dispense:read_pharm | |||||||||||
| 6 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | |||||||||
| 7 | Специфічні | |||||||||||||
| 8 |
| 422 | Only for active MPI record can be created medication request! | Для вашої ролі відсутній доступ до цього ресурсу. Необхідний доступ на отримання інформації про відпущені рецепти | ||||||||||
| 4 | Специфічні | |||||||||||||
| 5 |
|
|
| |||||||||||
Post-processing processes
Description of actions performed on data after processingNo
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||