...
...
...
...
This method is designed to process previously created Medication dispense.
Key points
Only authenticated and authorized users of a legal entity who has created Medication dispense can process Medication dispense.
Medication dispense can be processed only from ‘NEW' status.
The process should be signed with DS. So, all the Medication dispense data should be submitted.
Invoke Get Medication dispense details by Pharmacy User to obtain previously created Medication dispense. In order to process dispense payment_id (optional) and payment_amount should be added.
Specification
...
Link
...
...
Посилання на Apiary або Swagger
...
Resource
...
/api/pharmacy/medication_dispenses/{{id}}/actions/process
...
Посилання на ресурс, наприклад: /api/persons/create
...
Scope
...
medication_dispense:process
...
Scope для доступу
...
Components
...
ePrescription
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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
Save signed content to media storage.
Update Medication dispense data in OPS DB:
set status = ‘PROCESSED’
updated_by = user_id
updated_at = now()
Update related Medication request data in OPS DB:
set status = ‘COMPLETED’
updated_by = user_id
updated_at = now()
Write changes to event manager (Medication dispense and Medication request).
Change Care plan activity (If related medication request has reference on Care plan, then corresponding care plan activity should be changed in async way after Medication dispense processed. Update activity events invokes using ops.medication_dispense_process table):
Set activity status to in_progress if previous activity status was scheduled.
Check the MD identifier in outcome_reference attribute of the activity:
if not found:
Add reference on the medication dispense resource to the outcome_reference attribute .
If quantity in the activity was set then calculate and set remaining quantity:
select all MD in status PROCESSED related to MR which based on care plan and current activity;
calculate dispensed quantity in the current activity as sum of medication_qty in the filtered MD list;
calculate remaining quantity by subtracting dispensed quantity from activity quantity;
update remaining_quantity value in the activity with calculated value.
If found, then skip updating activity (it means that activity has been already updated by event from current MD processing).
Preconditions
No
Global and configurable parameters
No
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
id
...
String
...
Medication Dispense Response Identifier. 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_dispense:process')
return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_dispense:process”) in case of invalid scope(s).
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request
API paragraph not found
Request data validation
Validate digital signature
Validate request is signed
in case of error - return 400 (“document must be signed by 1 signer but contains 0 signatures”).
Validate that DS is valid and not expired.
Validate that DS belongs to the user
Check that DRFO from DS and party.tax_id matches
in case of error - return 422 (“Does not match the signer drfo“).
Check that Last Name from DS and party.last_name matches
in case of error - return 422 (“Does not match the signer last name“).
Validate Medication dispense
Get Medication dispense identifier from the URL
Check Medication dispense exists in DB (OPS)
Return 404 ('not_found') in case of error.
Check Medication dispense belongs to legal entity
Return 404 ('not_found') in case of error.
Validate User
Extract user_id from token
Return 404 ('not_found') in case employee didn’t create medication dispense.
Validate signed content
Check that signed content is equal to online generated dispense with ids in DB:
Do not compare:
payment_amount field;
payment_id field;
medication_request/legal_entity object;
medication_request/division object;
medication_request/employee object;
medication_request/person/id field;
medication_request/rejected_at field;
medication_request/rejected_by field;
in case error return 422 ("Signed content does not match to previously created dispense").
Validate transition
Get status of Medication dispense by $.id in OPS DB. Check that Medication dispense is in status ‘NEW’
in case of error - return 409 ("Can't update medication dispense status from {status} to PROCESSED").
For more information look at Medication dispense status model.
Validate payment_amount
Check that payment_amount should be greater or equal to 0
in case of error - return 422 ("expected the value to be >= 0").
Validate related Medication request
Medication request should be active in order to process medication dispense
is_active = true
status = 'ACTIVE'
In case error - return 409 ("Medication request is not active").
Medication request should not be blocked in order to process medication dispense
is_blocked <> true
In case error - return 409 ("Medication request is blocked").
Check if related medication request has reference on the Care plan - based_on attribute filled. If it has, validate following:
Care plan is not in final status.
In case of error - return 409 error (Care plan is not active).
Corresponding Care plan activity is not in final status.
In case of error - return 409 error (Care plan activity should be scheduled or in_progress).
Parameters that are used when processing the request
Configuration parameters
Access to the method is defined by the scope medication_dispense:process. 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
...
...
400
...
Document must be signed by 1 signer but contains 0 signatures
...
401
...
Invalid access token
...
...
403
...
Your scope does not allow to access this resource. Missing allowances: medication_dispense:process
...
...
409
...
Can't update medication dispense status from {status} to PROCESSED.
Medication request is not active.
Medication request is blocked.
Care plan is not active.
Care plan activity should be scheduled or in_progress.
...
...
422
...
Does not match the signer drfo.
Does not match the signer last name
Signed content does not match to previously created dispense.
Expected the value to be >= 0.
Backward compatibility
API paragraph not foundThe page is not supported. The method requirements can be found here Process Medication Dispense by Pharmacy User [API-005-008-001-0133]