Properties of a REST API method document

Purpose

This WS is designed to reject previously created Medication Request

Key points

1. Only authenticated and authorized user with an appropriate scope can reject Medication Request.

2. Medication Request can be rejected only from ‘ACTIVE' status.

Logic

1. Save signed content to media storage.

2. Update Medication request in OPS DB:

   1. set status = 'REJECTED'

   2. set reject_reason_code = $.reject_reason_code

   3. set reject_reason = $.reject_reason

   4. set updated_by = user_id

   5. set updated_at = now()

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

            2. enrich template with data from Medication request

         2. Send SMS to a person

4. Add new status to event manager

5. f the medication request is based on the activity with quantity:

   1. Recalculate and set remaining_quantity for the activity as described at Create Medication Request: Validate based_on (p. 2.d.1 ) and do not include current MR but include all MD which related to current MR

Технічний опис бізнес-процесу виписування рецепту в ЕСОЗ (загальний процес для усіх рецептурних ЛЗ, в т.ч. і тих, які підлягають реімбурсації)

Процеси роботи з випискою електронних рецептів

Configuration parameters

Access to the method is defined by the scope medication_request:reject. 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_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

Description of input parameters

Request structure

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

Description of the REST API request structure, example

Request data validation

Authorize

1. Verify the validity of access token

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

2. Verify that token is not expired

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

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

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

4. If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

   • in case not match - return 403 ("Access denied. Party is not verified")

Check signed content

Check that signed content contains all required fields and is equal to stored object:

1. Decode signed content.

2. Render requested medication request.

3. Check that rendered and decoded data matches.

Note! Medication request with intent plan and order has different structure

• Medical program is optional object in order.

• Medical program is absent in plan.

Validate Digital Sign

• Validate request is signed

  • in case of error - return 400 (“document must be signed by 1 signer but contains 0 signatures”).

• Check DS is valid and not expired.

• Validate that DS belongs to the user

  • in case of error - return 400 (“Invalid signature“).

• Check that DRFO from DS and party.tax_id matches

  • in case of error - return 422 (“Does not match the signer drfo“).

Validate Medication request

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

  • in case of error - return 404 (“Not found“).

Validate user

Medication Request rejection is allowed for user if he has one of the following active and approved employee that:

• is an author of the Medication request 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 ("Employee is not author of medication request, doesn't have approval or required employee type").

• is an Employee from legal entity where Medication Request is created

  • in case of error - return 409 ("Only an employee from legal entity where medication request is created can reject medication request")

Validate content

• Validate request using JSON schema

  • in case of error - return 422 ('schema does not allow additional properties' OR 'required property type was not present').

• Check that signed content contains all required fields and is equal to stored object

  • Decode signed content.

  • Render requested medication request.

  • Check that rendered and decoded data matches (except for reject_reason_code and reject_reason fields)

    • in case of error - return 422 ("Signed content does not match the previously created content").

Note! Medication Request with intent plan and order has different structure:

• Medical program is required in order.

• Medical program is absent in plan.

Validation transition

• Get status of Medication request by $.id in OPS DB. Check that Medication request is in status ‘ACTIVE’

  • if invalid - return 409 ("Invalid status Medication request for reject transition!").

For more information look at Medication request status model .

Validate reject reason code

• Validate $.reject_reason_code is a value from MEDICATION_REQUEST_REJECT_REASON dictionary

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

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