Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

This WS allows getting stats of medical programs already provided by the divisions of the legal entity. Also, this list can be filtered using search parameters.

Key points

...

No authorization is needed to get provision stats.

...

The method returns a list of all Medical programs provision in the system with detailed data from the Report database.

Table of Contents
minLevel1
maxLevel3

Purpose

Searche Medical program provision by parameters and returne it's details

Specification

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

Link

Посилання на Apiary або SwaggerAPI paragraph not found

Resource

/reports/stats/medical_program_provision

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

Scope

API paragraph not found

Scope для доступу

Public/Private/Internal

Internal

Components

ePrescription

Scope

Not required

Components

Medical program provision

Microservices

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

Protocol type

REST

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

Request type

GET

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

Sync/Async

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

Public/Private/Internal

Internal

Logic

Get and render all the records from Report DB, medical_program_provision table filtered by search params.

Preconditions

API paragraph not found

Global and configurable parameters

No

Input parameters

No

Filters

See on Apiary

Dictionaries

API paragraph not foundMethod searches Medical program provision by parameters and returnes it's details

Filters

Filter

Values

Type

Description

Example

id

String

provision ID

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

medical_program_id

String

Medical program ID

a175f148-7f93-4fc2-b2ec-2d81b19a9b8a

medical_program_name

String

the name of medical program

Доступні ліки

division_id

String

ID of the division that provides a program

c275f148-7f93-4fc2-b2ec-2d81b19a9b8c

division_name

String

the name of pharmacy division

Аптека доброго здоров'я

is_active

Boolean

Medical program provision status

true

page

Number

2

page_size

Number

50

Request structure

API paragraph not found

Authorize

API paragraph not found

...

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json

...

Request data validation

API paragraph not found

Dictionaries

  • MEDICAL_PROGRAM_TYPE

  • FUNDING_SOURCE

  • MR_BLANK_TYPES

  • ADDRESS_TYPE

  • COUNTRY

  • SETTLEMENT_TYPE

  • STREET_TYPE

  • PHONE_TYPE

Processing

API paragraph not found

...

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "3e34da3d-9b8c-4aaf-be8e-24a161279b6a",
      "medical_program": {
        "id": "c7d52544-0bd4-4129-97b0-2d72633e0490",
        "name": "Доступні ліки",
        "medical_program_settings": {
          "care_plan_required": true,
          "employee_types_to_create_medication_request": [
            "SPECIALIST",
            "DOCTOR"
          ],
          "skip_mnn_in_treatment_period": true,
          "skip_employee_validation": true,
          "speciality_types_allowed": [
            "ENDOCRINOLOGY",
            "PEDIATRIC_NEUROLOGY"
          ],
          "conditions_icd10_am_allowed": [
            "A00.0",
            "A00.1"
          ],
          "conditions_icpc2_allowed": [
            "A01",
            "A02"
          ],
          "providing_conditions_allowed": [
            "INPATIENT",
            "OUTPATIENT"
          ],
          "medication_request_max_period_day": 90,
          "skip_medication_request_employee_declaration_verify": true,
          "skip_medication_request_legal_entity_declaration_verify": true,
          "multi_medication_dispense_allowed": true,
          "skip_medication_dispense_sign": true,
          "medication_request_notification_disabled": true,
          "skip_contract_provision_verify": true,
          "medication_dispense_period_day": 90
        },
        "medical_program_settings_text": "Some text",
        "is_active": true,
        "medication_dispense_allowed": true,
        "medication_dispense_allowed_text": "Some text",
        "medication_request_allowed": true,
        "medication_request_allowed_text": "Some text",
        "type": "MEDICATION",
        "funding_source": "NHS",
  
     "mr_blank_type": "F-1"
      },
      "division": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "Aдоніс",
        "type": "DRUGSTORE",
        "addresses": {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        },
        "contacts": {
          "email": "email@example.com",
          "phones": [
            {
              "type": "MOBILE",
              "number": "+380503410870"
            }
          ]
        },
        "coordinates": {
          "latitude": 30.1233,
          "longitude": 50.32423
        },
        "legal_entity": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "edrpou": "32323454",
          "type": "PRIMARY_CARE",
          "residence_address": {
            "type": "RESIDENCE",
            "country": "UA",
            "area": "Житомирська",
            "region": "Бердичівський",
            "settlement": "Київ",
            "settlement_type": "CITY",
            "settlement_id": "b075f148",
            "street_type": "STREET",
            "street": "вул. Ніжинська",
            "building": "15",
            "apartment": "23",
            "zip": "02090"
          },
          "phones": [
            {
              "type": "MOBILE",
              "number": "+380503410870"
            }
          ],
          "email": "email@example.com",
          "website": "www.msp.com.ua",
          "status": "ACTIVE"
        },
        "status": "ACTIVE",
        "dls_id": "2872985",
        "dls_verified": true
      },
      "is_active": true,
      "deactivate_reason": "MANUAL_DEACTIVATION",
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

...

API paragraph not found

HTTP status codes

...

HTTP status code

Message

What caused the error

 200

...

 

 

...

Backward compatibility

...