Перейти до основного вмісту

Medication dispense/Get processed medication dispenses​

URI: /medication/get-dispense-data/

Метод використовується для повернення даних про видачу ліків.

Запит виконується методом POST у json форматі з даними.

Заголовки​

Запит обов'язково повинен мати заголовок Content-Type: application/json, інакше запит буде вважатися некоректним навіть при валідному JSON у ньому.

Для підтвердження запиту користувача API необхідно передавати заголовок API-Key.

Для автентифікації користувача, який обробив запит API, потрібно передати заголовок авторизації з токеном у форматі Bearer.

Наприклад: Authorization = "Bearer TOKEN".

Параметри запиту​

Ім'яТипОбов'язковийОпис
idstringТакНомер рецепта

Приклад запиту​

Запит: v2/medication/get-dispense-data/
{
    "id": "9bc02652-382b-4ec3-861a-aa868d466408"
}

Параметри відповіді​

У таблиці наведено опис параметрів, які повертаються всередині об'єкта data у відповіді.

Ім'яТипОпис
dataobjectДані платежу
data.medicationDispensestringВидача ліків
data.medicationDispense.detailslist[object]Параметри дозування
medicationDispense.details.discount_amountfloatСума знижки
medicationDispense.details.medicationobjectІнформація про ліки
medicationDispense.details.medication.containerobjectФорма випуску ліків
medicationDispense.details.medication.container.
denumerator_unit		stringОдиниця виміру лікарської форми
medicationDispense.details.medication.container.
denumerator_value		floatЗначення лікарської форми
medicationDispense.details.medication.container.
numerator_unit		stringОдиниця виміру дозування
medicationDispense.details.medication.container.
numerator_value		floatЗначення виміру дозування
medicationDispense.details.medication.drlz_sku_idstring
medicationDispense.details.medication.formstringТип пакування ліків
medicationDispense.details.medication.form_pharmstring
medicationDispense.details.medication.idstringІдентифікатор ліків
medicationDispense.details.medication.manufacturerobjectПараметри виробника ліків
medicationDispense.details.medication.manufacturer.countrystringКраїна виробник ліків
medicationDispense.details.medication.manufacturer.namestringНазва виробника ліків
medicationDispense.details.medication.namestringНазва ліків
medicationDispense.details.medication.typestringТип ліків
medicationDispense.details.medication_qtyintegerКількість ліків
medicationDispense.details.program_medication_idstringідентифікатор програми лікарського засобу
medicationDispense.details.reimbursement_amountfloatСума відшкодування
medicationDispense.details.sell_amountintegerСума продажу
medicationDispense.details.sell_pricefloatЦіна продажу
medicationDispense.dispensed_atstringДата видачі ліків
medicationDispense.dispensed_bystringКим видано ліки
medicationDispense.divisionobjectПараметри відділення
medicationDispense.division.addresseslist[object]Містить параметри адреси відділення
medicationDispense.division.addresses.apartmentstringНомер квартири
medicationDispense.division.addresses.areastringОбласть
medicationDispense.division.addresses.buildingstringНомер будинку
medicationDispense.division.addresses.countrystringКраїна
medicationDispense.division.addresses.regionstringРайон
medicationDispense.division.addresses.settlementstringНаселений пункт
medicationDispense.division.addresses.settlement_idstringІдентифікатор населеного пункту
medicationDispense.division.addresses.settlement_typestringТип населеного пункту
medicationDispense.division.addresses.streetstringВулиця
medicationDispense.division.addresses.street_typestringТип вулиці
medicationDispense.division.addresses.typestringТип закладу
medicationDispense.division.addresses.zipstringПоштовий індекс
medicationDispense.division.dls_idstring
medicationDispense.division.dls_verifiedboolean
medicationDispense.division.emailstringАдреса електронної пошти
medicationDispense.division.external_idstringЗовнішній ідентифікатор
medicationDispense.division.idstringІдентифікатор відділення
medicationDispense.division.legal_entity_idstringІдентифікатор юридичної особи
medicationDispense.division.locationobjectМісцеположення відділення
medicationDispense.division.location.latitudefloatШирота
medicationDispense.division.location.longitudefloatДовгота
medicationDispense.division.mountain_groupboolean
medicationDispense.division.namestringНазва відділення
medicationDispense.division.phoneslist[object]Містить параметри номерів телефона
medicationDispense.division.phones.numberstringНомер телефона
medicationDispense.division.phones.typestringТип телефона
medicationDispense.division.statusstringСтатус відділення
medicationDispense.division.typestringТип відділення
medicationDispense.division.working_hoursobjectМістить інформацію про робочий час відділення
medicationDispense.idstringІдентифікатор лікарського засобу
medicationDispense.inserted_atstring
medicationDispense.inserted_bystring
medicationDispense.legal_entityobjectПараметри юридичної особи
medicationDispense.legal_entity.edrpoustringЄДРПОУ
medicationDispense.legal_entity.idstringІдентиіфкатор
medicationDispense.legal_entity.namestringТип власності
medicationDispense.legal_entity.public_namestringЗагальне ім'я відділення
medicationDispense.legal_entity.short_namestringКоротке ім'я відділення
medicationDispense.legal_entity.statusstringПоточний статус відділення
medicationDispense.legal_entity.typestringТип відділення
medicationDispense.medical_programobjectПараметри медичної програми
medicationDispense.medical_program.funding_sourcestringДжерело фінансування
medicationDispense.medical_program.idstringІдентифікатор медичної програми
medicationDispense.medical_program.inserted_atstring
medicationDispense.medical_program.inserted_bystring
medicationDispense.medical_program.is_activestringПризнак активності медичної програми
medicationDispense.medical_program.medication_dispense_allowedstringПризнак активності медичної програми
medicationDispense.medical_program.medication_dispense_allowed_textstringПризнак активності медичної програми
medicationDispense.medical_program.medication_request_allowedstringПризнак активності медичної програми
medicationDispense.medical_program.mmedication_request_allowed_textstringПризнак активності медичної програми
medicationDispense.medical_program.mr_blank_typestringПризнак активності медичної програми
medicationDispense.medical_program.namestringНазва медичної програми
medicationDispense.medical_program.typestringТип медичної програми
medicationDispense.medical_program.updated_atstringЧас останнього оновлення медичної програми
medicationDispense.medical_program.updated_bystringКим оновлено медичну програму
medicationDispense.medication_requestobjectРецепт на ліки
medicationDispense.medication_request.categorystringКатегорія ліків
medicationDispense.medication_request.contextstring
medicationDispense.medication_request.context.identifierstring
medicationDispense.medication_request.context.identifier.typestringТип ліків
medicationDispense.medication_request.context.identifier.type.codingstring
medicationDispense.medication_request.context.identifier.type.coding.codestring
medicationDispense.medication_request.context.identifier.type.coding.systemstring
medicationDispense.medication_request.context.identifier.valuestringПризначення ліків
medicationDispense.medication_request.created_atstringДата створення рецепта
medicationDispense.medication_request.dispense_valid_fromstringДата з якої дозволений відпуск ліків
medicationDispense.medication_request.dispense_valid_tostringДата до якої дозволений відпуск ліків
medicationDispense.medication_request.dosage_instructionlist[object]Містить інструкцію по дозуванню ліків
medicationDispense.medication_request.
dosage_instruction.max_dose_per_administration		objectМістить інформацію про максимальне дозування за прийом
medicationDispense.medication_request.
dosage_instruction.max_dose_per_administration.code		stringКод дозування
medicationDispense.medication_request.
dosage_instruction.max_dose_per_administration.system		stringСистема з якої беруться параметри
medicationDispense.medication_request.
dosage_instruction.max_dose_per_administration.unit		stringОдиниця виміру дозування
medicationDispense.medication_request.
dosage_instruction.max_dose_per_administration.value		floatЗначення дозування
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period		objectМістить інформацію про максимальне дозування за період
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.denominator		objectМістить параметри періоду дозування
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.denominator.code		stringКод періоду
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.denominator.system		stringСистема з якої беруться параметри
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.denominator.unit		stringОдиниця виміру періоду
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.denominator.value		integerЗначення періоду
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.numerator		objectМістить параметри дозування за період
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.numerator.code		stringКод дозування
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.numerator.system		stringСистема з якої беруться параметри
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.numerator.unit		stringОдиниця виміру дозування
medicationDispense.medication_request.
dosage_instruction.max_dose_per_period.numerator.value		integerЗначення дозування
medicationDispense.medication_request.
dosage_instruction.sequence		integerКод послідовності прийому ліків
medicationDispense.medication_request.
dosage_instruction.text		stringТекстовий опис послідовності прийому ліків
medicationDispense.medication_request.ended_atstringДата закінчення дії рецепта
medicationDispense.medication_request.idstringІдентифікатор рецепта
medicationDispense.medication_request.intentstringНамір
medicationDispense.medication_request.is_blockedbooleanПризнак заблокованого рецепта
medicationDispense.medication_request.medication_infostringІнформація про лікарський засіб
medicationDispense.medication_request.
medication_info.dosage		objectІнформація про лікарську форму ліків
medicationDispense.medication_request.
medication_info.dosage.denumerator_unit		stringОдиниця виміру лікарської форми
medicationDispense.medication_request.
medication_info.dosage.denumerator_value		floatЗначення лікарської форми
medicationDispense.medication_request.
medication_info.dosage.numerator_unit		stringОдиниця виміру дозування
medicationDispense.medication_request.
medication_info.dosage.numerator_value		floatЗначення виміру дозування
medicationDispense.medication_request.
medication_info.form		stringТип пакування ліків
medicationDispense.medication_request.
medication_info.ingredients		stringМістить перелік інгредиєнтів ліків
medicationDispense.medication_request.
medication_info.ingredients.dosage		stringМістить параметри дозування лаків
medicationDispense.medication_request.
medication_info.ingredients.dosage.denumerator_unit		stringОдиниця виміру лікарської форми
medicationDispense.medication_request.
medication_info.ingredients.dosage.denumerator_value		floatЗначення лікарської форми
medicationDispense.medication_request.
medication_info.ingredients.dosage.numerator_unit		stringОдиниця виміру дозування
medicationDispense.medication_request.
medication_info.ingredients.dosage.numerator_value		floatЗначення виміру дозування
medicationDispense.medication_request.
medication_info.ingredients.id		stringІдентифікатор інгредієнта
medicationDispense.medication_request.
medication_info.ingredients.is_primary		booleanПризнак основного інгредієнта
medicationDispense.medication_request.
medication_info.ingredients.name		stringНазва інгредієнта
medicationDispense.medication_request.
medication_info.ingredients.name_original		stringНазва оригіналу лікарського засобу
medicationDispense.medication_request.
medication_info.ingredients.sctid		nullТКІД
medicationDispense.medication_request.
medication_info.medication_id		stringІдентифікатор ліків
medicationDispense.medication_request.
medication_info.medication_name		stringПовна назва ліків
medicationDispense.medication_request.
medication_info.medication_qty		integerКількість ліків
medicationDispense.medication_request.personobjectПараметри клієнта
medicationDispense.medication_request.
person.age		integerВік клієнта
medicationDispense.medication_request.
person.short_name		stringКоротке ім'я клієнта
medicationDispense.medication_request.request_numberstringНомер рецепта
medicationDispense.medication_request.started_atstringДата початку дії рецепта
medicationDispense.medication_request.statusstringПоточний статус рецепта
medicationDispense.partyobject
medicationDispense.party.birth_datestringДата народження
medicationDispense.party.first_namestringІм'я працівника
medicationDispense.party.idstring
medicationDispense.party.last_namestringПрізвище працівника
medicationDispense.party.no_tax_idboolean
medicationDispense.party.phoneslist[object]Містить номера телефонів працівника
medicationDispense.party.phones.numberstringНомер телефона працівника
medicationDispense.party.phones.typestringТип телефона
medicationDispense.payment_amountfloatСума платежу
medicationDispense.payment_idstringІдентифікатор платежу
medicationDispense.statusstringСтатус платежу
medicationDispense.updated_atstringЧас останнього оновлення
medicationDispense.updated_bystringКим оновлено

Приклад відповіді​

Відповідь: /medication/get-dispense-data/
   "data": {
      "medicationDispense": {
        "details": [
          {
            "discount_amount": 53.76,
            "medication": {
              "container": {
                "denumerator_unit": "BLISTER",
                "denumerator_value": 1,
                "numerator_unit": "PIECE",
                "numerator_value": 10
              },
              "drlz_sku_id": null,
              "form": "TABLET",
              "form_pharm": null,
              "id": "60bedc6c-185d-4f4d-99a2-4609d520df37",
              "manufacturer": {
                "country": "UA",
                "name": "АТ \"КИЇВСЬКИЙ ВІТАМІННИЙ ЗАВОД\""
              },
              "name": "АМЛОДИПІН-КВ",
              "type": "BRAND"
            },
            "medication_qty": 180,
            "program_medication_id": "8a9f64b0-8afb-4c5e-8742-306ceb6a23af",
            "reimbursement_amount": 8.98,
            "sell_amount": 103.86,
            "sell_price": 17.31
          }
        ],
        "dispensed_at": "2024-02-23",
        "dispensed_by": "Користувач Користувач Користувацький",
        "division": {
          "addresses": [
            {
              "apartment": "24",
              "area": "М.КИЇВ",
              "building": "3",
              "country": "UA",
              "region": null,
              "settlement": "КИЇВ",
              "settlement_id": "adaa4abf-f530-461c-bcbf-a0ac210d955b",
              "settlement_type": "CITY",
              "street": "Данченко",
              "street_type": "STREET",
              "type": "RESIDENCE",
              "zip": null
            }
          ],
          "dls_id": null,
          "dls_verified": null,
          "email": "[email protected]",
          "external_id": null,
          "id": "d19b9f35-7ac6-43ff-ab6c-74977f9fb8bd",
          "legal_entity_id": "dbf1e01c-38a5-49b0-a15b-6059c0ee82a9",
          "location": {
            "latitude": 50.424260171732,
            "longitude": 30.561219409884
          },
          "mountain_group": false,
          "name": "Аптека №1",
          "phones": [
            {
              "number": "+380669340972",
              "type": "MOBILE"
            }
          ],
          "status": "ACTIVE",
          "type": "DRUGSTORE",
          "working_hours": null
        },
        "id": "64514a64-50e4-411e-ba27-06b8faa0249c",
        "inserted_at": "2024-02-23T07:14:03Z",
        "inserted_by": "5201df65-5980-41a5-bcdc-46426e56b444",
        "legal_entity": {
          "edrpou": "2750018245",
          "id": "dbf1e01c-38a5-49b0-a15b-6059c0ee82a9",
          "name": "КОМПАНІЯ",
          "public_name": "КОМПАНІЯ",
          "short_name": null,
          "status": "ACTIVE",
          "type": "PHARMACY"
        },
        "medical_program": {
          "funding_source": "NHS",
          "id": "63c1f32f-c8f4-4f5b-81a9-79b8452d6545",
          "inserted_at": "2017-12-05T13:27:08.100162Z",
          "inserted_by": "4261eacf-8008-4e62-899f-de1e2f7065f0",
          "is_active": true,
          "medication_dispense_allowed": true,
          "medication_dispense_allowed_text": null,
          "medication_request_allowed": true,
          "medication_request_allowed_text": null,
          "mr_blank_type": "F-1",
          "name": "Серцево-судинні та цереброваскулярні захворювання, цукровий діабет 2-го типу та хронічні хвороби нижніх дихальних шляхів",
          "type": "MEDICATION",
          "updated_at": "2023-12-25T13:13:56.683791Z",
          "updated_by": "e41dee83-6f9d-46fa-b482-decf7e134d42"
        },
        "medication_request": {
          "category": "community",
          "context": {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "code": "encounter",
                    "system": "eHealth/resources"
                  }
                ]
              },
              "value": "77ad865c-56ec-4253-9208-d0cb86f9e870"
            }
          },
          "created_at": "2024-02-22",
          "dispense_valid_from": "2024-02-22",
          "dispense_valid_to": "2024-03-23",
          "dosage_instruction": [
            {
              "max_dose_per_administration": {
                "code": "PIECE",
                "system": "eHealth/ucum/units",
                "unit": "PIECE",
                "value": 10
              },
              "max_dose_per_period": {
                "denominator": {
                  "code": "day",
                  "system": "eHealth/ucum/units",
                  "unit": "доба",
                  "value": 1
                },
                "numerator": {
                  "code": "PIECE",
                  "system": "eHealth/ucum/units",
                  "unit": "PIECE",
                  "value": 10
                }
              },
              "sequence": 1,
              "text": "1 таб. 1 раз на добу"
            }
          ],
          "ended_at": "2024-04-22",
          "id": "c3724f44-c9c5-43bb-959f-f92b44ecfd3b",
          "intent": "order",
          "is_blocked": false,
          "medication_info": {
            "dosage": {
              "denumerator_unit": "PIECE",
              "denumerator_value": 1,
              "numerator_unit": "MG",
              "numerator_value": 5
            },
            "form": "TABLET",
            "ingredients": [
              {
                "dosage": {
                  "denumerator_unit": "PIECE",
                  "denumerator_value": 1,
                  "numerator_unit": "MG",
                  "numerator_value": 5
                },
                "id": "4483a8d7-9cec-4c47-a6b5-fbc3963360ca",
                "is_primary": true,
                "name": "Амлодипін",
                "name_original": "Amlodipine",
                "sctid": null
              }
            ],
            "medication_id": "1566bf63-5666-4368-b2e9-352bbfbd7358",
            "medication_name": "Амлодипін 5 MG таблетки",
            "medication_qty": 180
          },
          "person": {
            "age": 24,
            "short_name": "Персона П."
          },
          "request_number": "0000-2THE-KK5H-MT09",
          "started_at": "2024-02-22",
          "status": "COMPLETED"
        },
        "party": {
          "birth_date": "1977-07-07",
          "first_name": "Користувач",
          "id": "d25ddb91-893e-4ed0-9143-faf2ac2954d0",
          "last_name": "Користувач",
          "no_tax_id": false,
          "phones": [
            {
              "number": "+380668340972",
              "type": "MOBILE"
            }
          ]
        },
        "payment_amount": 50.1,
        "payment_id": "162800496",
        "status": "PROCESSED",
        "updated_at": "2024-02-23T07:14:05Z",
        "updated_by": "5201df65-5980-41a5-bcdc-46426e56b444"
      }
    }