...
Apiary
...
...
JSON Schema response
...
medication_request_show_response.json
Table of Contents |
---|
Specification
Table of Contents |
---|
Purpose
This WS is designed to recall (cancel) previously created and signed Medication request (patch).
Specification
...
id
...
Page Properties | |||
---|---|---|---|
|
Input parameters (filters)
|
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
...
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
...
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
...
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
...
After status was changed (status = REJECTED) - add new status to event_manager
fieldField | valueValue |
---|---|
|
|
| MedicationRequest |
| $.id |
| $.status |
| $.update_at |
| $. |
...
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 service.
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 | Error |
Backward compatibility
API paragraph not found