...
...
...
...
This method allows to get detailed information of the Medication dispense for the PHARMACY users. To obtain Medication dispense list Get Medication dispenses by search params by Pharmacy User should be used.
Specification*
...
Link
...
...
Посилання на Apiary або Swagger
...
Resource
...
/api/pharmacy/medication_dispenses/{{id}}
...
Посилання на ресурс, наприклад: /api/persons/create
...
Scope
...
medication_dispense:read_pharm
...
Scope для доступу
...
Components
...
ePrescription
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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
Service returns specified Medication dispense related to the legal entity from token:
Get Medication dispense by ID from medication_dispenses DB (OPS).
Validate data consistency:
Ensure that requested Medication dispense relates to requested legal entity
Return 404 ('not_found') in case of error.
Render a response according to specification.
Preconditions
No
Global and configurable parameters
No
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
id
...
String
...
Medication Dispense Response Identifier. Required.
...
a89f6a26-4221-4597-a1d2-542d5e40b565
Filters
No
Request structure
API paragraph not found
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_pharm') in case of invalid scope(s).
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request
API paragraph not found
Request data validation
Validate Medication dispense
Get Medication dispense identifier from the URL
Check Medication dispense exists in DB (OPS)
Return 404 ('not_found') in case of error.
Check Medication dispense belongs to legal entity
Return 404 ('not_found') in case of error.
Validate User
Extract client_id (legal_entity_id) from token
Return 404 ('not_found') in case employee has no access to medication dispense.
Parameters that are used when processing the request
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
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
No
HTTP status codes
...
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: medication_dispense:read_pharm
...
404
...
Not found
...
Medication dispense exists in DB (OPS) check fails.
Medication dispense belongs to legal entity check fails.
In case employee doesn`t have access to medication dispense.
Backward compatibility
API paragraph not foundThe page is not supported. The method requirements can be found here https://e-health-ua.atlassian.net/wiki/x/64BLFwQ