...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents |
|---|
Purpose
Use this method to unblock previously blocked Medication request for dispense.
Specification
...
Project Name
...
Електронний рецепт
...
COVID-certificate
...
Project abreviation
...
ePrescription
...
SVC
...
Developer
...
API paragraph not found
...
Розробник методу API. Наприклад, Edenlab
...
Project Manager
...
API paragraph not found
...
Tech Lead
...
API paragraph not found
...
Product Owner
...
API paragraph not found
...
Вusiness analyst
...
API paragraph not found
...
Status
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
...
Version
...
API paragraph not found
...
1.0
...
Date of release
...
API paragraph not found
...
...
Link
...
...
Посилання на Apiary або Swagger
...
Resource
...
/api/medication_requests/{{id}}/actions/unblock
...
Наприклад: /api/persons/create
...
Scope
...
medication_request:unblock
...
Зазначається потрібний scope
...
Components
...
ePrescription, Reimbursement
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
...
Microservices
...
API paragraph not found
...
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
...
Protocol type
...
REST
...
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
...
Request type
...
PATCH
...
Тип HTTP методу, який використовується запитом, наприклад: POST | GET…
...
Sync/Async
...
Sync
...
Метод є синхронним чи асинхронним?
Logic
Key points
Only authenticated and authorized user with appropriate scope can unblock Medication request.
Medication request can be unblocked only if it was previously blocked.
Medication request can be unblocked only from ‘ACTIVE' status.
Service logic
Update Medication request in OPS DB:
set is_blocked = false
set block_reason_code = $.block_reason_code
set block_reason = $.block_reason
set updated_by = user_id
set updated_at = now()
Send SMS for person
If Medication request has program with medical program setting medication_request_notification_disabled = true, then don't send SMS.
Else:
Get authentication_method of person from MPI
If authentication_method == OTP, then send SMS to a person from Medication request:
Generate SMS text
get template from unblock_template_sms parameter
enrich template with data from Medication request
Send SMS to a person with text from template (“Ваш рецепт <request_number> розблоковано. Можете отримати ліки в аптеці”)
Add new record in Event manager:
...
field
...
value
...
event_type
...
StateChangeEvent
...
entity_type
...
MedicationRequest
...
entity_id
...
$.id
...
properties.is_blocked.new_value
...
false
...
event_time
...
$.update_at
...
changed_by
...
$.changed_by
Preconditions
No
Global and configurable parameters
No
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
id
...
String
...
d290f1ee-6c54-4b01-90e6-d701748f0851
Filters
No
Request structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Authorize
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:unblock')
return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_request:unblock”) in case of invalid scope(s)
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request
Validate request using JSON schema
in case of error - return 422
Request data validation
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 unblocking is allowed for user if he has one of the following active and approved employee that:
is an author of the Medication request (medication_request.employee_id)
has an approval on write Care plan if Medication request based on the Care plan (medication_request.based_on)
is Med_Admin from legal entity where Medication Request is created
in case of error - return 409 ("Only an author, employee with approval on care plan or med_admin from the same legal entity can unblock medication request")
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 blocked, i.e. is_blocked = true
in case of error - return 409 ("Medication request is already unblocked")
Validate block reason code
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 <EMPLOYEE_TYPE>_MEDICATION_REQUEST_UNBLOCK_REASON_CODES chart parameter for validated user
in case of error - return 422 ("Block reason code is not allowed for <employee_type>")
Parameters that are used when processing the request
Configuration parameters
API paragraph not found
Dictionaries
API paragraph not found
Processing
API paragraph not found
Response structure
...
| Table of Contents |
|---|
Purpose
This WS is designed to unblock previously blocked Medication request with indicating block_reason and block_reason_code
Key points
Only authenticated and authorized user with appropriate scope can unblock Medication request.
Medication request can be unblocked only if it was previously blocked.
Medication request can be unblocked only from ‘ACTIVE' status.
Specification
| Page Properties | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
Update Medication request in OPS DB:
set is_blocked = false
set block_reason_code = $.block_reason_code
set block_reason = $.block_reason
set updated_by = user_id
set updated_at = now()
Send SMS for person
If Medication request has program with medical program setting medication_request_notification_disabled = true, then don't send SMS.
Else:
Get authentication_method of person from MPI
If authentication_method == OTP, then send SMS to a person from Medication request:
Generate SMS text
get template from unblock_template_sms parameter
enrich template with data from Medication request
Send SMS to a person with text from template (“Ваш рецепт <request_number> розблоковано. Можете отримати ліки в аптеці”)
Add new record in Event manager:
field | value |
|---|---|
|
|
|
|
| $.id |
| false |
| $.update_at |
| $.changed_by |
Preconditions
No
Global and configurable parameters
No
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
id | String | Medication Request identifier | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Filters
No
Request structure
Example:
| Expand | ||
|---|---|---|
| ||
|
Authorize
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:unblock')
return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_request:unblock”) in case of invalid scope(s).
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request
Validate request using JSON schema
in case of error - return 422
Request data validation
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 unblocking is allowed for user if he has one of the following active and approved employee that:
is an author of the Medication request (medication_request.employee_id)
has an approval on write Care plan if Medication request based on the Care plan (medication_request.based_on)
is Med_Admin from legal entity where Medication Request is created
in case of error - return 409 ("Only an author, employee with approval on care plan or med_admin from the same legal entity can unblock medication request")
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 blocked, i.e. is_blocked = true
in case of error - return 409 ("Medication request is already unblocked")
Validate block reason code
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 <EMPLOYEE_TYPE>_MEDICATION_REQUEST_UNBLOCK_REASON_CODES chart parameter for validated user
in case of error - return 422 ("Block reason code is not allowed for <employee_type>")
Parameters that are used when processing the request
Configuration parameters
Access to the method is defined by the scope medication_request:unblock. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
MEDICATION_REQUEST_BLOCK_REASON
MEDICATION_REQUEST_PRIORITY
MEDICATION_FORM
MEDICATION_UNIT
FUNDING_SOURCE
MR_BLANK_TYPES
PROVIDING_CONDITION
eHealth/clinical_impression_patient_categories
LICENSE_TYPE
MEDICATION_REQUEST_INTENT
MEDICATION_REQUEST_CATEGORY
eHealth/SNOMED/additional_dosage_instructions
eHealth/SNOMED/anatomical_structure_administration_site_codes
eHealth/SNOMED/route_codes
eHealth/SNOMED/administration_methods
eHealth/dose_and_rate
eHealth/ucum/units
MEDICATION_REQUEST_REJECT_REASON
Response structure
Example:
| Expand | ||
|---|---|---|
| ||
|
...
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_request:unblock | |
404 | Medication request does not exist | |
409Error |
| |
422 |
| Request validation fails |
Backward compatibility
API paragraph not found
...