Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Purpose

The service is designed to upload a new medication registry. The process uses the Jabba service. Upon execution of the request, a job is created, on the basis of which tasks are created. Each task is one request to create an entity from the registry.

Key points

  1. NHS admin user downloads file with fields according to its structure.

  2. The file should be in .csv format and is converted to base64.

Specification

Page Properties

Link

API paragraph not found

Посилання на Apiary або Swagger

Resource

API paragraph not found

Посилання на ресурс, наприклад: /api/persons/create

Scope

medication_registry:write

Scope для доступу

Components

ePrescription

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

API paragraph not found

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

API paragraph not found

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

API paragraph not found

Метод є синхронним чи асинхронним?

Logic

  1. Decode base64 file.

  2. Validate input according to schema.

  3. Validate existing and create new entities of medications registry:

    1. Extract medications with type = INNM_DOSAGE, is_active = TRUE, innm_dosage.name, innm_dosage.form and innm_dosage.ingredients.dosage, innm_dosage.ingredients.is_primary):

      1. in case found extract connected medications with type = BRAND, is_active = TRUE, brand.name, brand.form, brand.package_qty, brand.package_min_qty, brand.certificate, brand.container and brand.ingredients.dosage, brand.ingredients.is_primary):

        1. in case found extract connected program medication by medication_id and program_medications.medical_program_id and insert program medication with brand according to Create medication registry | program_medications in case program medication not found.

      2. in case innm_dosage not found insert it according to Create medication registry | medications (type = INNM_DOSAGE) and its ingredients Create medication registry | ingredients (for INNM_DOSAGE), Create medication registry | innms (skip innms creation in case it exist).

      3. in case brand not found insert brand according to Create medication registry | medications (type = BRAND) and its ingredient Create medication registry | ingredients (for BRAND).

        1. insert program medication with brand according to Create medication registry | program_medications.

      4. in case brand and program medication found return 422 error with msg ('Such medication already exist').

  4. Return job identifier with result.

innms

Attribute

Source and Logic

Type and Constraints

O/M

id

uuid_generate_v4(), auto

uuid

M

sctid

innms.sctid (x), from request

varchar(255)

O

name

innms.name (x), from request

varchar(255)

M

name_original

innms.name_original (x), from request

varchar(255)

M

is_active

true, auto

bool

M

inserted_by

user_id, from token

uuid

M

updated_by

user_id, from token

uuid

M

inserted_at

now(), auto

timestamp

M

updated_at

now(), auto

timestamp

M

...

API paragraph not found

Request data validation

  1. Check that request using schema

    1. Return 422 with the list of validation errors in case validation fails.

  2. Check that registerType = 'FULL_MEDICATIONS_REGISTRY'

    1. Return 422 with the list of validation errors in case validation fails.

  3. Check that reasonDescription filled

    1. Return 422 with the list of validation errors in case validation fails.

  4. Check decoded and encoded input file according to file structure

    1. Return 422 with the list of validation errors in case validation fails.

File example:

View file
namemedication_registries.csv

...