| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
...
| id | page_properties_method_REST API |
|---|
...
Document type
...
Метод REST API
...
Guideline ID
...
GUI-0011
...
Author
...
@
...
Document version
...
1
...
Document status
...
DRAFT
...
Date of creation
...
ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
...
Date of update
...
ХХ.ХХ.ХХХХ (дата зміни версії)
...
Method API ID
...
API-001-001-001-0001
...
Microservices (namespace)
...
MPI
...
Component
...
Auth
...
Component ID
...
COM-001-001
...
Link на API-специфікацію
...
...
Resource
...
{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package
...
Scope
...
Protocol type
...
Request type
...
Sync/Async
...
Public/Private
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
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
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
composition_id
...
M
...
String ($uuid) (path)
...
Composition object ID
...
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
...
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Description of the REST API response structure, example
...
| title | Example |
|---|
...
HTTP status codes
...
Response code
...
HTTP Status code
...
Message
...
Internal name
...
Description
...
Базові
...
1000
...
404
...
Composition not found
...
COMPOSITION_NOT_FOUND_404
...
Не знайдено медичний висновок
...
401
...
Unauthorized
...
Помилка підтвердження
...
Специфічні
...
| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This WS is designed to reject previously created Medication Request
Key points
Only authenticated and authorized user with an appropriate scope can reject Medication Request.
Medication Request can be rejected only from ‘ACTIVE' status.
Logic
Save signed content to media storage.
Update Medication request in OPS DB:
set status = 'REJECTED'
set reject_reason_code = $.reject_reason_code
set reject_reason = $.reject_reason
set updated_by = user_id
set updated_at = now()
Send SMS for person
If Medication request has program with medical program setting medication_request_notification_disabled = true, then don't send SMS.
Else:
Get authentication_method of person from MPI
If authentication_method == OTP, then send SMS to a person from Medication request:
Generate SMS text (
get template from reject_template_sms parameter
enrich template with data from Medication request
Send SMS to a person
Add new status to event manager
field | value |
|---|---|
|
|
|
|
| $.id |
| $.status |
| $.update_at |
| $.changed_by |
f the medication request is based on the activity with quantity:
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
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id |
| String | Required | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 2 |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | Authorization:Bearer c2778f3064753ea70de870a53795f5c9 |
| 3 |
Request data validation
Check signed content
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.
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").
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
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Response |
| ||
| 3 | 400 | Document must be signed by 1 signer but contains 0 signatures. |
| ||
| 4 | 400 | document must be signed by 1 signer but contains 0 signatures | |||
| 5 | 400 | Invalid signature | |||
| 6 | 401 | Invalid access token |
| ||
| 7 | 401 | Unauthorized | Помилка підтвердження | ||
| 8 | 403 | Access denied. Party is not verified | |||
| 9 | 403 | Your scope does not allow to access this resource. Missing allowances: medication_request:reject |
| ||
| 10 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 11 | 404 | Not found |
| ||
| 12 | 409 | Employee is not author of medication request, doesn't have approval or required employee type. |
| ||
| 13 | 409 | Invalid status Medication request for reject transition! | |||
| 14 | 409 | Medication request with connected processed medication dispenses can not be rejected | |||
| 15 | 422 | Does not match the signer drfo | |||
| 16 | 422 | Signed content does not match the previously created content. | |||
| 17 | 422 | Schema does not allow additional properties' OR 'required property type was not present. | |||
| 18 | 422 | Signed content does not match the previously created content. | |||
| 19 | 422 | value is not allowed in enum | |||
| 20 | Специфічні | ||||
| 21 | 422 | Only for active MPI record can be created medication request! | |||
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
| Page Properties Report | ||||
|---|---|---|---|---|
|
...