Properties of a REST API method document

Properties of a REST API method document

...

1. Service logic

   1. Update Medication request in OPS DB:

      1. set is_blocked = true

      2. set blocked_to = $.blocked_to OR $.medication_request.dispense_valid_to date + 23:59 time (in case blocked_to is absent in request)

      3. set blocked_by_legal_entity_id = legal_entity_id (client_id) from token

      4. set block_reason_code = $.block_reason_code

      5. set block_reason = $.block_reason

      6. set updated_by = user_id

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

2. Return Medication request data with trimmed information about legal entity, division and employee

3. Add new record in Event manager:

...

Configuration parameters

No

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

...

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

X-Custom-PSK

...

X-Custom-PSK: a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4

...

X-Custom-PSK: a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4

Request data validation

Authorization

...

Verify the validity of access token

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

...

-специфікацією)

Description of the REST API request structure, example

Headers

Request data validation

Authorization

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:block_pharm')

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

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 active and approved employee with employee_type = ‘PHARMACIST’

• in case of error - return

...

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

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

Validate request

• Validate request using JSON schema409 ("Only pharmacist can block medication request")

Validate legal_entity

If MR still blocked (blocked_to > now()) and MR.blocked_by_legal_entity_id is not null - check that match with client_id from token

• in case of error - return 409 ("It is not allowed to block medication request that has been blocked from another legal entity")

Validation transition

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

  • in case of error - return 422

...

• • 409 ("Medication request must be in active status")

• Get Medication request identifier from the URLby $.id in OPS DB. Check that Medication request exists in OPS DBis not blocked, i.e. is_blocked = false

  • in case of error - return 404 409 (“Medication request does not exist"Medication request is already blocked")

Validate

...

block reason code

• Validate $.block_reason_system should be “MEDICATION_REQUEST_BLOCK_REASON”

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

• Validate $.block_reason_code is a value from MEDICATION_REQUEST_BLOCK_REASON dictionary

  • in case of error - return

  409

  • 422 ("

  Only pharmacist can block medication request

  • value is not allowed in enum")

Validate legal_entity

...

• Check that $.block_reason_code is present in PHARMACIST_MEDICATION_REQUEST_BLOCK_REASON_CODES chart parameter for validated user

  • in case of error - return

  409

  • 422 ("

  It

  • Block reason code is not allowed

  to block medication request that has been blocked from another legal entity

  • for PHARMACIST")

Validation transition

...

Validate blocked_to

• Validate $.blocked_to > now() (datetime)

  • in case of error - return 409 422 ("Medication request must be in active statusBlocked_to date should be greater than the current date")

• Get Medication request by $.id in OPS DB. Check that Medication request is not blocked, i.e. is_blocked = falseValidate $.blocked_to <= $.medication_request.dispense_valid_to

  • in case of error - return 409 ("Medication request is already blocked422 ("Blocked_to date should be equal to or less than the dispense validity end date")

Validate

...

medical program

It must be allowed to block medication request only in case of such medication request is prescribed under specific medical program. In other cases it is prohibited to block medication request

• Check that $.medical_program_id is in list of predefined programs in MEDICATION_REQUEST_BLOCK_REASON”_ALLOWED_PROGRAMS config parameter

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

• 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 PHARMACIST_MEDICATION_REQUEST_BLOCK_REASON_CODES chart parameter for validated user

  • in case of error - return 422 ("Block reason code is not allowed for PHARMACIST")

Validate blocked_to

• Validate $.blocked_to > now() (datetime)

  • in case of error - return 422 ("Blocked_to date should be greater than the current date")

• Validate $.blocked_to <= $.medication_request.dispense_valid_to

  • in case of error - return 422 ("Blocked_to date should be equal to or less than the dispense validity end date")

Validate medical program

It must be allowed to block medication request only in case of such medication request is prescribed under specific medical program. In other cases it is prohibited to block medication request

• Check that $.medical_program_id is in list of predefined programs in MEDICATION_REQUEST_BLOCK_ALLOWED_PROGRAMS config parameter

  • in case of error - return 422 ("It is not allowed to block medication request under this medical program")

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

...

Response code

...

HTTP Status code

...

Message

...

Internal name

...

Description

...

Базові

...

1000

...

404

...

Composition not found

...

COMPOSITION_NOT_FOUND_404

...

Не знайдено медичний висновок

...

401

...

Unauthorized

...

Помилка підтвердження

...

Специфічні

...

422

...

• • to block medication request under this medical program")

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

...