| Table of Contents |
|---|
Purpose
This WS is designed to recall (cancel) previously created and signed Medication request (patch).
Specification
...
Link
...
...
Посилання на Apiary або Swagger
...
Resource
...
/api/medication_requests/{{id}}/actions/reject
...
Посилання на ресурс, наприклад: /api/persons/create
...
Scope
...
medication_request:reject
...
Scope для доступу
...
Components
...
ePrescription, Reimbursement
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
...
Microservices
...
API paragraph not found
...
Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
...
Protocol type
...
REST
...
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
...
Request type
...
PATCH
...
Тип запиту API, наприклад: GET, POST, PATCH…
...
Sync/Async
...
Sync
...
Метод є синхронним чи асинхронним?
Logic
API paragraph not found
Preconditions
No
Global and configurable parameters
No
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
id
...
String
...
Required
...
a89f6a26-4221-4597-a1d2-542d5e40b565
Filters
No
Request structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Authorize
Verify the validity of access token
Check user scope (scope = 'medication_request:reject') in order to perform this action
In case error - generate 401 response
Digital signature
Decode content that is encrypted in an electronic digital signature.
Use Digital signature WS. Method checks digital signature and returns result.
See service specification.
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request
Validate DS
Extract user from token
check if tax_id in DS = (SELECT parties.tax_id from party_users join parties on party_users.party_id=parties.id where party_users.user_id=$.user;)
in case error return error 422, "Invalid drfo in DS"
Validate User
Do reject Medication request Request allowed for User if he has 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 a Doctor whohas declarationwith the Patient.in case of error - return 409 ("Only an author, employee with approval on care plan or doctor with an active declaration with the patient can reject medication request")
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
Validation transition
For info - status charts: Medication_request
Get Medication request status by $.id
Check status of medication request == ACTIVE
if invalid - return 409 error (message: "Invalid status Medication request for reject transition!")'
Check connected medication dispenses medication_dispenses.status !== PROCESSED or NEW
if invalid - return 409 error (message: "Medication request with connected processed medication dispenses can not be rejected")
Validate request using JSON schema
In case validation fails - generate 422 error
Validate content. Check equality decoded signed content with previously created medication request, except, "Reason"!
in case error return 422, "Signed content does not match the previously created content."
Parameters that are used when processing the request
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
API paragraph not found
Processing
Save signed medication request reject to media storage
Get url for medication request reject upload
Parameter
Source
action'GET'bucket'MEDICATION_REQUESTS'resource_id: MEDICATION_REQUEST_IDresource_name: MEDICATION_REQUEST_REJECT
...
Upload signed medication request reject to media storage
Update status
Update (Set values) Medication request
status = REJECTED
updated_by = user_id
updated_at = timestamp
Add status to event manager
After status was changed (status = REJECTED) - add new status to event_manager
...
Field
...
Value
...
event_type
...
StatusChangeEvent
...
entity_type
...
MedicationRequest
...
entity_id
...
$.id
...
properties.status.new_value
...
$.status
...
event_time
...
$.update_at
...
changed_by
...
$.changed_by
Send SMS for person
Get authentication_method of MPI
If authentication_method == OTP - send SMS:
Generate text SMS (call Man method - templates rendering service with template "TEMPLATE_SMS_FOR_REJECT_MEDICATION_REQUEST"
Sending SMS for MPI via service.
Response structure
See on Apiary
Example:
...
| title | Response example |
|---|
...
| Table of Contents |
|---|
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.
Specification
| Page Properties | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 |
Preconditions
No
Global and configurable parameters
No
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
id | String | Required | a89f6a26-4221-4597-a1d2-542d5e40b565 |
Filters
No
Request structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Authorize
Verify the validity of access token
in case of error - return 401 (“Invalid access token”) in case of validation fails.
Verify that token is not expired
in case of error - return 401 (“Invalid access token”).
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).
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request
API paragraph not found
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.
Validation transition
For info - status charts: Medication_request.
Get Medication request status by $.id.
Check status of medication request == ACTIVE
if invalid - return 409 error (message: "Invalid status Medication request for reject transition!")'.
Check connected medication dispenses medication_dispenses.status !== PROCESSED or NEW
if invalid - return 409 error (message: "Medication request with connected processed medication dispenses can not be rejected").
Validate request using JSON schema
In case validation fails - generate 422 error.
Validate content. Check equality decoded signed content with previously created medication request, except, "Reason"!
in case error return 422, "Signed content does not match the previously created content.".
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);
isMed_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 .
Parameters that are used when processing the request
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
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
No
HTTP status codes
...
HTTP status code
...
Message
...
What caused the error
...
200
...
Response
...
...
401
...
Invalid access token
...
...
403
...
Invalid scope
...
409
...
Error
...
422
...
|
Post-processing processes
No
HTTP status codes
HTTP status code | Message | What caused the error |
|---|---|---|
200 | Response |
|
400 |
| |
401 | Invalid access token |
|
403 | Your scope does not allow to access this resource. Missing allowances: medication_request:reject | |
404 | Not found | |
409 |
| |
422 |
|
Backward compatibility
API paragraph not found