REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-002-002-0232
Microservices (namespace)	ME
Component	Devices and equipment
Component ID	COM-007-002
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/equipment/create-equipment
Resource	{{host}}/api/equipment
Scope	equipment:write
Protocol type	REST
Request type	POST
Sync/Async	Sync
Public/Private	Public

Purpose

This WS is designed for registration equipment in divisions of legal entities

Logic

Only authenticated and authorized HR, ADMIN, OWNER employees can register equipments.
Equipments can be registered in MSP, OUTPATIENT, PRIMARY_CARE and EMERGENCY legal entities.
Equipment has to be linked to division. One division can have many equipments.
Legal entity can register equipments for its own divisions only.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

	Input parameter	Mandatory	Type	Description	Example
1	composition_id	M	String ($uuid) (path)	Composition object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Example

{
  "division_id": "8be63914-a278-470b-b868-1af5b9087332",
  "type": "23143534",
  "external_id": "123-ASD-#1",
  "udi": [
    {
      "value": "IMEI 49015420323751",
      "type": "default",
      "assigner_name": "Ukrainian center of the certification"
    }
  ],
  "lot_number": "RZ12345678",
  "manufacturer": "GlobalMed, Inc",
  "manufacture_date": "1999-01-01",
  "expiration_date": "2020-01-01",
  "model_number": "NSPX30",
  "part_number": "#e30-SD",
  "version": "v1.0.1",
  "name": "Рентген апарат флюрографічній",
  "serial_number": "S/N234554",
  "note": "Технічний огляд раз на рік"
}

Headers

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer c2778f3064753ea70de870a53795f5c9			Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3	API-key	uXhEczJ56adsfh3Ri9SUkc4en			API-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

Validate legal entity

Check that legal entity is active (status = ACTIVE, SUSPENDED)

Extract client_id from token (token.client_id == legal_entity_id)
Check legal entity status (status = ACTIVE, SUSPENDED)
1. In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)

Validate request

Validate request using schema

Validate division

A division_id should be passed in request body:

Validate division_id in request body - division exists and is_active = true
1. Return 422 in case validation fails
Check division_id belongs to the same legal_entity_id (from token) as the user
1. Return 422 with message "Division is not within current legal entity" in case validation fails.
Check division status =ACTIVE.
1. Return 422 with message "Division is not active" in case validation fails.

Validate type

Validate that an equipments type value exists in dictionary "EQUIPMENT_TYPE"
1. in case of error "Submitted code is not allowed for this field"

Validate external identifier

Check an external_id field is not empty
1. Return 422 (required property external_id was not present) in case of error

Processing

Save object to DB

1. equipments table

Parameter	Source	Description
id	UUID	Autogenerated
type	Request: type	Get from request body
external_id	Request: external_id	Get from request body
division_id	Request: division_id	Get from request body
udi	Request: udi	Get from request body
lot_number	Request: lot_number	Get from request body
manufacturer	Request: manufacturer	Get from request body
manufacture_date	Request: manufacture_date	Get from request body
expiration_date	Request: expiration_date	Get from request body
model_number	Request: model_number	Get from request body
part_number	Request: part_number	Get from request body
version	Request: version	Get from request body
name	Request: name	Get from request body
serial_number	Request: serial_number	Get from request body
note	Request: note	Get from request body
legal_entity_id	Token: client_id	Extract client from token
status	Const: ACTIVE	By default ACTIVE for new records
is_active	Const: TRUE	Always TRUE for new records
inserted_at	Timestamp: now()	Get current date-time
inserted_by	Token: user_id	Extract user from token
updated_at	Timestamp: now()	Get current date-time
updated_by	Token: user_id	Extract user from token

2. equipment_status_hstr table

Parameter	Source	Description
id	UUID	Autogenerated
equipment_id	UUID	Reference to equipments.id
status	Const: ACTIVE	By default ACTIVE for new records
inserted_by	Token: user_id	Extract user from token
inserted_at	Timestamp: now()	Get current date-time

Response structure examples