Properties of a REST API method document

Document type	Метод REST API
Document title	Block Medication Request [API-005-008-002-0156]
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-0156
Microservices (namespace)	IL
Component	ePrescription
Component ID	COM-005-008
Link на API-специфікацію	GENERAL MIS API · Apiary
Resource	{{host}}/api/persons/{{person_id}}/medication_requests/{{id}}/actions/block
Scope	medication_request:block
Protocol type	REST
Request type	PATCH
Sync/Async	Sync
Public/Private	Public

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.

Logic

Update Medication request in OPS DB:
1. set is_blocked = true
2. set block_reason_system = $.block_reason_system
3. set block_reason_code = $.block_reason_code
4. set block_reason = $.block_reason
5. set updated_by = user_id
6. set updated_at = now()
7. set block_legal_entity_id = legal entity id out of token
Send SMS for person
1. If Medication request has program with medical program setting medication_request_notification_disabled 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
Add new record in Event manager:

field	value

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

Configuration parameters

N/A

Dictionaries

Input parameters

	Input parameter	Mandatory	Type	Description	Example

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

Request structure

See on API-specification

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

Headers

Request data validation

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 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_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 <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

N/A

Response structure examples