Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
Purpose
This method is designed to search for Medication dispenses by Medication request ID in a person`s context.
Logic
Service returns specified Medication dispenses related to the patients Medication request:
Get Medication dispenses from medication_dispenses (OPS database)
Filter by medication_request_id and patient_id and status (optional).
Validate data consistency:
Ensure that requested Medication dispenses relates to requested Patient (from URL)
Return 403 ('Access denied') in case of error.
Filter list above by submitted search parameters.
Render a response according to specification with found Medication dispenses entities.
Configuration parameters
Access to the method is defined by the scope medication_request:details. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | person_id |
| String | person_id of a patient. Required. | 5e661b15-a39a-4713-b18e-ba03a4a48ecc |
2 | id |
| String | Medication request identifier. Required. | a89f6a26-4221-4597-a1d2-542d5e40b565 |
Filters
Filter | Values | Type | Description | Example |
---|---|---|---|---|
status |
| String | Medication Dispense status. Optional. |
Request structure
See on API-specification
Request data validation
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:details')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: medication_request:details') in case of invalid scope(s)
Access to the resource is also managed by ABAC rules (modified - EN) .
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 | 401 | Invalid access token |
| ||
3 | 403 | Access denied | |||
4 | 403 | Your scope does not allow to access this resource. Missing allowances: medication_request:details | |||
5 | Специфічні | ||||
6 |
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used