Table of Contents |
---|
Ціль
Даний веб-сервіс розроблений для створення запиту на рецепт
...
Purpose
This WS is designed to create Request for Medication request
There are two types of medication request:
plan - Запит відображає намір на формування мед. препаратів без необхідності підтвердження дії. Рецепт з типом план не може бути відпущений та тільки надає інструкцію для адміністрування мед препаратів - The request represents an intention to ensure something occurs without providing an authorization for others to act. Medication request with type plan can't be dispensed and only provide the instruction to administer the medicine.
order - Запит відображає намір запиту/вимоги авторизації на дію. Рецепт з типом запит може бути відпущений
Специфікація
Основні положення
Тільки автентифіковані та авторизовані користувачі з відповідним скоупом може створити запит на рецепт (MRR)
Пацієнт повинен зберігатися в захешованому виді у відповідності до вимог безпеки.
Авторизація
...
Перевірити валідність токену доступу
в разі помилки - повернути 401 (“Invalid access token”) в разі невалідних валідацій
Перевірити, що токен дійсний
...
- The request represents a request/demand and authorization for action. Medication request with type order can be dispensed
Specification
Key points
Only authenticated and authorized users with appropriate scope can Create Medication Request Request (MRR)
Patient should be stored in hashed form according to security requirements.
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') на можливість виконання даної дії
в разі помилки - надіслати у відповіді код 401
Якщо BLOCK
return 403 (“Your scope does not allow to access this resource. Missing allowances: medication_request_request:write”) in case of invalid scope(s)
If BLOCK_UNVERIFIED_PARTY_USERS є true, тоді перевірити дані співробітника на свіпадіння наступним умовамis true, then check party's data match following condition: verification_status != NOT_VERIFIED або or (verification_status = NOT_VERIFIED та and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):
в разі неспівпадіння - повернути in case not match - return 403 ("Access denied. Party is not verified")
...
Validations
...
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 повинні бути заповнені
в разі помилки повернути 422should be both filled
in case of error return 422 error ("required property %{property} was not present")
$.container_dosage.system повинен бути should be “MEDICATION_UNIT”
в разі помилки повернути 422 in case of error return 422 error ("value is not allowed in enum")
Перевірити пріорітет
...
Validate priority
Check by schemata if $.priority is filled with the value of MEDICATION_REQUEST_PRIORITY
в разі помилки повернути 422dictionary
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")
Перевірити співробітника
Ціль валідації: Перевірити співробітника на можливість створення рецепту.
...
Отримати employee_id з запиту
Перевірити співробітника
На існування
...
Validate employee
Validation of an employee for the possibility of creating a medication request.
Invoke employee_id from request
Validate employee
Validate that exists
in case invalid return 422 error with msg ("Employee not found")
Перевірити, що Validate that $.employees.status == APPROVED
в разі помилки повернути код 409 з повідомленням in case invalid return 409 error with msg ("Employee is not active")
Перевірити, що Validate that $.employees.legal_entity_id == client_id from token
в разі помилки повернути код 422 з повідомленням in case invalid return 422 error with msg ("Employee does not belong to legal entity from token")
якщо If medical _program_id є в запиті перевірити medicalprogram is present and has medical_program_settings .with skip_employee_validation == false (або відсутняor absent), то перевірити then validate <employee_type>:
перевірити, щоvalidate if employee_type
is present in medical_program_settings.employee_types_for_create_medication_request
variable
in case invalid return 422 error with msg ("Employee type can't create medication request with medical program from request")
in case employee_type = DOCTOR
if variable skip_medication_request_employee_declaration_verify
= false
or null/absent
then:
get $.declarations
by employee_id, person_id, status=ACTIVE
if not found - return 422 error "Only doctors with an active declaration with the patient can create medication request with medical program from request!"
в іншому випадку пропустити верифікацію декларації на рівні співробітника (якщо true)
else skip declaration verification on employee level (if true)
if variable skip_medication_request_legal_entity_declaration_verify = false
or null/absent
then: get $.declarations
by employee's legal_entity_id, person_id, status=ACTIVE
якщо обидва true - пропустити верифікацію декларації взагалі
в разі if not found - return 422 error "Only legal entity with an active declaration with the patient can create medication request with medical program from request!"
в іншому випадку пропустити верифікацію декларації на рівні співробітника (якщо true)
else skip declaration verification on legal entity level (if true)
else if both are true - skip declaration verification at all
in case employee_type = SPECIALIST
get $.employees.speciality.speciality(speciality_officio == true)
validate that speciality present in $.medical_programs.medical_program_setting.speciality_types_allowed
variable
in case invalid return 422 error with msg ("Employee's specialty doesn't allow create medication request with medical program from request")
in case employee_type = MED_COORDINATOR
skip validation that speciality present in $.medical_programs.medical_program_setting.speciality_types_allowed
variable
If medical program has medical_program_settings with medical_program_settings.skip_employee_validation == true або відсутня true or there is no medical_program_id в запиті, будь-який користувач, який має скоуп може створити запит на рецепт
Перевірити підрозділ
Ціль валідації: Перевірити підрозділ на можливість створення рецепту.
- Отримати
in the request, any user who has a scope can create medication request
Validate division
Validation of the division for the possibility of creating a medication request.
Invoke Get division details
Перевірити divisionValidate division_id - division_id існує
в разі помилки направити код 422 з повідомленнямexists
in case invalid return 422 error with msg ("Division not found")
Перевірити Validate Response $.data.status==ACTIVE
якщо не знайдено - повернути код 422 (повідомленняif not found - return 422 error (message: "Only employee of active divisions can create medication request!")
Підрозділ повинен бути активним або посилатися на поточну Division should be active and refers to current legal_entity
is_active = true
status = 'ACTIVE'
division.legal_entity_id = client_id (context)
Перевірити юридичну особу
Ціль перевірки: Перевірити юридичну особу на можливість створенна рецепту.
...
Отримати client_id з токену
...
Validate legal entity
Validation of the legal entity for the possibility of creating a medication request.
Get client_id from token
Validate client_id=legal_entity_id
перевірити, що юридична особа існує
в разі помилки повернути код 422 з повідомленнямcheck that legal_entity exist
in case invalid return 422 error with msg (422 Legal entity not found)
перевірити, що check that legal_entities.status == ACTIVE
в разі помилки повернути код 422 з повідомленням in case invalid return 422 error with msg ("Only active legal entity can provide medication request")
перевірити тип юридичної особи згідно з чарт параметрами check legal entity type in chart parameter MEDICATION_REQUEST_REQUEST_LEGAL_ENTITY_TYPES
в разі помилки повернути код 409 з повідомленням in case invalid return 409 error with msg (“Invalid legal entity type“)
Перевірити персону
Ціль перевірки: Перевірити персону на можливість створення рецепту.
Отримати Get patient by ID
Перевірити, що person_id - mpi_id існують
в разі помилки повернути код 422 (422 Person not found)
Зберегти перемінні параметри з: $.data.authentication_methods
Перевірити відповідь $.data.is_active==TRUE
якщо не знайдено - повернути помилку з кодом 422 (повідомлення: "Only for active MPI record can be created medication request!")
Первірити статус верифікації персони:
Якщо MRR має based_on з валідною активністю, пропустити перевірку.
В іншому випадку перевірити, що verification_status не рівний NOT_VERIFIED.
в разі NOT_VERIFIED - повернути помилку 409, "Patient is not verified"
Перевірити дати
created_at - схожа з датою погодженя FHIR -> Актуальній даті створення рецепту
inserted_at - дата, коли рецепт був створений в E-Health
started_at/ended_at - Період лікування. Не може бути меньше ніж дата закінчення MR. Визначається лікарем.
dispence_valid_from - Використовується для перевірки відпуску. Аналогічно для дат створення.
dispense_valid_to - Вказує на дату закінчення строку відпуску. Якщо MR має вказані налаштування по програмі з заповненим параметром medication_dispense_period_day, то dispence_valid_from + medication_dispense_period_day, в іншому випадку відпуск валідний з + medication_dispense_period значення глобального параметру.
Ціль валідації: Повинна бути: ended_at >= started_at >= created_at
Перевірити, що created_at, started_at, ended_at в форматі дати
в разі помилки повернути код 422 в повідомленні ("expected \"%{actual}\" to be a valid ISO 8601 date")
Перевірити ended_at >= started_at
якщо помилка - повернути код 422 (повідомлення: "Ended date must be >= Started date!")
Перевірити started_at` >= created_at
якщо помилка - повернути код 422 (повідомлення: "Started date must be >= Created date!")
Перевірити started_at >= current_date()
якщо помилка - повернути код 422 (повідомлення: "Started date must be >= current date!")
Перевірити created_at >= current_date() - mrr_delay_input
якщо помилка - повернути код 422 (повідомлення: "Create date must be = current date!")
Перевірити started_at у відповідності до частоти отримання препаратів
отримати $.medical_programs.medical_program_setting по medical_program_id з запиту
перевірити параметр skip_mnn_in_treatment_period
в разі skip
Validate person
Validation of person for the possibility of creating a medication request.
Invoke validation described at PreQualify Medication Request: Check person
Validate dates
created_at - similar to assertion date in FHIR -> Actual date medication request being created
inserted_at - date when Medication request was registered in E-Health
started_at/ended_at - Treatment period. Cannot be less than MR expiration period. Defined by doctor.
dispense_valid_from - Used for dispense validation. As for now equals Created at.
dispense_valid_to - Implements dispense expiration period. If MR has medical program setting with not empty parameter medication_dispense_period_day, then dispense_valid_from + medication_dispense_period_day, else Dispense valid from + medication_dispense_period global parameter value.
Purpose validation: Must be: ended_at >= started_at >= created_at
Validate that created_at, started_at, ended_at in date format
in case invalid return 422 with msg ("expected \"%{actual}\" to be a valid ISO 8601 date")
Validate ended_at >= started_at
if invalid - return 422 error (message: "The end date should be equal to or greater than the start 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 beetwen 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!")
Validate created_at >= current_date() - MEDICATION_REQUEST_REQUEST_DELAY_INPUT chart param
if invalid - return 422 error (message: "Create date must be >= Current date - MRR delay input!")
Validate started_at regarding frequency of receiving drugs
get $.medical_programs.medical_program_setting by medical_program_id from request
отриматиvalidate skip_mnn_in_treatment_period variable
in case skip_mnn_in_treatment_period == FALSE (or absent)
перевірити запит на відповідністьvalidate request according to logic: PreQualify Medication request#2.Checkabsencethesamemedicationsfortheprograms
in case skip_mnn_in_treatment_period == TRUE
пропустити перевірку періодичності отримання препаратів
Перевірити created_at у відповідності до періодичності отримання препаратів
skip validating frequency of receiving drugs
Validate created_at regarding frequency of receiving drugs
get $.medical_programs.medical_program_setting по by medical_program_id з запиту
перевірити параметр skipfrom request
validate skip_mnn_in_treatment_period
в разі skipperiod variable
in case skip_mnn_in_treatment_period == FALSE (або відсутня)
перевірити запит у відповідності до логікиor absent)
validate request according to logic: PreQualify Medication request#2.Checkabsencethesamemedicationsfortheprograms
in case skip_mnn_in_treatment_period == TRUE
пропустити перевірку періодичності отримання препаратів
skip validating frequency of receiving drugs
Validate period length (ended_at - started_at):
Якщо медична программа була вказана:
перевірити запит на відповідність логікиIf medical program has been submitted:
validate request according to logic: PreQualify Medication request: 7. Validate period
в іншому випадку:
Перевірити, що період рецепту меньше або дорівнює MEDICATIONelse:
Check that medication request period less than or equal to MEDICATION_REQUEST_MAX_PERIOD_DAY параментру з чартів
в разі помилки - повернути кодparameter from charts
in case of error - return 409 “Period length exceeds default maximum value“
Перевірити препарат
...
Validate medication
Check FK, status `is_active`=TRUE, type = INNM_DOSAGE
Отримати Invoke Get INNM Dosage by ID
Перевірити, що medicationValidate medication_id - medication_id існує
в разі помилки повернути кодexists
in case of error return 422 ("Medication not found")
Перевірити код відповіді Validate Response code == 200
в разі помилки - повернути код 422 (повідомленняif invalid - return 422 error (message: "Only medication with type `INNM_DOSAGE` can be use for created medication request!")\
Перевірити відповідь $Validate Response $.is_active==TRUE
якщо не знайдено - повернути код 422 (повідомленняif not found - return 422 error (message: "Only active innm_dosage can dosage can be use for created medication request!")
Перевірити контекст
...
Validate context
Validate "context" в запиті
у разу помилки повернути код 422 “requiredis present in the request
in case of error return 422 ("required property context was not present“present")
Перевірити Validate "context" це активна сутність (не is an active (not entered-in-error) з відповідного довідника, який належить поточному пацієнту
Перевіритиencounter, that belongs to the current patient
Validate context.identifier.type.coding[0].code = encounter
в разі помилки повернути код in case of error return 422 ("value is not allowed in enum")
Перевірити на наявність в колекції сутності 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 422 "Entity not found"
Перевірити, що сутність не в статусі Validate that entity is not in status "entered-in-error"
в разі помилки повернути код in case of error 422 "Entity in status "entered-in-error" can not be referenced"
Діагнози взаємодії заповнені в encounter diagnosis is not empty in $.encounter.diagnosis
в разі помилки повернути код in case of error return 422 ("Encounter without diagnosis can not be referenced")
Перевірити інструкцію дозування
Кожний не порожній атрибут повинен бути валідним та посилатися на відповідний довідник або об'єкт
Послідовність повинна бути унікальна включаючи масив інстркцій дозування
в разі помилки повернути код (422, "Sequence must be unique")
Додаткова інструкція повинна посилатися на валідний довідник
$.dosage_instruction[*].additional_instruction.coding[*].system == "eHealth/SNOMED/additional_dosage_instructions"
$.dosage_instruction[*].additional_instruction.coding[*].code це валідне значення в довіднику "eHealth/SNOMED/additional_dosage_instructions"
в разі помилки повернути код 409 "Incorrect additional instruction"
Місце має посилатися на валдіний довідник
$.dosage_instruction[*].site.coding[*].system == "eHealth/SNOMED/anatomical_structure_administration_site_codes"
$.dosage_instruction[*].site.coding[*].code це валідне місце в довіднику "eHealth/SNOMED/anatomical_structure_administration_site_codes"
в разі помилки повернути код 409 "Incorrect site"
Шлях повинен посилатися на валідний довідник
$.dosage_instruction[*].route.coding[*].system == "eHealth/SNOMED/route_codes"
$.dosage_instruction[*].route.coding[*].code це валідне місце в довіднику "eHealth/SNOMED/route_codes"
в разі помилки повернути код 409 "Incorrect route"
Метод повинен посилатися на валідний довідник
$.dosage_instruction[*].method.coding[*].system == "eHealth/SNOMED/administration_methods"
$.dosage_instruction[*].method.coding[*].code це валідне місце в довіднику "eHealth/SNOMED/administration_methods"
в разі помилки повернути код 409 "Incorrect method"
Дозування та тип дозування повинні посилатися на валідний довідник
$.dosage_instruction[*].dose_and_rate.type.coding[*].system == "eHealth/SNOMED/dose_and_rate"
$.dosage_instruction[*].dose_and_rate.type.coding[*].code це валідне місце в довіднику "eHealth/SNOMED/dose_and_rate"
в разі помилки повернути код 409 "Incorrect dose and rate type"
Перевірити based_on
Якщо вказано, перевірити, що поле є масивом з двома значеннями типу Reference: одна - це валідний ресурс плану лікування, інший - ресурс активності.
Перевірити План лікування:
Від повинен належати тій же персоні, що і набір в MRR
в разі помилки повернути код 422 з повідомленням ("Care plan not found")
Від повинен бути в статусі active
Перевірити вказану активність:
Вона відповідає Плану лікування.
в разі помилки повернути код 422 з повідомленням ("Activity not found")
Вона має activity.detail.kind=medication_request; activity.detail.product_reference=medication_id.
в разі помилки повернути код 422 з повідомленням ("Invalid activity kind")
Вона має статус scheduled, in_progress
Якщо вона має quantity порахувати remaining quantity:
вибрати всі MRR в статусі NEW які створені на основі даної активності
вибрати всі MR в статусах ACTIVE, COMPLETED які створені на основі даної активності
порахувати зарезервовану на сьогодні кількість, як суму medication_qty у профільтрованому MRR та MR списку, включаючи medication_qty з поточного MRR
порахувати вказану кількість шляхом віднімання зарезервованої кількості з кількості активностей
Перевірити remaining quantity більше або дорівнює 0
в разі помилки повернути код 409 "The total amount of the prescribed medication quantity exceeds quantity in care plan activity"
перевірити, що medical_program_id дорівнює $.activity[].program
в разі помилки повернути код 422 з повідомленням ("Medical program from activity should be equal to medical program from request")
Перевірити started_at/ended_at для запиту рецепту:
Якщо активність плану лікування має detail.scheduled_timing.repeat.bounds_period - перевірити started_at/ended_at включаючи bounds_period
Якщо план активності має detail.scheduled_period - перевірити started_at/ended_at включаючи scheduled_period
в іншому випадку - перевірити started_at/ended_at у межах care_plan.period
у випадку якщо started_at/ended_at не в межах care_plan.period повернути код 422 з повідомленням ("Invalid care plan period")
Перевірити медичну програму
Перевірити наявність medical_program_id в реквесті
у разі помилки повернути код 422 (“required property medical_program_id was not present“)
Перевірити, що medical_program_id - medical_program_id існує
в разі помилки повернути код 422 ("Medical program not found")
Перевірити параметри medical_programs.medical_program_setting
перевірити, що care_plan_required == true тоді запит повинен містити based_on на план лікування і активність, що містять ту ж програму
в разі помилки повернути код 422 з повідомленням ("Care plan and activity with the same medical program should be present in request")
Якщо вказано параметр CONDITIONS_ICD10_AM_ALLOWED, то:
Перевірити що первинні діагнози зі взаємодії в контексті має код з довідника eHealth/ICD10_AM/condition_codes
Перевірити, що код діагнозу з CONDITIONS_ICD10_AM_ALLOWED
в разі помилки - повернути 422 “Encounter in context has no primary diagnosis allowed for the medical program“
Якщо вказано параметр CONDITIONS_ICPC2_ALLOWED, то:
Перевірити що первинні діагнози зі взаємодії в контексті має код з довідника eHealth/ICPC2/condition_codes
Перевірити, що код діагнозу з CONDITIONS_ICPC2_ALLOWED
в разі помилки - повернути 422 “Encounter in context has no primary diagnosis allowed for the medical program“
Якщо програма має funding_source = LOCAL , викликати валідації як описано для https://e-health-ua.atlassian.net/wiki/spaces/EPRx/pages/16981065737/PreQualify+Medication+request+request+modified+EN#11.-Check-provision-for-a-programs
Перевірити множинність & дозвіл на рецепт для участика
...
Виконати перевірки як описано для https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583405343/PreQualify+Medication+request+EN#1.-Check-INNM-complience-for-the-programs.
...
Validate dosage instruction
Each non-empty attribute must be valid and reference to appropriate dictionary or object
Invoke validation described at Preqalify Medication Request: Validate dosage instructions
Validate based_on
If submitted, invoke validation described at PreQalify Medication Request: Check Care Plan and Activity
Validate medical program
Validate medical_program_id is present in the request
in case of error return 422 ("required property medical_program_id was not present")
Validate medical_program_id - medical_program_id exists
in case of error return 422 ("Medical program not found")
Validate medical_programs.medical_program_setting parameters
check if care_plan_required == true then the request should contain a based_on with care plan and activity that contains the same medical program
in case of error return 422 with msg ("Care plan and activity with the same medical program should be present in request")
If there is conditions_icd10_am_allowed parameter, then:
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 422 “Encounter in context has no primary diagnosis allowed for the medical program“
If there is conditions_icpc2_allowed parameter, then:
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 422 “Encounter in context has no primary diagnosis allowed for the medical program“
If medical program has funding_source = LOCAL , then invoke validation described at https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583405343/PreQualify+Medication+Request+Request#11.-Check-provision-for-a-programs
Validate multiplicity & medication request allowed for participants
Perform validation as described at PreQalify Medication Request: Check INNM complience for the programs. If MRR has no program, then following script used in this validation to define list of medications (BRANDs):
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Perform validation as described at
PreQalify Medication Request: Check absence the same medications for the programs.
Сервісна логіка
...
Service Logic
Generate number & verification_code
...
for Medication request
Generate human readable number for receipt (See specs)
Code Block Structure number XXXX-1234-5678-9012-345-C , where: - XXXX - series: numbers + only some letters (A, E, H, K, M, P, T, X) - 1234-5678-9012-345 - randomly generated numbers - C - checksum: Should be calculated using the Damn algorithm or Verhoeff algorithm After new Request number was generated we should check that it is unique in the DB (entity: medication_request + medication_request_request
Згенерувати verificationGenerate verification_code для for MPI.person_authentication_methods == OTP або or OFFLINE
Code Block Structure code 1234, where: - 1234 - randomly generated numbers
Створити запит на рецепт
- встановити
Create Medication request Request
set:
dispense_valid_from = created_at
dispensed_valid_to = dispensed_valid_from + dispense_period
Заповнити структуру Fill 'data' для відповіді & зберегти в ILstructure for Response & save in IL.medication_request_requests
якщо взаємодія наявна в контексті запита на основі якого створений рецепт - заповнити If encounter is present in the request context then based on it - fill the IL.medication_request_requests.context_episode_id
Заповнити окремоFill separately
data_employee_id,
data_intent,
data_based_on_care_plan_id,
data_based_on_activity_id,
data_context_id,
data_patient_id,
data_legal_entity_id
Згенерувати контекст для відповіді
Згенерувати структуру даних з структури відповіді WS
...
Generate content for response
Generate data structure with Responce WS structure
Set IL.medication_request_requests даної структури
requests this structure
in case if response is VALID enrich response with urgent_data:
отримати get authetification_method по by person_id та повернути замаскований номер (а разі будь якогоand return masked number (in case if any)
Code Block | ||
---|---|---|
| ||
"urgent": { "authentication_method_current": { "type": "OTP", "number": "+38093*****85" } } |
...