Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
- 2.1 Key points
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Request data validation
9 Validate request
- 9.1 Validate Medication request
- 9.2 Validate user
- 9.3 Validation transition
- 9.4 Validate block reason code
10 Processing
11 Response structure examples
12 Post-processing processes
13 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
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-0157
Microservices (namespace)	IL
Component	ePrescription
Component ID	COM-005-008
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/medication-request/unblock-medication-request
Resource	{{host}}/api/persons/{{person_id}}/medication_requests/{{id}}/actions/unblock
Scope	medication_request:block
Protocol type	REST
Request type	PATCH
Sync/Async	Sync
Public/Private	Public

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

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()
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> розблоковано. Можете отримати ліки в аптеці”)
Add new record in Event manager:

field	value

field	value
`event_type`	`StateChangeEvent`
`entity_type`	`MedicationRequest`
`entity_id`	$.id
`properties.is_blocked.new_value`	false
`event_time`	$.update_at
`changed_by`	$.changed_by

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

Input parameters

Description of 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 (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

{
  "block_reason": "помилки відсутні",
  "block_reason_code": "DEFAULT"
}

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 unblocking 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 unblock 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 blocked, i.e. is_blocked = true
- in case of error - return 409 ("Medication request is already unblocked")

Validate block reason code

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