| Table of Contents |
|---|
...
This WS is designed to search (get list) Requests for Medication request requests in the care plan context. If the user has approval of on the care plan, he will receive a list of Medication request requests regardless of the legal entity which are created on the basis of based on this care plan.
Specification
| Page Properties | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
...
Verify the validity of access token
Return 401 in case validation fails
...
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 action (scope = 'medication_request_request:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: medication_request_request:read') in case of 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_request_requests.person_id (granted_by)
...
Search Medication request requests by filters: care_plan_id
limit (limit response size - quantity of innm objects). By default returned 50 objects.
starting_after (cursor to fetch next page)
ending_before (cursor to fetch previous page)
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
...
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_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
...
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 request requests related to the care plan filtered by submitted parameters:
Get all Medication request requests by care_plan_id from medication_request_requests (IL database).
Validate data consistency:
Ensure that requested Medication request 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 request requests entities.
Response structure
See on Apiary
...
HTTP status code | Message | What caused the error |
|---|---|---|
200 | Response |
|
401 | Invalid access token |
|
403Invalid | scopeYour scope does not allow to access this resource. Missing allowances: medication_request_request:read |
Backward compatibility
API paragraph not found