Purpose

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

Specification

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.

Filters

See on Apiary

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)

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

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:

1. Validate 

party_id - party_id exists

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:
     
     

     {: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:
   
   

    

   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

Response structure

Example:

Post-processing processes

API paragraph not found

HTTP status codes