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 an appropriate scope can block Medication request.
Medication request can be blocked only from the ‘ACTIVE' status.

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/medication-request/block-medication-request	Посилання на Apiary або Swagger
Resource	/api/medication_requests/{{id}}/actions/block	Посилання на ресурс, наприклад: /api/persons/create
Scope	medication_request:block	Scope для доступу
Components	ePrescription	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public

Logic

Update Medication request in OPS DB:
1. set is_blocked = true
2. set block_reason_code = $.block_reason_code
3. set block_reason = $.block_reason
4. set updated_by = user_id
5. set updated_at = now()
Send SMS for person
1. If Medication request has program with medical program setting medication_request_notification_disabled = true, then don't send SMS.
  Else:
  1. Get authentication_method of person from MPI
  2. If authentication_method == OTP, then send SMS to a person from Medication request:
    1. Generate SMS text
      1. get template from block_template_sms parameter
      2. enrich template with data from Medication request
    2. 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`	true
`event_time`	$.update_at
`changed_by`	$.changed_by

Preconditions

No

Input parameters

Input parameter	Values	Type	Description	Example
id		String	Medication Request identifier	d290f1ee-6c54-4b01-90e6-d701748f0851

Filters

No

Request structure

Example:

Request example

{
  "block_reason": "перевищено норми відпуску",
  "block_reason_code": "WRONG_QTY_DRUG"
}

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:block')
- return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_request:block”) 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 blocking 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 block 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 not blocked, i.e. is_blocked = false
- in case of error - return 409 ("Medication request is already blocked").

Validate block reason

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_BLOCK_REASON_CODES chart parameter for validated user
- in case of error - return 422 ("Block reason code is not allowed for <employee_type>").

Processing

API paragraph not found

Response structure