Properties of a REST API method document

Purpose

This WS is designed to block previously created Medication request with indicating block_reason_code and block_reason

Key points

1. Only authenticated and authorized user with an appropriate scope can block Medication request.

2. Medication request can be blocked only from the ‘ACTIVE' status.

Logic

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

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

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

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

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

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

HTTP status codes

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