| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This method is designed to create reimbursement report which is based on Medication request and Medication dispense data.
Logic
The access and ability to create and get the report have
...
OWNER will receive info only about Medication Requests which were made by his legal_entity and corresponding Medication Dispenses.
PHARMACY_OWNER is allowed to view only info related to Medication Dispenses which were made by his PHARMACY and corresponding Medication Requests.
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
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 | composition_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Headers
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | Authorization:Bearer c2778f3064753ea70de870a53795f5c9 |
| 3 |
Request data validation
Get legal entity from token
Extract legal_entity_id (client_id) from token
Get Party from token
Extract party_user (user_id) from token.
Validate FK
Validate
legal_entity_id - legal_entity_id exists (for MSP and PHARMACY)
...
Legal entity should be active in order to create report
is_active = true
status = 'ACTIVE'
in case of error show 403 error ('Legal entity is not active')
Party should refer to active employee in current legal_entity
employees.is_active = true
employees.status = 'APPROVED'
employees.legal_entity_id = client_id (context)
in case of error show 403 error ('Employee is not active')
Validate input dates
There is 4 available dates for the filtering: by dispense or/and by request. At least one pair of those dates must be not empty.
...
If there is no data available for the requested period of time in response must be sent empty json, no error is shown.
Processing
Prepare response
Prepare response with fields described below.
To get most of the fields FULL OUTER JOIN tables medication_requests and medication_dispenses (in case there is no dispense to request fill only first part of the table related to Medication Request). To get more details about employee, division, legal_entity, medication, medical_program, dispense_details next tables also should be joined:
employees
parties
legal_entities
divisions
medications
medical_programs
medication_dispense_details
...
Source | Field | Name | Description |
|---|---|---|---|
medication_requests | id | medication_request_id |
|
medication_requests | request_number | request_number |
|
medication_requests | created_at | request_created_at |
|
medication_requests | started_at | request_started_at |
|
medication_requests | ended_at | request_ended_at |
|
medication_requests | dispense_valid_from | dispense_valid_from |
|
medication_requests | dispense_valid_to | dispense_valid_to |
|
medication_requests | person_id | request_person_id |
|
employees | employee_id | employee_id |
|
employees | legal_entity_id | msp_id |
|
legal_entities | name | msp_name |
|
legal_entities | edrpou | msp_edrpou |
|
employees | party_id | doctor_party_id |
|
parties | last_name | doctor_last_name |
|
parties | first_name | doctor_first_name |
|
parties | second_name | doctor_second_name |
|
employees | position | doctor_position |
|
employees | employee_type | employee_type |
|
medication_requests | division_id | msp_division_id |
|
divisions | name | msp_division_name |
|
divisions | addresses.[type='RESIDENCE'] | msp_addresses |
|
divisions | mountain_group | msp_division_mountain_group |
|
medication_requests | medication_id | innm_dosage_id |
|
medications | name | innm_dosage_name |
|
medications | form | innm_dosage_form |
|
medication_requests | medication_qty | request_medication_qty |
|
medication_requests | status | request_status |
|
medication_requests | rejected_at | request_rejected_at |
|
medication_requests | rejected_by | request_rejected_by |
|
medication_requests | reject_reason | request_reject_reason |
|
medication_requests | medical_program_id | request_medical_program_id |
|
medical_programs | name | request_medical_program_name |
|
medical_programs | is_active | request_medical_program_is_active |
|
medication_dispenses | id | medication_dispense_id |
|
medication_dispense_details | medication_id | medication_id |
|
medications | name | medication_name |
|
medications | manufacturer.name | manufacturer_name |
|
medications | code_atc | code_atc |
|
medications | form | medication_form |
|
medications | {container} | container |
|
medications | package_qty | package_qty |
|
medication_dispense_details | medication_qty | disbursed_medication_qty |
|
medication_dispense_details | sell_price | sell_price |
|
medication_dispense_details | sell_amount | sell_amount |
|
medication_dispense_details | discount_amount | discount_amount |
|
medication_dispense_details | reimbursement_amount | reimbursement_amount |
|
medication_dispenses | medical_program_id | dispense_medical_program_id |
|
medical_programs | name | dispense_medical_program_name |
|
medication_dispenses | dispensed_at | dispensed_at |
|
medication_dispenses | legal_entity_id | pharmacy_id |
|
medication_dispenses | party_id | pharmacist_id |
|
parties | first_name | pharmacist_first_name |
|
parties | second_name | pharmacist_second_name |
|
parties | last_name | pharmacist_last_name |
|
legal_entities | name | pharmacy_name |
|
legal_entities | edrpou | pharmacy_edrpo |
|
medication_dispenses | division_id | pharmacy_divsion_id |
|
divisions | division_name | pharmacy_divsion_name |
|
divisions | addresses.[type='RESIDENCE'] | pharmacy_addresses |
|
divisions | mountain_group | pharmacy_division_mountain_group |
|
medication_dispenses | status | dispense_status |
|
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 1000 | 200 | Response |
|
|
| 3 | 401 | Access token validation failed |
| ||
| 4 | 403 | Employee is not active |
| ||
| 5 | 403 | Invalid scope | |||
| 6 | 403 | Legal_entity type is not allowed to get the report | |||
| 7 | 403 | Legal entity is not active | |||
| 8 | 422 | At least one of input dates must be not empty | Validation failed | ||
| 9 | Специфічні | ||||
| 10 | 422 | Only for active MPI record can be created medication request! | |||
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
| Page Properties Report | ||||
|---|---|---|---|---|
|
...