| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| 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-002-0158
...
Microservices (namespace)
...
IL
...
Component
...
ePrescription
...
Component ID
...
COM-005-008
...
Link на API-специфікацію
...
...
Resource
...
{{host}}/api/pharmacy/medication_requests/{{id}}/actions/block
...
Scope
...
medication_request:block_pharm
...
Protocol type
...
REST
...
Request type
...
PATCH
...
Sync/Async
...
Sync
...
Public/Private
...
Public
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
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
...
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
Request data validation
...
| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This WS is designed to block previously created Medication request with indicating block_reason_code and block_reason.
Key points
Only authenticated and authorized user with appropriate scope and ‘PHARMACIST’ employee can block Medication request.
In the response of this endpoint legal entity, division and employee details are trimmed.
Medication request can be blocked only from ‘ACTIVE' status.
Logic
Service logic
Service logic
Update Medication request in OPS DB:
set is_blocked = trueset blocked_to = $.blocked_to OR $.medication_request.dispense_valid_to date + 23:59 time (in case blocked_to is absent in request)
set blocked_by_legal_entity_id = legal_entity_id (client_id) from token
set block_reason_code = $.block_reason_code
set block_reason = $.block_reason
set updated_by = user_id
set updated_at = now()
Send SMS for personIf Medication request has program with medical program settingmedication_request_notification_disabled=true, then don't send SMS.Else:Get authentication_method of person from MPIIf authentication_method == OTP, then send SMS to a person from Medication request:Generate SMS textget template fromblock_template_smsparameterenrich template with data from Medication request
Send SMS to a person
Return Medication request data with trimmed information about legal entity, division and employee
Add new record in Event manager:
field | value |
|---|---|
|
|
|
|
| $.id |
| true |
| $.update_at |
| $.changed_by |
Configuration parameters
No
Dictionaries
MEDICATION_REQUEST_BLOCK_REASON
MEDICATION_REQUEST_INTENT
MEDICATION_REQUEST_CATEGORY
MEDICATION_REQUEST_PRIORITY
eHealth/SNOMED/additional_dosage_instructions
eHealth/SNOMED/anatomical_structure_administration_site_codes
eHealth/SNOMED/route_codes
eHealth/SNOMED/administration_methods
eHealth/SNOMED/dose_and_rate
eHealth/ICD10_AM/condition_codes
eHealth/ICPC2/condition_codes
ADDRESS_TYPE
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
DIVISION_TYPE
POSITION
MEDICATION_FORM
MEDICATION_UNIT
eHealth/clinical_impression_patient_categories
LICENSE_TYPE
FUNDING_SOURCE
MR_BLANK_TYPES
MEDICATION_REQUEST_REJECT_REASON
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | 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 | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | Authorization:Bearer c2778f3064753ea70de870a53795f5c9 |
| 3 | X-Custom-PSK | X-Custom-PSK: a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4 | X-Custom-PSK: a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4 |
Request data validation
Authorization
Verify the validity of access token
in case of error - 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:block_pharm')
return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_request:block_pharm”) in case of invalid scope(s)
Validate request
Validate request using JSON schema
in case of error - return 422
Validate Medication request
Get Medication request identifier from the URL. Check Medication request exists in OPS DB
in case of error - return 404 (“Medication request does not exist")
Validate user
Medication Request blocking is allowed for user if he has active and approved employee with employee_type = ‘PHARMACIST’
in case of error - return 409 ("Only pharmacist can block medication request")
Validate legal_entity
If MR still blocked (blocked_to > now()) and MR.blocked_by_legal_entity_id is not null - check that match with client_id from token
in case of error - return 409 ("It is not allowed to block medication request that has been blocked from another legal entity")
Validation transition
Get Medication request by $.id in OPS DB. Check that Medication request status = ‘ACTIVE’
in case of error - return 409 ("Medication request must be in active status")
Get Medication request by $.id in OPS DB. Check that Medication request is not blocked, i.e. is_blocked = falsein case of error - return 409 ("Medication request is already blocked")
Validate block reason code
Validate $.block_reason_system should be “MEDICATION_REQUEST_BLOCK_REASON”
in case of error return 422 error ("value is not allowed in enum")
Validate $.block_reason_code is a value from MEDICATION_REQUEST_BLOCK_REASON dictionary
in case of error - return 422 ("value is not allowed in enum")
Check that $.block_reason_code is present in PHARMACIST_MEDICATION_REQUEST_BLOCK_REASON_CODES chart parameter for validated user
in case of error - return 422 ("Block reason code is not allowed for PHARMACIST")
Validate blocked_to
Validate $.blocked_to > now() (datetime)
in case of error - return 422 ("Blocked_to date should be greater than the current date")
Validate $.blocked_to <= $.medication_request.dispense_valid_to
in case of error - return 422 ("Blocked_to date should be equal to or less than the dispense validity end date")
Validate medical program
It must be allowed to block medication request only in case of such medication request is prescribed under specific medical program. In other cases it is prohibited to block medication request
Check that
$.medical_program_idis in list of predefined programs in MEDICATION_REQUEST_BLOCK_ALLOWED_PROGRAMS config parameterin case of error - return 422 ("It is not allowed to block medication request under this medical program")
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 | ||
|---|---|---|
| ||
|
...
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 3 | 401 | Unauthorized | Помилка підтвердження | ||
| 4 | Специфічні | ||||
| 5 | 422 | Only for active MPI record can be created medication request! | |||
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...