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 by Pharmacy user.

Key points

Only authenticated and authorized user with appropriate scope and ‘PHARMACIST’ employee type can unblock Medication request.

In the response of this endpoint legal entity, division and employee details are trimmed.

Medication request can be unblocked only if it was previously blocked.

Medication request can be unblocked only from ‘ACTIVE' status.

Logic

Service logic

1. Update Medication request in OPS DB:

   1. set blocked_to = null

   2. set blocked_by_legal_entity_id = null

   3. set block_reason_code = $.block_reason_code

   4. set block_reason = null

   5. set updated_by = user_id

   6. set updated_at = now()

2. Check SMS is needed:

   1. If $.block_reason_code=PRODUCTION_CANCEL:

      1. If authorize_with exists in medication request and is not empty, check:

         1. Authentication method exists in person_authentication_methods table in MPI DB (with is_active=true), is active (ended_at > now() or null)

         2. Get value of THIRD_PERSON_CONFIDANT_PERSON_RELATIONSHIP_CHECK config parameter, if it is set to true - for authentication method with type = THIRD_PERSON check that person from value is an approved confidant for a person from medication request – exists active and approved confidant person relationship between person from request and confidant_person_id from authentication method value (using following logic: https://e-health-ua.atlassian.net/wiki/x/HIabFAQ with person_id = person from request and confidant_person_id = value from auth method) - expected :ok, :approved response)

            1. in case any validation failed - do not send SMS to person

            2. else - get authentication_method from authorize_with

      2. If authorize_with does not exist in medication request or is empty - get authentication_method of person from MPI

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

   2. Else $.block_reason_code is not PRODUCTION_CANCEL or Medication request has program with medical program setting request_notification_disabled = true - don't send SMS

3. Add new record in Event manager

Configuration parameters

N/A

Dictionaries

MEDICATION_REQUEST_BLOCK_REASON

MEDICATION_REQUEST_INTENT

MEDICATION_REQUEST_CATEGORY

MEDICATION_REQUEST_PRIORITY

eHealth/SNOMED/additional_dosage_instructions

eHealth/SNOMED/anatomical_structure_administration_site_codes

eHealth/SNOMED/route_codes

eHealth/SNOMED/administration_methods

eHealth/SNOMED/dose_and_rate

eHealth/ICD10_AM/condition_codes

eHealth/ICPC2/condition_codes

ADDRESS_TYPE

SETTLEMENT_TYPE

STREET_TYPE

PHONE_TYPE

DIVISION_TYPE

POSITION

MEDICATION_FORM

MEDICATION_UNIT

eHealth/clinical_impression_patient_categories

LICENSE_TYPE

FUNDING_SOURCE

MR_BLANK_TYPES

MEDICATION_REQUEST_REJECT_REASON

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorization

1. Verify the validity of access token

   1. in case of error - return 401 (“Invalid access token”) in case of validation fails

2. Verify that token is not expired

   1. in case of error - return 401 (“Invalid access token”)

3. Check user scopes in order to perform this action (scope = 'medication_request:unblock_pharm')

   1. return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_request:unblock_pharm”) in case of invalid scope(s)

Validations

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

1. Medication Request unblocking is allowed for user if he has active and approved employee with employee_type = ‘PHARMACIST’

   1. in case of error - return 409 ("Only pharmacist can unblock medication request")

2. Check if user is from the same legal entity as legal_entity in $.medication_requests.blocked_by_legal_entity_id :

   1. client_id from token = $.medication_requests.blocked_by_legal_entity_id.

      1. in case of error - return 422 “Only an employee of the legal_entity where the medication request was blocked can unblock it“

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: blocked_to > now() (datetime)

   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_UNBLOCK_REASON dictionary

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

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