Update program medication registry_UA

1 Ціль
2 Специфікація
3 Авторизація
4 Перевірити запит
5 Сервісна логіка

Ціль

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

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

  "Updates a single `MedicationRegistry`."
  updateMedicationRegistry(
    input: UpdateMedicationRegistryInput!
  ): UpdateMedicationRegistryPayload

"""
Input for `updateMedicationRegistry` mutation.

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

"""
Return type for `updateMedicationRegistry` mutation.
"""
type UpdateMedicationRegistryPayload {
  "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 = ‘UPDATE_PROGRAM_MEDICATION_REGISTRY'
1. Повернути 422 з переліком помилок валідації в разі їх неуспішності.
Перевірити, що reasonDescription заповнено
1. Повернути 422 з переліком помилок валідації в разі їх неуспішності.
Перевірити вхідний файл у відповідності до структури файлу
1. Повернути 422 з переліком помилок валідації в разі їх неуспішності.
Перевірити, що ідентифікатори з запиту існують та активні
1. Повернути 404 з переліком помилок валідації в разі їх неуспішності.

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

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

Перевірити вхідні дані у відповідності до схеми
Перевірити існуючі та оновити сутності з реєстру медикаментів:
1. Отримати учасника програми по program_medications.id з файлу та оновити запис з наступними параметрами:

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

Атрибут	Джерело та логіка	Тип та обмеження	Н/О
id	program_medications.id	uuid	О
medication_request_allowed	program_medications.medication_request_allowed	bool	О
care_plan_activity_allowed	program_medications.care_plan_activity_allowed	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	О
reimbursement.reimbursement_amount	program_medication.reimbursement.reimbursement_amount	float8 in jsonb	О
reimbursement.percentage_discount	program_medication.reimbursement.percentage_discount	float8 in jsonb	О
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)	Н

Повернути ідентифікатор job з результатом.