Table of Contents |
---|
Properties of a REST API method document
...
id | page_properties_method_REST API |
---|
...
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-0139
...
Microservices (namespace)
...
IL
...
Component
...
ePrescription
...
Component ID
...
COM-005-008
...
Link на API-специфікацію
...
...
Resource
...
{{host}}/api/cabinet/medication_dispenses/{{id}}
...
Scope
...
medication_dispense:read_pharm
...
Protocol type
...
REST
...
Request type
...
GET
...
Sync/Async
...
Sync
...
Public/Private
...
Public
Purpose
This method allows you to get detailed information about the dispensing of medicines for a specific ID.
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.
Технічний опис бізнес-процесу погашення рецепту в ЦБД ЕСОЗ
Процеси роботи з погашенням електронних рецептів
Configuration parameters
No
Dictionaries
Input parameters
Description of input parameters
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
id
...
M
...
String
...
Medication Dispense Response Identifier
...
a89f6a26-4221-4597-a1d2-542d5e40b565
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
...
title | Example |
---|
...
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_pharm') in case of invalid scope(s).
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.
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
...
title | Example |
---|
...
Table of Contents |
---|
Properties of a REST API method document
Page Properties | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This method allows you to get detailed information about the dispensing of medicines for a specific ID.
Logic
Configuration parameters
N/A
Dictionaries
PROVIDING_CONDITION
LICENSE_TYPE
MEDICAL_PROGRAM_TYPE
FUNDING_SOURCE
MR_BLANK_TYPES
MEDICATION_FORM
FORM_PHARM_LIST
+ADDRESS_TYPE
COUNTRY
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
+DIVISION_TYPE
POSITION
MEDICATION_FORM
MEDICATION_UNIT
PROVIDING_CONDITION
eHealth/clinical_impression_patient_categories
FUNDING_SOURCE
MR_BLANK_TYPES
MEDICATION_REQUEST_INTENT
MEDICATION_REQUEST_CATEGORY
MEDICATION_REQUEST_REJECT_REASON
MEDICATION_REQUEST_BLOCK_REASON
MEDICATION_REQUEST_PRIORITY
FORM_PHARM_LIST
FORM_PHARM_LIST
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | id | M | String | Medication Dispense Response Identifier | a89f6a26-4221-4597-a1d2-542d5e40b565 |
Request structure
See on API-specification
Expand | ||
---|---|---|
| ||
|
Request data validation
Authorize
Request to process the request using a token in the headers
Headers
Processing
N/A
Response structure examples
See on API-specification
Expand | ||
---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 |
200 |
Invalid access token
Недійсний токен доступу
403
Your scope does not allow to access this resource. Missing allowances: medication_dispense:read_pharm
Для вашої ролі відсутній доступ до цього ресурсу. Необхідний доступ на перегляд співробітником аптеки деталей погашення рецепта
404
not_found
не знайдено
Специфічні
Response | |||||
3 | Специфічні | ||||
4 |
Post-processing processes
Description of actions performed on data after processingN/A
Technical modules where the method is used
List of pages describing technical modules where the method is usedN/A
Page Properties Report | ||||
---|---|---|---|---|
|
...