...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | REST API Get Medication dispenses by search params by Pharmacy User [API-005-008-001-0138] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-005-008-001-0138 |
Microservices (namespace) | IL |
Link на API-специфікацію | |
Resource | {{host}}/api/pharmacy/medication_dispenses |
Scope | medication_dispense:read_pharm |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Public |
Purpose
This method intended to get all Medication dispenses for the PHARMACY users
...
Access to the method is defined by the scope medication_dispense:read_pharm. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
MEDICATION_REQUEST_BLOCK_REASON
eHealth/SNOMED/additional_dosage_instructions
eHealth/SNOMED/anatomical_structure_administration_site_codes
eHealth/SNOMED/administration_methods
eHealth/ICD10_AM/condition_codes
eHealth/clinical_impression_patient_categories
MEDICATION_REQUEST_REJECT_REASON
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id | O | String | Medication dispense ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 2 | medication_request_id | O | String | Medication request ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 3 | legal_entity_id | O | String | Legal entity ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 4 | division_id | O | String | Division ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
| 5 | status | O | String | Status | PROCESSED |
| 6 | dispensed_from | O | String | date of dispense | 2017-09-01 |
| 7 | dispensed_to | O | String | date of dispense | 2017-10-01 |
| 8 | care_plan_id | O | String | care plan identifier | 8838982b-6a77-4cb5-87cd-cdb82eb55364 |
| 9 | page | O | Number | Page number | 2 |
| 10 | page_size | O | Number | A limit on the number of objects to be returned, between 1 and 300. Default: 50 | 50 |
...
Request data validation
Authorize
Verify the validity of access token
...
in case of validation fails
...
- return 401 (message: “Invalid access token”)
Verify that token is not expired
in case of error - return
...
401 (message: “Invalid access token”)
Check user scopes in order to perform this action (scope = 'medication_dispense:read_pharm')
...
in case of invalid scope(s) - return 403 (message: 'Your scope does not allow to access this resource. Missing allowances: medication dispense:
...
read”)
Validate User
Extract client_id (legal_entity_id) from token.
...
in case employee has no access to medication dispense
...
- return empty array
Processing
N/A
Response structure examples
...
Technical modules where the method is used
Назва | ID ТМ | Статус |
|---|---|---|
TM0112 | ||