| Table of Contents |
|---|
Purpose
This WS is designed to search (get a list) for (of) Medication requests in the care plan context. If the user has the approval of the care plan, he will receive a list of Medication requests regardless of the legal entity which are created on the basis of this care plan.
According to requirements:
User of MSP, PRIMARY_CARE, OUTPATIENT (DOCTOR, SPECIALIST, etc) can see Medication requests based on the approval of the care plan that is contained in the Medication request
Specification
...
Project Name
...
Електронний рецепт
...
COVID-certificate
...
Project abreviation
...
ePrescription
...
SVC
...
Developer
...
API paragraph not found
...
Розробник методу API. Наприклад, Edenlab
...
Project Manager
...
API paragraph not found
...
Tech Lead
...
API paragraph not found
...
Product Owner
...
API paragraph not found
...
Вusiness analyst
...
API paragraph not found
...
Status
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
...
Version
...
API paragraph not found
...
1.0
...
Date of release
...
API paragraph not found
...
...
Link
...
...
Посилання на Apiary або Swagger
...
Resource
...
/api/care_plans/{{care_plan_id}}/medication_requests
...
| Table of Contents |
|---|
Purpose
This WS is designed to search Medication requests in the care plan context. If the user has approval on the care plan, he will receive a list of Medication requests based on this care plan.
Specification
| Page Properties | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
API paragraph not found
Preconditions
No
Global and configurable parameters
No
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
care_plan_id |
Filters
See on Apiary
Request structure
API paragraph not found
Authorize
Verify the validity of access token
...
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
...
Return 403 in case invalid scope(s)
...
Get party_id from $.context.user_id
...
Get list from $.prm.employees for this party_id
...
Get care_plan_id from url
...
Check $.approvals for user's employees (granted_to) on care_plan_id (granted_resources) and $.medication_requests.person_id (granted_by)
...
Search Medication requests by filters: care_plan_id.
Preconditions
No
Global and configurable parameters
No
Input parameters
...
Input parameter
...
Values
...
Type
...
Description
...
Example
...
care_plan_id
Filters
See on Apiary
Request structure
API paragraph not found
Authorize
...
action (scope = 'medication_request:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: medication_request:read') in case of invalid scope(s)
Access to the resource is also managed by ABAC rules .
Headers
Content-Type:application/json
...
Access to the method is defined by the scope medication_request:read. 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
If according to filters requests are not found, WS returns empty data array
...
is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
API paragraph not found
Processing
Service returns all Medication requests related to the care plan filtered by submitted parameters:
Get all Medication requests by care_plan_id from medication_requests (OPS database).
Validate data consistency:
Ensure that requested Medication requests have ABAC context
Return 403 ('Access denied') in case of error.
Filter list above by submitted search parameters.
Render a response according to specification with found Medication requests entities.
Response structure
See on Apiary
...
HTTP status code | Message | What caused the error |
|---|---|---|
200 | Response |
|
401 | Invalid access token |
|
403Invalid scope |
|
Backward compatibility
API paragraph not found