ЕСОЗ - публічна документація
REST API Private. Get Medication Dispense List []
- 1 Properties of a REST API method document
- 2 Purpose
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Filters
- 7.1 Query data
- 8 Request structure
- 9 Headers
- 10 Request data validation
- 11 Processing
- 12 Response structure examples
- 13 HTTP status codes
- 14 Post-processing processes
- 15 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | REST API Private. Get Medication Dispense List [] |
Guideline ID | GUI-0011 |
Author | @Iryna Lishtaba (SoE eHealth) |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | … |
Microservices (namespace) | API paragraph not found |
Component | ePrescription |
Component ID | COM-005-008 |
Link на API-специфікацію | |
Resource | {{host}}/api/admin/medication_dispenseses |
Scope | medication_dispense_admin:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Private |
Purpose
This method is designed to get all Medication Dispense for NHS_ADMIN. In the response of these endpoint person_id is return in hashed form.
Logic
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'medication_dispense_admin:read')
Return 403 in case invalid scope(s)
Configuration parameters
N/A
Dictionaries
N/A
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 |
Description of input parameters
Filters
Query data
Get all records from medication_dispenses filtered by:
only active records: is_active = true
Request structure
N/A
Headers
Request data validation
N/A
Processing
N/A
Response structure examples
N/A
HTTP status codes
Post-processing processes
N/A
Technical modules where the method is used
List of pages describing technical modules where the method is used
Related content
ЕСОЗ - публічна документація