Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

This WS is designed to return a list of detailed information for all active medications (with type innm_dosage) by search parameters.

Specification

Page Properties

Link

https://uaehealthapiehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/drugs/get-drugs-list-v2

Посилання на Apiary або Swagger

Resource

/api/v2/drugs

Посилання на ресурс, наприклад: /api/persons/create

Scope

drugs:read

Scope для доступу

Components

ePrescription, ReimbursementDrugs and Program medications

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Logic

Service returns all medications (with type innm_dosage) filtered by submitted parameters:

...

Input parameters

No

Filters

See on Apiary

Request structure

API paragraph not found

...

API paragraph not found

Request data validation

API paragraph not found

Parameters that are used when processing the request

Configuration parameters

Access to the method is defined by the scope drugs:read. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.

...

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "ae9bf68e-3c98-4027-9211-535f7dad7a87",
      "name": "Аміодарон 200мг таблетки",
      "mr_blank_type": "F-1",
      "dosage_form_is_dosed": false,
      "form": "PILL",
      "daily_dosage": 50,
      "max_daily_dosage": 200,
      "ingredients": [
        {
          "id": "1349a693-4db1-4a3f-9ac6-8c2f9e541982",
          "name": "Інсулін деглюдек",
          "name_original": "Insulin degludec",
          "sctid": "52574003",
          "dosage": {
            "numerator_unit": "MG",
            "numerator_value": 200,
            "denumerator_unit": "PILL",
            "denumerator_value": 1
          },
          "is_primary": true
        }
      ],
      "packages": [
        {
          "container_dosage": {
            "numerator_unit": "PILL",
            "numerator_value": 1,
            "denumerator_unit": "PILL",
            "denumerator_value": 1
          },
          "package_qty": 30,
          "package_min_qty": 10,
          "max_request_dosage": 0,
          "program_medications": [
            {
              "id": "e477a845-972b-47a1-8ca3-1c71e4fd00c2",
              "start_date": "2019-01-01",
              "end_date": "2019-06-30",
              "registry_number": "REG-1111"
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

...