Versions Compared

Key

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

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-001-001-0017

Microservices (namespace)

IL

Component

Contract reports

Component ID

COM-005-001

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/reimbursement-report/get-reimbursement-report

Resource

{{host}}/api/reimbursement_report

Scope

reimbursement_report:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This method is designed to create reimbursement report which is based on Medication request and Medication dispense data. 

Logic

The access and ability to create and get the report have

  1. MSP (OWNER)

  2. PHARMACY (PHARMACY_OWNER)

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.

  • OWNER will receive info only about Medication Requests which were made by his legal_entity and corresponding Medication Dispenses.

  • PHARMACY_OWNER is allowed to view only info related to Medication Dispenses which were made by his PHARMACY and corresponding Medication Requests.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block

Headers

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer c2778f3064753ea70de870a53795f5c9

M

Перевірка користувача

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

3

Request data validation

Authorize

  1. Verify the validity of access token

    1. Return 401 in case validation fails

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

    1. Return 403 in case invalid scope(s)

Get legal entity from token

  1. Extract legal_entity_id (client_id) from token

Get Party from token

  1. Extract party_user (user_id) from token.

Validate FK

  1. Validate 

legal_entity_id - legal_entity_id exists (for MSP and PHARMACY)

In case error - return 422 error:

Code Block
{:error, [{%{
        description: "Legal entity not found",
        params: [],
        rule: :invalid
      }, "$.legal_entity_id"}]}
  1. Validate 

party_id - party_id exists

Code Block
{:error, [{%{ 
        description: "Party not found",
        params: [],
        rule: :invalid
      }, "$.party_id"}]}

 

  1. Validate

legal_enity type - type [MSP, PHARMACY]

In case of error - show 403 error ('Legal_entity type is not allowed to get the report')

Validate statuses

  1. Legal entity should be active in order to create report

    • is_active = true

    • status = 'ACTIVE'

    • in case of error show 403 error ('Legal entity is not active')

  2. Party should refer to active employee in current legal_entity

    • employees.is_active = true

    • employees.status = 'APPROVED'

    • employees.legal_entity_id = client_id (context)

    • in case of error show 403 error ('Employee is not active')

Validate input dates

  1. There is 4 available dates for the filtering: by dispense or/and by request. At least one pair of those dates must be not empty.

          In case of error show 422 error with message must be shown (date_from_request:  "At least one of input dates must be not empty")

  1. Validate input date_from and date_to

    • if date_from_request is not null then: date_from_request<=date_to_request and date_to_request must be filled

      in case of error - return 422 error:

      Code Block
      {:error, [{%{
              description: "Input dates are not valid",
              params: [],
              rule: :invalid
            }, "$.date_from_request"}]}

       

  2. if date_from_dispense is not null then: date_from_dispense<=date_to_dispense and date_to_dispense must be filled

    in case of error - return 422 error:

    Code Block
    {:error, [{%{
            description: "Input dates are not valid",
            params: [],
            rule: :invalid
          }, "$.date_from_dispense"}]}

     

    Input dates filter the field: 

    • date_from_request/date_to_request comparing to field medication_requests.created_at

    • date_from_dispense/date_to_dispense comparing to field medication_dispenses.dispensed_at

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

Processing

Prepare response

  1. Prepare response with fields described below.

  2. To get most of the fields FULL OUTER JOIN tables medication_requests and medication_dispenses (in case there is no dispense to request fill only first part of the table related to Medication Request). To get more details about employee, division, legal_entity, medication, medical_program, dispense_details next tables also should be joined:

    • employees

    • parties

    • legal_entities

    • divisions

    • medications

    • medical_programs

    • medication_dispense_details

Source

Field

Name

Description

Source

Field

Name

Description

medication_requests

id

medication_request_id

 

medication_requests

request_number

request_number

 

medication_requests

created_at

request_created_at

 

medication_requests

started_at

request_started_at

 

medication_requests

ended_at

request_ended_at

 

medication_requests

dispense_valid_from

dispense_valid_from

 

medication_requests

dispense_valid_to

dispense_valid_to

 

medication_requests

person_id

request_person_id

 

employees 

employee_id

employee_id

 

employees

legal_entity_id

msp_id

 

legal_entities 

name

msp_name

 

legal_entities

edrpou

msp_edrpou

 

employees

party_id

doctor_party_id

 

parties

last_name

doctor_last_name

 

parties

first_name

doctor_first_name

 

parties

second_name

doctor_second_name

 

employees

position

doctor_position

 

employees

employee_type

employee_type

 

medication_requests

division_id

msp_division_id

 

divisions

name

msp_division_name

 

divisions

addresses.[type='RESIDENCE']

msp_addresses

 

divisions

mountain_group

msp_division_mountain_group

 

medication_requests

medication_id

innm_dosage_id

 

medications

name

innm_dosage_name

 

medications

form

innm_dosage_form

 

medication_requests

medication_qty

request_medication_qty

 

medication_requests

status

request_status

 

medication_requests

rejected_at

request_rejected_at

 

medication_requests

rejected_by

request_rejected_by

 

medication_requests

reject_reason

request_reject_reason

 

medication_requests

medical_program_id

request_medical_program_id

 

medical_programs

name

request_medical_program_name

 

medical_programs

is_active

request_medical_program_is_active

 

medication_dispenses 

id

medication_dispense_id

 

medication_dispense_details

medication_id

medication_id

 

medications

name

medication_name

 

medications

manufacturer.name

manufacturer_name

 

medications

code_atc

code_atc

 

medications

form

medication_form

 

medications

{container}

container

 

medications

package_qty

package_qty

 

medication_dispense_details

medication_qty

disbursed_medication_qty

 

medication_dispense_details

sell_price

sell_price

 

medication_dispense_details

sell_amount

sell_amount

 

medication_dispense_details

discount_amount

discount_amount

 

medication_dispense_details

reimbursement_amount

reimbursement_amount

 

medication_dispenses

medical_program_id

dispense_medical_program_id

 

medical_programs

name

dispense_medical_program_name

 

medication_dispenses

dispensed_at

dispensed_at

 

medication_dispenses

legal_entity_id

pharmacy_id

 

medication_dispenses

party_id

pharmacist_id

 

parties

first_name

pharmacist_first_name

 

parties

second_name

pharmacist_second_name

 

parties

last_name

pharmacist_last_name

 

legal_entities

name

pharmacy_name

 

legal_entities

edrpou

pharmacy_edrpo

 

medication_dispenses

division_id

pharmacy_divsion_id

 

divisions

division_name

pharmacy_divsion_name

 

divisions

addresses.[type='RESIDENCE']

pharmacy_addresses

 

divisions

mountain_group

pharmacy_division_mountain_group

 

medication_dispenses

status

dispense_status

 

Response structure examples

See on API-specification

Expand
titleExample
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "medication_request": {
        "created_at": "2017-08-17",
        "started_at": "2017-08-17",
        "ended_at": "2017-09-16",
        "dispense_valid_from": "2017-08-17",
        "dispense_valid_to": "2017-09-16",
        "rejected_at": "2017-04-20T19:14:13Z",
        "rejected_by": "2922a240-63db-404e-b730-09222bfeb2dd",
        "person_id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "employee": {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "party_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "last_name": "Іванов",
          "first_name": "Петро",
          "second_name": "Миколайович",
          "position": "P6",
          "employee_type": "DOCTOR"
        },
        "medical_program": {
          "id": "c7d52544-0bd4-4129-97b0-2d72633e0490",
          "name": "Доступні ліки",
          "mr_blank_type": "F-1"
        },
        "medication": {
          "name": "Амідарон",
          "type": "MEDICATION",
          "manufacturer": {
            "name": "ПАТ \"Київський вітамінний завод\"",
            "country": "UA"
          },
          "form": "PILL",
          "container": {
            "numerator_unit": "PILL",
            "numerator_value": 1,
            "denumerator_unit": "PILL",
            "denumerator_value": 1
          },
          "form_pharm": "DISPERSIBLE_TABLET",
          "drlz_sku_id": "0404466792737630283703997321"
        },
        "medication_qty": 10.34,
        "id": "f08ba3a3-157a-4adc-b65d-737f24f3a1f4",
        "dispensed_at": "2017-08-17",
        "dispensed_by": "Аннова Анна Анновна",
        "status": "NEW",
        "medications": [
          {
            "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
            "code_atc": [
              "М01АЕ01",
              "C01BD01"
            ],
            "name": "Амідарон",
            "type": "MEDICATION",
            "manufacturer": {
              "name": "ПАТ \"Київський вітамінний завод\"",
              "country": "UA"
            },
            "form": "PILL",
            "container": {
              "numerator_unit": "PILL",
              "numerator_value": 1,
              "denumerator_unit": "PILL",
              "denumerator_value": 1
            },
            "form_pharm": "DISPERSIBLE_TABLET",
            "drlz_sku_id": "0404466792737630283703997321",
            "package_qty": 30,
            "details": {
              "medication_qty": 10.34,
              "sell_price": 18.65,
              "sell_amount": 186.5,
              "discount_amount": 150,
              "reimbursement_amount": 450
            }
          }
        ],
        "legal_entity": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "name": "Аптека 42",
          "edrpou": "5432345431"
        },
        "division": {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "name": "Бориспільське відділення Аптеки 42",
          "mountain_group": false,
          "address": {
            "type": "RESIDENCE",
            "country": "UA",
            "area": "Житомирська",
            "region": "Бердичівський",
            "settlement": "Київ",
            "settlement_type": "CITY",
            "settlement_id": "b075f148",
            "street_type": "STREET",
            "street": "вул. Ніжинська",
            "building": "15",
            "apartment": "23",
            "zip": "02090"
          }
        },
        "party": {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "last_name": "Іванов",
          "first_name": "Петро",
          "second_name": "Миколайович"
        }
      }
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

1000

200

Response

 

 

3

401

Access token validation failed

 

4

403

Employee is not active

 

5

403

Invalid scope

6

403

Legal_entity type is not allowed to get the report

7

403

Legal entity is not active

8

422

At least one of input dates must be not empty

Validation failed

9

Специфічні

10

422

Only for active MPI record can be created medication request!

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"