Table of Contents

Page Properties

id	API_Specification

Link	NHS adminhttps://ehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/reimbursement-report/get-reimbursement-report	Посилання на Apiary або Swagger
Resource	NHS admin/api/reimbursement_report_download	Посилання на ресурс, наприклад: /api/persons/create
Scope	reimbursement_report:download	Scope для доступу
Components	API paragraph not foundePrescription	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	API paragraph not foundREST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	API paragraph not foundGET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	API paragraph not found	Метод є синхронним чи асинхронним?
Public/Private/Internal	Internal	Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

Request structure

...

The access and ability to create and get the report have NHS admin.
To get the report the creator must input requested period (date_from_request, date_to_request, date_from_dispense, date_to based on date of dispense or request). In response will be received the json with data.

Filters

See onApiary

Authorize

Verify the validity of access token
1. Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'reimbursement_report:download')
1. Return 403 in case invalid scope(s)

Headers

...

Request data validation

Validate input dates

...

If there is no data available for the requested period of time in response must be sent empty file, no error is shown.

Processing

...

Response structure

Prepare response

Output format - text/csv

...

REQUESTED_FIELD

REPORT_FIELD

SOURCE

COMMENT

Назва суб’єкту господарювання (аптека)

pharmacy_name

medication_dispense.legal_entity.name

Код ЄДРПОУ суб'єкту господарювання (аптека)

pharmacy_edrpou

medication_dispense.legal_entity.edrpou

Назва закладу охорони здоров’я

msp_name

medication_request.legal_entity.name

Код ЄДРПОУ закладу охорони здоров’я

msp_edrpou

medication_request.legal_entity.edrpou

Лікар, що виписав рецепт (ПІБ)

doctor_name

medication_request.employee.party.last_name&first_name&second_name

Лікар, що виписав рецепт (ID)

doctor_id

medication_request.employee.id

№ Номер рецепта

request_number

medication_request.request_number

Дата створення рецепта

created_at

medication_request.created_at

Дата відпуску рецепта

dispensed_at

medication_dispense.dispensed_at

Міжнародна непатентована назва лікарського засобу (словник реєстру)

innm_name

Code Block
select i.namefrom ingredients ing inner join innms i on ing.innm_child_id=i.id where ing.parent_id=$medication_dispense.innm_dosage.id and is_primary=true

Лікарська форма

innm_dosage_name

medication_request.medication.name

innm_dosage

Торгова назва лікарського засобу

medication_name

medication_dispense.details.medication.name

Сила дії (дозування)

-----

do not show

Форма випуску (словник реєстру)

form

medication_dispense.details.medication.form

Кількість одиниць лікарської форми відповідної дози в упаковці, од.

package_qty

medication_dispense.details.medication.package_qty

Кількість відпущених упаковок, упак

/Кількість відпущених ліків, одиниць

medication_qty

medication_dispense_details.medication_qty

units, not packages

Фактична роздрібна ціна реалізації упаковки, грн

sell_amount

medication_dispense_details.sell_amount

Розмір відшкодування вартості лікарського засобу за упаковку, грн

reimbursement_amount

medication_dispense_details.reimbursement_amount

Сума відшкодування, грн

discount_amount

medication_dispense_details.discount_amount

Сума доплати за упаковку ЛЗ, грн

/ Фактична роздрібна ціна за одиницю, грн

sell_price

medication_dispense_details.sell_price

instead we show all fields to be able to calculate this value

Номер фіксального чеку

payment_id

medication_dispense.payment_id

Сума транзакції

payment_amount

medication_dispense.payment_amount

Post-processing processes

...

HTTP status codes

Page Properties

id	API_HTTP status codes

HTTP status code	Message	What caused the error
401		Access token validation failed
403		Invalid scope(s)
422		Validation error

...

Version	Old Version 16	New Version Current
Changes made by	Dmytro Kulibaba (Unlicensed)	Oleksandr Zhuk (SoE eHealth) (Unlicensed)
Saved on	Jan 05, 2023	Feb 08, 2023

Versions Compared

Key

Logic

Request structure

The access and ability to create and get the report have NHS admin.
To get the report the creator must input requested period (date_from_request, date_to_request, date_from_dispense, date_to based on date of dispense or request). In response will be received the json with data.

Filters

Authorize

Headers

Request data validation

Validate input dates

Processing

Response structure

Prepare response

Post-processing processes

HTTP status codes

Content Comparison

Versions Compared

Key

Logic

Request structure

The access and ability to create and get the report have NHS admin.To get the report the creator must input requested period (date_from_request, date_to_request, date_from_dispense, date_to based on date of dispense or request). In response will be received the json with data.

Filters

Authorize

Headers

Request data validation

Validate input dates

Processing

Response structure

Prepare response

Post-processing processes

HTTP status codes

The access and ability to create and get the report have NHS admin.
To get the report the creator must input requested period (date_from_request, date_to_request, date_from_dispense, date_to based on date of dispense or request). In response will be received the json with data.