Properties of a REST API method document

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.

Logic

1. Update Medication request in OPS DB:

   1. set is_blocked = false

   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()

2. 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 unblock_template_sms parameter

            2. enrich template with data from Medication request

         2. Send SMS to a person with text from template (“Ваш рецепт <request_number> розблоковано. Можете отримати ліки в аптеці”)

3. Add new record in Event manager:

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

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Validate request

1. Validate request using JSON schema

   1. in case of error - return 422

Validate Medication request

1. Get Medication request identifier from the URL. Check Medication request exists in OPS DB

   1. 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:

1. is an author of the Medication request (medication_request.employee_id)

2. has an approval on write Care plan if Medication request based on the Care plan (medication_request.based_on)

3. is Med_Admin from legal entity where Medication Request is created

   1. 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

1. Get Medication request by $.id in OPS DB. Check that Medication request status = ‘ACTIVE’

   1. in case of error - return 409 ("Medication request must be in active status")

2. Get Medication request by $.id in OPS DB. Check that Medication request is blocked, i.e. is_blocked = true

   1. in case of error - return 409 ("Medication request is already unblocked")

Validate block reason code

1. Validate $.block_reason_code is a value from MEDICATION_REQUEST_BLOCK_REASON dictionary

   1. in case of error - return 422 ("value is not allowed in enum")

2. Check that $.block_reason_code is present in <EMPLOYEE_TYPE>_MEDICATION_REQUEST_UNBLOCK_REASON_CODES chart parameter for validated user

   1. in case of error - return 422 ("Block reason code is not allowed for <employee_type>")

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used