Versions Compared

Old Version 6

changes.mady.by.user Bogdana Konovalenko (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Oleksandr Zhuk (SoE eHealth)

Saved on

Key

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

...

...

...

...

...

Table of Contents
minLevel1
maxLevel3

Purpose

...

Status

...

DONE

...

DONE

...

ABSENT

...

SPECS

Purpose

This WS is designed to return Program_medications list by filters.

APIary

Get Program medications list                                               

Input parameters (filters)

  • id (optional)
  • medical_program_id (optional)
  • medical_program_name (optional, as `LIKE *`)
  • innm_id (optional)
  • innm_name (optional, as `LIKE *`)
  • medication_id (optional)
  • medication_name (optional, as `LIKE *`)

Logic WS

...

Search Program_medications by filters and show:

...

id (program_medications_id)

medical_program_name

medication_name
form
manufacturer 
reimbursement_amount
innm_name

When filter by innm we show only medication where this innm in medication.dosage has is_active_substance=true.

Prepare & return response data structure

...

Method returns list of participants (medications) of medical programs filtering by parameters.

Specification

Page Properties

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/program-medications/get-program-medication-list

Resource

/program_medications

Scope

program_medication:read

Components

Drugs and Program medications

Microservices

APIparagraph not found

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

Internal. NHS Admin

Logic

  1. Get all medical programs from prm.program_medications table filtered by search params.

  2. Render a response according to specification.

Filters

Filter

Values

Type

Description

Example

id

String

Program_medications Identifier (medication within the program)

7124259c-eeb1-4cbb-acac-ada2162675d1

medical_program_id

String

medical program identifier

042a3b20-bb08-4e50-83ee-ef23c3b1c0c8

medical_program_name

String

medical program name

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

innm_dosage_id

String

INNM dosage Identifier

5052fcaf-58a0-461b-9e98-d60243a1773e

innm_dosage_name

String

INNM dosage name

Артитміл 5 мг

medication_id

String

Medication Identifier

d290f1ee-6c54-4b01-90e6-d701748f0851

medication_name

String

Medication name

Аритміл

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

Authorize

  1. Verify the validity of access token

    1. In case error - generate 401 response

  2. Check user scope (scope = 'program_medication:read') in order to perform this action

    1. In case error - generate 403 response

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

Response structure

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "medication": {
        "id": "09b2bffb-699a-43c0-bc9a-5066d9b9b5a8",
        "name": "Амідарон",
        "manufacturer": {
          "name": "ПАТ \"Київський вітамінний завод\"",
          "country": "UA"
        },
        "code_atc": [
          "М01АЕ01",
          "C01BD01"
        ],
        "form": "PILL",
        "container": {
          "numerator_unit": "PILL",
          "numerator_value": 1,
          "denumerator_unit": "PILL",
          "denumerator_value": 1
        },
        "package_qty": 30,
        "package_min_qty": 10,
        "daily_dosage": "12",
        "certificate": "UA/4514/01/01",
        "certificate_expired_at": "2021-02-09",
        "ingredients": [
          {
            "id": "1349a693-4db1-4a3f-9ac6-8c2f9e541982",
            "name": "Амідарон",
            "dosage": {
              "numerator_unit": "MG",
              "numerator_value": 200,
              "denumerator_unit": "PILL",
              "denumerator_value": 1
            },
            "is_primary": true
          }
        ],
        "is_active": true,
        "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",
        "drlz_sku_id": "0404466792737630283703997321"
      },
      "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",
        "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"
      },
      "medication_request_allowed": true,
      "reimbursement": {
        "type": "fixed",
        "reimbursement_amount": 450
      },
      "wholesale_price": "148.50",
      "consumer_price": "150.00",
      "daily_dosage": "200",
      "reimbursement_daily_dosage": "10.4858",
      "estimated_payment_amount": "34.50",
      "is_active": true,
      "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
  }
}

HTTP status codes

Page Properties

HTTP status code

Message

What caused the error

 200