...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
...
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
Purpose
This WS is designed to Pre-qualify data of Medication request Request (post) - check whether it's possible to use Medication request within the particular Medical program.
...
plan - The request represents an intention to ensure something occurs without providing authorization for others to act. Medication request with type plan can't be dispensed and only provide the instruction to administer the medicine. It also can't be qualified
order - The request represents a request/demand and authorization for action. Medication request with type order can be dispensed.
Preconditions
Only authenticated and authorized users with appropriate scope can invoke Prequalify Medication Request Request (MRR)
This method simply returns the result of data validation within each submitted medical program, but not creates any entities in the system
Each Medical program may have its unique conditions for the medication dispense. It can be based on analysis of personal info, medications list, terms, locations and combinations of them
Any Medical program can have separate block of branching logic configured at medical program settings by NHS administrator
Сompatibility is checked only for programs which are available in payload (array)
Successful invocation of the method returns decision for each program if it is valid or not to create Medication Request with submitted combination of parameters in the payload. If program status is invalid, the reason must be saved and returned in response.
Logic
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
ATTRIBUTES - see on Apiary
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | -- | -- | -- | -- | -- |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Request data validation
Authorize
Verify the validity of access token
in case of error - return 401 (“Invalid access token”) in case of validation fails
Verify that token is not expired
in case of error - return 401 (“Invalid access token”)
Check user scopes in order to perform this action (scope = 'medication_request_request:write')
return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_request_request:write”) in case of invalid scope(s)
Validate container_dosage field
$.container_dosage - volume of a medication’s primary container, which is requested by a doctor or issuer of a medication request, to be dispensed to patient.
Validate $.container_dosage field by schemata
$.container_dosage.code and $.container_dosage.value should be both filled
in case of error return 422 error ("required property %{property} was not present")
$.container_dosage.system should be “MEDICATION_UNIT”
in case of error return 422 error ("value is not allowed in enum")
if $.container_dosage is filled then $.container_dosage.unit should be checked with the MEDICATION_UNIT dictionary by $.container_dosage.code as a key.in case of error return 422 error ("value is not allowed in enum")
Check if there is at list one record of Brand with requested primary container volume
a. if not exist - return 404 error (message: "Not found any appropriate medication with such container parameters")
Validate priority
Check by schemata if $.priority is filled with the value of MEDICATION_REQUEST_PRIORITY dictionary
in case of error return 422 error ("value is not allowed in enum")
Validate prior_prescription
Check that $.prior_prescription is UUID, exists and belongs to this person:
is_active = true, and the same person.
in case of error - return 422 (message: "Prior prescription is not found")
Validate medication request type
Only medication request with type (intent) order can be qualified.
Check medication request intent is order
in case intent == plan - return 409, "Plan can't be qualified"
Validate division
Validate it is exists and active, relates to current legal entity (client_id from token)
in case of error - return 422 error “Only employee of active divisions can create medication request!“
Validate dates:
Check ended_at >= started_at
in case of error - return 422 error “Ended date must be >= Started date!“
Validate started_at >= created_at, but not greater than (created_at + MEDICATION_REQUEST_REQUEST_EXTENDED_LIMIT_STARTED_AT_DAYS)
if invalid - return 422 error (message: "The start date should be equal to or greater than the creation date, but the difference between them should be not exceed {{MEDICATION_REQUEST_REQUEST_EXTENDED_LIMIT_STARTED_AT_DAYS}} day(s).")
Validate started_at >= current_date()if invalid - return 422 error (message: "Started date must be >= current date!")
Check created_at >= (current date - MEDICATION_REQUEST_REQUEST_DELAY_INPUT)
in case of error - return 422 “Create date must be >= Current date - MRR delay input!”
Validate dosage instructions
Validate each item as described at Create Medication Request Request: Validate dosage instruction
Validate compliance for programs
Some checks (below in the text) must be passed for the programs
...
is exists
in case of error - return status = INVALID and reject reason = “Medical program not found”
is_active = true
in case of error - return status = INVALID and reject reason = “Medical program is not active”
1. Check INNM complience for the programs
There is a list of medications (medications.type = BRAND OR medications.type = INNM_DOSAGE) which can be used for the program. It must be check whether there is at least one available medication (with `medication_request_allowed` == TRUE) for the Innm for the particular program
...
Check if there is at list one record of Brand with requested primary container volume in case when found medications is not medications.type = INNM_DOSAGE:
a. if not exist - return 404 error (message: "Not found any appropriate medication with such container parameters")
...
Check max allowed quantity for the treatment period. If there in a list of medications is at list one record with medications.type = INNM_DOSAGE do p.4.2 and skip p.4.1
4.1. in case when found medications is medications.type = BRAND:
Get non-null max_daily_dosage from all filtered above program medications
Define max value among max_daily_dosage as highest_max_daily_dosage
Get package_min_qty from all related brands, connected to found program medications
Define min value among package_min_qty as lowest_package_min_qty
...
i. in case of error - return 422 “The amount of medications in medication request is not complying with max_daily_dosage and treatment period limit”.
4.2. in case when found medications is medications.type = INNM_DOSAGE:
Get non-null max_daily_dosage from all filtered above program medications
Define max value among max_daily_dosage as highest_max_daily_dosage
a. Validate: ((highest_max_daily_dosage × (ended_at - started_at+1)) - medication_qty) >= 0
i. in case of error - return 422 “The amount of medications in medication request is not complying with max_daily_dosage and treatment period limit”
Check compliance of medication quantity in case when found medications is not medications.type = INNM_DOSAGE: remainder of the division (medication_qty/package_min_qty) is equal to 0
a. in case it is not equal to zero - return 422 “The amount of medications in medication request must be divisible to package minimum quantity“
2. Check absence the same medications for the programs
It can be only 1 Medication request (ACTIVE, COMPLETED) per one innm for the one patient at defined period of time.
...
if found and medical program setting
skip_mnn_in_treatment_periodskip_treatment_period= false (absent):add to response: status = INVALID
add to response: rejection_reason = "It can be only 1 active / completed medication request request or medication request per one innm for the same patient at the same period of time!"
Fetch Medication Request by $
...
if (ended_at - started_at + 1) >= MEDICATION_REQUEST_REQUEST_STANDARD_DURATION chart param then
created_at from prequalify request should be greater then (ended at - MEDICATION_REQUEST_MAX_RENEW_DAY) of the found MRin case of error return 422 error ('It's to early to create new medication request for such innm_dosage and medical_program_id')
if (ended_at - started_at + 1) < MEDICATION_REQUEST_REQUEST_STANDARD_DURATION chart param then
created_at from prequalify request should be greater then (ended at - MEDICATION_REQUEST_MIN_RENEW_DAY) of the found MRin case of error return 422 error ('It's to early to create new medication request for such innm_dosage and medical_program_id')
3. Check that care plan is mandatory for programs
It is need to check if the medication request with a program need a care plan (with setting `care_plan_required` == TRUE) for a this program.
...
b. add to response: rejection_reason = "Medical program from activity should be equal to medical program from request"
4. Check diagnosis comply with programs
It is needed to check if medication request with a program needed a context (encounter) with a specified diagnosis.
If program has CONDITIONS_ICD10_AM_ALLOWED parameter in medical_program_settings:
Check if primary diagnosis from the encounter in context has code from eHealth/ICD10_AM/condition_codes dictionary
Check diagnosis code in CONDITIONS_ICD10_AM_ALLOWED
in case of error - return 200 with status = INVALID and rejection_reason = “Encounter in context has no primary diagnosis allowed for the medical program“
If program has CONDITIONS_ICPC2_ALLOWED parameter in medical_program_settings:
Check if primary diagnosis from the encounter in context has code from eHealth/ICPC2/condition_codes dictionary
Check diagnosis code in CONDITIONS_ICPC2_ALLOWED
in case of error - return 200 with status = INVALID and rejection_reason = “Encounter in context has no primary diagnosis allowed for the medical program“
5. Check employee
It is needed to check if medication request with a program allowed to create for specified employee.
Validate employee_id as described on Create Medication request Request. Except on Prequalify method a declaration has not checked for the employee.
6. Check Care plan and Activity
It is needed to check if medication request with a program allowed to be created for specified care plan and activity.
Validare based_on as described on Create Medication request Request.
7. Check period
It is needed to check if medication request period does not exceed allowed maximum of days.
If medication request has program with
MEDICATION_REQUEST_MAX_PERIOD_DAYrequest_max_period_day in medical program setting:Check that medication request period (ended_at - started_at + 1) less than or equal to medical program setting
MEDICATION_REQUEST_MAX_PERIOD_DAYrequest_max_period_dayparameterin case of error - return 200 with status = INVALID and rejection_reason = “Period length exceeds allowed value for the medical program“
If medication request has program without
MEDICATION_REQUEST_MAX_PERIOD_DAYrequest_max_period_dayin medical program setting:Check that medication request period (ended_at - started_at + 1) less than or equal to
MEDICATION_REQUEST_MAX_PERIOD_DAYrequest_max_period_day parameter from chartsin case of error - return 200 with status = INVALID and rejection_reason = “Period length exceeds default maximum value“lt maximum value“
8. Check context
Validate "context" is an active (not entered-in-error) entity from corresponding dictionary, that belongs to the current patient
Validate there is an entity in collection $.data.context.identifier.type.coding[0].code with id == $.data.context.identifier.value that belongs to the current patient
in case of error - return 200 with status = INVALID and rejection_reason = “Entity not found“
encounter diagnosis is not empty in $.encounter.diagnosis
in case of error return 422 ("Encounter without diagnosis can not be referenced")
Validate context.identifier.type.coding[0].code = encounter
in case of error return 422 ("value is not allowed in enum")
encounter diagnosis is not empty in $.encounter.diagnosis
in case of error return 422 ("Encounter without diagnosis can not be referenced")
9. Check person
It is needed to check if person has allowed verification status to get medication.
Validate person's verification status as described on Create Medication request Request
10. Check declaration for a program
It is needed to check specified params for each medical program.
Declaration should always be validated for each program. Validate skip_medication_request_employee_declaration_verify skip_request_employee_declaration_verify and skip_medication_request_legal_entity_declaration_verify skip_request_legal_entity_declaration_verify parameters at medical program settings as described at Create Medication request Request if there are some exclusions.
11. Check provision for a programs
It is needed to check if medical program can be provided by pharmacies.
If the medical program has no setting skip_contract_provision_verify or it is equal to false/null:
If medical program has funding_source = LOCAL:
Check there is exists any active medical program provision with msp_legal_entity_id equal to employee's legal entity
in case of error - return 200 with status = INVALID and rejection_reason = "Medical program is not provided for legal entity specified in the medication request"
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Collect array for all programs in payload with status for each (VALID or INVALID) and rejection_reason.
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | Encounter in context has no primary diagnosis allowed for the medical program | У контексті обрано посилання на взаємодію без первинного діагнозу, що визначений для обраної програми відшкодування | ||
| 3 | 200 | Period length exceeds allowed value for the medical program | Вказана тривалість курсу лікування перевищує допустиму в рамках обраної програми відшкодування | ||
| 4 | 200 | Period length exceeds default maximum value | Тривалість періоду перевищує максимальне значення, що визначене системою | ||
| 5 | 200 | Entity not found | Сутність не знайдено | ||
| 6 | 200 | Medical program is not provided for legal entity specified in the medication request | Створення рецепту за обраною програмою не дозволене для вашого закладу | ||
| 7 | 401 | Invalid access token | Недійсний токен доступу | ||
| 8 | 403 | Your scope does not allow to access this resource. Missing allowances: medication_request_request:write | Для вашої ролі відсутній доступ до цього ресурсу. Необхідний доступ на редагування заявки на електронний рецепт | ||
| 9 | 404 | Not found any appropriate medication with such container parameters | Не знайдено жодного лікарського засобу з такими параметрами первинної упаковки | ||
| 10 | 404 | Not found any appropriate medication complying with max_request_dosage limit | Не знайдено жодного лікарського засобу, який би відповідав обмеженню максимального дозування {{max_request_dosage}} | ||
| 11 | 409 | Plan can't be qualified | План лікування не може бути перевіреним на відповідність програмі реімбурсації | ||
| 12 | Специфічні | ||||
| 13 | 422 | required property %{property} was not present | Обов'язкові поля %{property} не вказані | ||
| 14 | 422 | value is not allowed in enum | Недопустиме значення | ||
| 15 | 422 | Prior prescription is not found | Первинний рецепт не знайдено | ||
| 16 | 422 | Only employee of active divisions can create medication request! | Лише працівник активного підрозділу може створити заявку на рецепт | ||
| 17 | 422 | Ended date must be >= Started date! | Дата закінчення курсу лікування має дорівнювати чи бути пізніше дати початку курсу лікування | ||
| 18 | 422 | The start date should be equal to or greater than the creation date, but the difference between them should be not exceed {{MEDICATION_REQUEST_REQUEST_EXTENDED_LIMIT_STARTED_AT_DAYS}} day(s) | Дата початку повинна бути такою ж або пізнішою за дату створення, але різниця між ними не повинна перевищувати {{MEDICATION_REQUEST_REQUEST_EXTENDED_LIMIT_STARTED_AT_DAYS}} день(днів). | ||
| 19 | 422 | Create date must be >= Current date - MRR delay input! | Дата створення повинна бути >= Поточна дата - 3 доби | ||
| 20 | Medical program not found | Програма реімбурсації не знайдена | |||
| 21 | Medical program is not active | Програма реімбурсації не активна | |||
| 22 | Innm not on the list of approved innms for program {program_name} | Лікарський засіб відсутній у програмі реімбурсації #{program.name} | |||
| 23 | 422 | The amount of medications in medication request is greater than available maximum for the max_daily_dosage and treatment period limit | Перевищено максимально допустиму кількість лікарського засобу, що дозволена до виписування в одному електронному рецепті | ||
| 24 | 422 | The amount of medications in medication request is not complying with max_daily_dosage and treatment period limit | Перевищено максимально допустиму кількість лікарського засобу за кількістю лікарського засобу на добу, що дозволена до виписування в одному електронному рецепті. Максимально допустиме дозування на добу для вказаного періоду лікування становить Х [одиниці виміру]. Х [одиниці виміру] - значення, розраховані МІС відповідно до валідації Системи | ||
| 25 | 422 | The amount of medications in medication request must be divisible to package minimum quantity | Кількість лікарського засобу у заявці на рецепт повинна бути кратна мінімально неподільній кількості лікарського засобу в упаковці | ||
| 26 | It can be only 1 active / completed medication request request or medication request per one innm for the same patient at the same period of time! | Може бути лише 1 активний / погашений електронний рецепт або запит на створення електронного рецепту на одну МНН в один і той же час | |||
| 27 | 422 | It's to early to create new medication request for such innm_dosage and medical_program_id | Створення нового електронного рецепта для дозування МНН за обраною програмою відшкодування є передчасним | ||
| 28 | Medical program from activity should be equal to medical program from request | Програма відшкодування у заявці на рецепт повинна бути такою ж як і в призначенні на лікарський засіб | |||
| 29 | 422 | Encounter without diagnosis can not be referenced | Не можна посилатися на взаємодію без діагнозу | ||
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 | ||||
|---|---|---|---|---|
|
...