1 Purpose
2 Specification
3 Logic
4 Request structure
5 Authorize
6 Headers
7 Request data validation
- 7.1 Validate FK
- 7.2 Validate status
- 7.3 Validate status ingredients.is_primary
- 7.4 Validate innm duplication
- 7.5 Validate request
8 Processing
- 8.1 Create new Medication
- 8.2 Create new Ingredients
9 Response structure
10 HTTP status codes

Purpose

This WS is designed to create new innm dosage (post).

Specification

Link	API paragraph not found
Resource	/innm_dosages
Scope	innm_dosage:write
Components	Drugs and Program medications
Microservices	API paragraph not found
Protocol type	REST
Request type	POST
Sync/Async	Sync
Public/Private/Internal	Internal. NHS Admin

Logic

This method is used to create INNM Dosage. Fields descriptions are listed in request Example view.

Request structure

See on Apiary

Example:

{
  "name": "Амідарон",
  "form": "PILL",
  "ingredients": [
    {
      "id": "1349a693-4db1-4a3f-9ac6-8c2f9e541982",
      "dosage": {
        "numerator_unit": "MG",
        "numerator_value": 200,
        "denumerator_unit": "PILL",
        "denumerator_value": 1
      },
      "is_primary": true
    }
  ]
}

Authorize

Verify the validity of access token
Check user scope (scope = 'innm_dosage:write') in order to perform this action
1. In case error - generate 401 response

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate FK

Purpose validation: Check on existing Inmm/Innm dosage in ingredients

For Check exist `Innm` by $.ingredients[].id.
1. if invalid - return 422 error (message: "Innm in ingredients is not found!")

Validate status

Purpose validation: Id's in ingredients must be active

Invoke GetInnmByID($.ingredients[].id). Check exist any innm.is_active=FALSE.
1. if exists - return 422 error (message: "Innm in ingredients must be active!")

Validate status ingredients.is_primary

Purpose validation: in ingredients only one item must be is active innm (TRUE)

Calc count() where is_primary=TRUE in ingredients. Check count()=1.
1. if invalid - return 422 error (message: "One of ingredients must be primary!")

Validate innm duplication

Purpose validation: in ingredients innms can't be duplicated. Innms id has to be unique

Check uniqueness of $.ingredients[].id.
1. if invalid - return 422 error (message: "Ingredients can't be duplicated")

Validate request

Validate request using JSON schemas (new_medication_type_innm_dosage_schema.json):
1. Return 422 with list of validation errors in case validation fails (422 EView)

Processing

Create new Medication

Create new record in Medications
Fill data

Destination	Source
id
name	$.name
type	INNM Dosage
is_primary	TRUE
form	$.form
ingredients	$.ingredients
container	NULL
package_qty	NULL
package_min_qty	NULL
code_atc	NULL
manufacturer	NULL
certificate	NULL
expired_certificate_at	NULL
inserted_at	:timestamp
inserted_by	user_id
updated_at	:timestamp
updated_by	user_id

Create new Ingredients

Save `id` of new Medication into var `med_id`
Create new record in Ingredients from $.ingredients
Delete all Ingredients where parent_id =
Fill data (where `Ing` = $.ingredients)

Destination	Source
id
dosage	Ing.dosage
parent_id	med_id
innm_id	Ing.innm_id
medication_id	NULL
is_primary	Ing.is_primary
inserted_at	:timestamp
inserted_by	user_id
updated_at	:timestamp
updated_by	user_id

Response structure