Create full medication registry_UA

1 Ціль
2 Основні положення
3 Специфікація
4 Авторизація
5 Перевірити запит
6 Сервісна логіка
- 6.1 innms
- 6.2 medications (type = INNM_DOSAGE)
- 6.3 ingredients (for INNM_DOSAGE)
- 6.4 medications (type = BRAND)
- 6.5 ingredients (for BRAND)
- 6.6 program_medications

Ціль

Сервіс розроблено для закантаження нового медичного реєстру. Процес використовує сервіси jabba. По факту виконання запиту, створюється job, на основі якої створюються задачі. Кожна задача це один запит на створення сутності з реєстру.

Основні положення

Адміністратор НСЗУ завантажує файл з полями відповідно до структури.
Файл повинен бути в форматі .csv.

Специфікація

  "Creates a single `MedicationRegistry`."
  createMedicationRegistry(
    input: CreateMedicationRegistryInput!
  ): CreateMedicationRegistryPayload

"""
Input for `createMedicationRegistry` mutation.

User must have a scope **medication_registry:write**
"""
input CreateMedicationRegistryInput {
  "Type of register originating medication registry data. The value should be present in the `REGISTER_TYPE` dictionary."
  registerType: String!
  "Create medication registry reason description."
  reasonDescription: String!
  "Input file in csv format with medication register."
  csvData: Upload!    
}

"""
Return type for `createMedicationRegistry` mutation.
"""
type CreateMedicationRegistryPayload {
  "Created `MedicationRegistryJob`."
  medicationRegistryJob: MedicationRegistryJob
}

"""
An object for MedicationRegistryJob.
"""
type MedicationRegistryJob implements Node {
  "The ID of an object"
  id: ID!
  "Primary key identifier from the database"
  databaseId: UUID!
  "Job name."
  name: String
  "Medication registry Job status."
  status: JobStatus!
  "Job execution strategy."
  strategy: JobStrategy!
  "Date and time when the job starts."
  startedAt: DateTime!
  "Date and time when the job ends."
  endedAt: DateTime
  "Tasks within this job."
  tasks(
    "A condition to be used in determining which values should be returned by the collection."
    filter: TaskFilter
    "The method to use when ordering collection items."
    orderBy: TaskOrderBy
    "Read all values in the set after (below) this cursor."
    after: String
    "Read all values in the set before (above) this cursor."
    before: String
    "Only read the first _n_ values of the set."
    first: Int
    "Only read the last _n_ values of the set."
    last: Int
  ): MedicationRegistryTaskConnection!
  "Type of register originating medication registry data. The value should be present in the `REGISTER_TYPE` dictionary."
  registerType: String!
  "Medication registry job reason description."
  reasonDescription: String!
}

"""
A connection to a list of `MedicationRegistryTask` values.
"""
type MedicationRegistryTaskConnection {
  "Information to aid in pagination."
  pageInfo: PageInfo!
  "A list of nodes."
  nodes: [MedicationRegistryTask]
  "A list of edges."
  edges: [MedicationRegistryTaskEdge]
}

"""
Reads and enables pagination through a set of `MedicationRegistryTask`.
"""
type MedicationRegistryTaskEdge {
  "The item at the end of the edge."
  node: MedicationRegistryTask!
  "A cursor for use in pagination."
  cursor: String!
}

"""
A child of a `MedicationRegistryJob`, contains the result of task execution.
"""
type MedicationRegistryTask implements Node {
  "The ID of an object"
  id: ID!
  "Primary key identifier from the database"
  databaseId: UUID!
  "Task name."
  name: String
  "Task status, is set automatically."
  status: TaskStatus!
  "Task meta data."
  meta: MedicationRegistryTaskMeta
  "Date and time when task was executed."
  endedAt: DateTime
  "Task error."
  error: TaskError
  "Technical information when task was inserted into the DB."
  insertedAt: DateTime!
  "Technical information when task was updated in the DB."
  updatedAt: DateTime!
}

"""
Metadata of a `MedicationRegistryTask`.
"""
type MedicationRegistryTaskMeta {
  "Primary key identifier of an entity from the database."
  databaseId: UUID
  "Line number of csv file from input."
  csvDataLine: Int  
}

Авторизація

Перевірити валідність токену доступу
- в разі помилки - повернути 401 (“Invalid access token”) в разі невалідних валідацій
Перевірити, що токен дійсний
- в разі помилки - повернути 401 (“Invalid access token”)
Перевірити скоупи користувача (scope = 'medication_registry:write') на можливість виконання даної дії
- в разі помилки - повернути 403 (“Your scope does not allow to access this resource. Missing allowances: medication_registry:write”)

Перевірити запит

Перевірити запит використовуючи схему
1. Повернути 422 з переліком помилок валідації в разі їх неуспішності.
Перевірити, що registerType = ‘FULL_MEDICATIONS_REGISTRY'
1. Повернути 422 з переліком помилок валідації в разі їх неуспішності.
Перевірити, що reasonDescription заповнено
1. Повернути 422 з переліком помилок валідації в разі їх неуспішності.
Перевірити вхідний файл у відповідності до структури файлу
1. Повернути 422 з переліком помилок валідації в разі їх неуспішності.

Приклад файлу:

*Примітка. Поля innms.sctid, innms.name, innms.name_original, innm_dosage_ingredients.is_primary, innm_dosage_ingredients.dosage.numerator_value, innm_dosage_ingredients.dosage.numerator_unit, innm_dosage_ingredients.dosage.denumerator_value, innm_dosage_ingredients.dosage.denumerator_unit, brand.code_atc can exist as an array. Values повинні розділятися | (відповідно).

Сервісна логіка

Перевірити вхідні дані у відповідності до схеми
Створити job з типом create_medication_registry
Для кожного рядка вхідного файлу створити окрему задачу по job
Когда задача повинна перевіряти існуючі та створені нові сутності медичного реєстру:
1. Отримати лікарські засоби з type = INNM_DOSAGE, is_active = TRUE, innm_dosage.name, innm_dosage.form та innm_dosage.ingredients.dosage, innm_dosage.ingredients.is_primary):
  1. в разі, якщо знайдено отримати пов'язані ЛЗ з type = BRAND, is_active = TRUE, brand.name, brand.form, brand.package_qty, brand.package_min_qty, brand.certificate, brand.container та brand.ingredients.dosage, brand.ingredients.is_primary):
    1. в разі, якщо знайдено отримати пов'язаних учасників програми по medication_id та program_medications.medical_program_id та додати медикаменти бренд у відповідності до Create full medication registry | program_medications якщо не знайдено учасника програми
  2. в разі, якщо innm_dosage не знайдено додати їх у відповідності до Create full medication registry | medications (type = INNM_DOSAGE) та їх інгрідієнтів Create full medication registry | ingredients (for INNM_DOSAGE) , Create full medication registry | innms (пропустити створення innms в разі, якщо існують).
  3. в разі, якщо brand не знайдено додати їх у відповідності до Create full medication registry | medications (type = BRAND) та їх інгрідієнтів Create full medication registry | ingredients (for BRAND) .
    1. додати учасника програми з брендом у відповідності до Create full medication registry | program_medications
  4. в разі, якщо знайдено brand та учасника програми - повернути статус задачі FAILED з помилкою ('Such medication already exist')
Повернути ідентифікатор job зі статусом.

innms

Атрибут	Джерело та логіка	Типи та обмеження	Н/О

Атрибут	Джерело та логіка	Типи та обмеження	Н/О
id	uuid_generate_v4(), auto	uuid	О
sctid	innms.sctid, from request	varchar(255)	Н
name	innms.name, from request	varchar(255)	О
name_original	innms.name_original, from request	varchar(255)	О
is_active	true, auto	bool	О
inserted_by	user_id, from token	uuid	О
updated_by	user_id, from token	uuid	О
inserted_at	now(), auto	timestamp	О
updated_at	now(), auto	timestamp	О

medications (type = INNM_DOSAGE)

Атрибут	Джерело та логіка	Типи та обмеження	Н/О

Атрибут	Джерело та логіка	Типи та обмеження	Н/О
id	uuid_generate_v4(), auto	uuid	О
name	innm_dosage.name	varchar(255)	О
type	auto (INNM_DOSAGE)	varchar(255)	О
is_active	true, auto	bool	О
form	innm_dosage.form	varchar(255) Dictionary MEDICATION_FORM	О
inserted_by	user_id, from token	uuid	О
updated_by	user_id, from token	uuid	О
inserted_at	now(), auto	timestamp	О
updated_at	now(), auto	timestamp	О
daily_dosage	innm_dosage.daily_dosage	float	Н
max_daily_dosage	innm_dosage.max_daily_dosage	float	Н
mr_blank_type	innm_dosage.mr_blank_type	varchar(64) Dictionary MR_BLANK_TYPES	О
dosage_form_is_dosed	innm_dosage.dosage_is_dosed	bool	О

ingredients (for INNM_DOSAGE)

Атрибут		Джерело та логіка	Типи та обмеження		Н/О

Атрибут		Джерело та логіка	Типи та обмеження		Н/О
id		uuid_generate_v4(), auto	uuid		О
dosage	numerator_value	innm_dosage_ingredients.dosage.numerator_value, from request	jsonb	float8	О
	numerator_unit	innm_dosage_ingredients.dosage.numerator_unit, from request		varchar(255) Dictionary MEDICATION_UNIT	О
	denumerator_value	innm_dosage_ingredients.dosage.denumerator_value, from request		float8	О
	denumerator_unit	innm_dosage_ingredients.dosage.denumerator_unit, from request		varchar(255) Dictionary MEDICATION_UNIT	О
is_primary		innm_dosage_ingredients.is_primary, from request	bool At least one of the ingredients must be is_primary = true Two or more ingredients can be is_primary = true		О
innm_child_id		uuid_generate_v4(), auto	uuid innm_id		О
parent_id		uuid_generate_v4(), auto	uuid medication_id (type = INNM_DOSAGE)		О
inserted_at		now(), auto	timestamp		О
updated_at		now(), auto	timestamp		О

medications (type = BRAND)

Атрибут		Джерело та логіка	Типи та обмеження		Н/О

Атрибут		Джерело та логіка	Типи та обмеження		Н/О
id		uuid_generate_v4(), auto	uuid		О
name		brand.name	varchar(255)		О
type		auto (BRAND)	varchar(255)		О
manufacturer	name	brand.manufacturer.name	jsonb	varchar(255)	О
manufacturer	country	brand.manufacturer.country	jsonb	varchar(255) Dictionary COUNTRY	О
code_atc		brand.code_atc	jsonb	varchar(255)	О
is_active		true, auto	bool		О
form		brand.form	varchar(255) Dictionary MEDICATION_FORM		О
container	numerator_value	brand.container.numerator_value	jsonb	float8	О
	numerator_unit	brand.container.numerator_unit		varchar(255) Dictionary MEDICATION_UNIT	О
	denumerator_value	brand.container.denumerator_value		float8	О
	denumerator_unit	brand.container.denumerator_unit		varchar(255) Dictionary MEDICATION_UNIT	О
package_qty		brand.package_qty	float		Н
package_min_qty		brand.package_min_qty	float		Н
certificate		brand.certificate	varchar(255)		Н
certificate_expired_at		brand.certificate_expired_at	date		Н
inserted_by		user_id, from token	uuid		О
updated_by		user_id, from token	uuid		О
inserted_at		now(), auto	timestamp		О
updated_at		now(), auto	timestamp		О
form_pharm		brand.form_pharm	varchar(255)		Н
max_request_dosage		brand.max_request_dosage	int		Н

ingredients (for BRAND)

Атрибут		Джерело та логіка	Типи та обмеження		Н/О

Атрибут		Джерело та логіка	Типи та обмеження		Н/О
id		uuid_generate_v4(), auto	uuid		О
is_primary		brand_ingredients.is_primary, from request	bool Only one ingredient should be is_primary = true		О
dosage	numerator_value	brand_ingredients.dosage.numerator_value, from request	jsonb	float8	О
	numerator_unit	brand_ingredients.dosage.numerator_unit, from request		varchar(255) Dictionary MEDICATION_UNIT	О
	denumerator_value	brand_ingredients.dosage.denumerator_value, from request		float8	О
	denumerator_unit	brand_ingredients.dosage.denumerator_unit, from request		varchar(255) Dictionary MEDICATION_UNIT	О
medication_child_id		uuid_generate_v4(), auto	uuid medication (type = INNM_DOSAGE)		О
parent_id		uuid_generate_v4(), auto	uuid medication_id (type = BRAND)		О
inserted_at		now(), auto	timestamp		О
updated_at		now(), auto	timestamp		О

program_medications

Атрибут		Джерело та логіка	Типи та обмеження	Н/О

Атрибут		Джерело та логіка	Типи та обмеження	Н/О
id		uuid_generate_v4(), auto	uuid	О
reimbursement	type	program_medications.reimbursement.type	varchar(64) Dictionary REIMBURSEMENT_TYPE	О
	reimbursement_amount	program_medications.reimbursement.reimbursement_amount	float	О
	percentage_discount	program_medications.reimbursement.percentage_discount	float	О
is_active		true, auto	bool	О
medication_request_allowed		true, auto	bool	О
care_plan_activity_allowed		true, auto	bool	О
inserted_by		user_id, from token	uuid	О
updated_by		user_id, from token	uuid	О
medication_id		medication_id (type = BRAND), auto	uuid	О
medical_program_id		program_medications.medical_program_id	uuid	О
inserted_at		now(), auto	timestamp	О
updated_at		now(), auto	timestamp	О
wholesale_price		program_medications.wholesale_price	float8	Н
consumer_price		program_medications.consumer_price	float8	Н
reimbursement_daily_dosage		program_medications.reimbursement_daily_dosage	float8	Н
estimated_payment_amount		program_medications.estimated_payment_amount	float8	Н
start_date		program_medications.start_date	date	Н
end_date		program_medications.end_date	date	Н
registry_number		program_medications.registry_number	varchar(255)	Н

Приклад зі значеннями: