Versions Compared

Old Version 1

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

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

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Update equipment [API-007-002-002-0233]

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-0233

Microservices (namespace)

ME

Component

Devices and equipment

Component ID

COM-007-002

Link на API-специфікацію

Resource

{{host}}/api/equipment/{{id}}

Scope

equipment:write

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

Purpose

This method used for update equipment data, except link with division and status

Logic

  1. Only authenticated and authorized HR, ADMIN, OWNER employees can update equipment.

  2. Equipment can be updated from MSP, OUTPATIENT, PRIMARY_CARE and EMERGENCY legal entities.

  3. Only ACTIVE equipment can be updated.

  4. Update of division_id and status is not allowed with this service.

  5. Legal entity can update only its own equipments.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Equipment identifier. Required

d290f1ee-6c54-4b01-90e6-d701748f0851

2

Request structure

See on API-specification

Expand
titleExample
Code Block
{
  "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

Headers

Request data validation

Authorize

  1. Verify the validity of access token

    1. Return 401 in case validation fails

  2. Check user scopes in order to perform this action (scope = 'equipment:write')

    1. Return 403 in case invalid scope(s)

Validate legal entity

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

  1. Extract client_id from token (token.client_id == legal_entity_id)

  2. Check legal entity status (status = ACTIVE, SUSPENDED)

    1. In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)

Validate equipment

  1. Check that ID in URL exists in the system

    1. In case of error - return 404

  2. Check that equipment belongs to the same legal entity as the user

    1. In case of error - return 403

Validate request

Validate request using schema

Processing

Update object in DB

1. equipment table

 

Parameter

Source

Description

Parameter

Source

Description

type

Request: type

Get from request body

external_id

Request: external_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

updated_at

Timestamp: now()

Get current date-time

updated_by

Token: user_id

Extract user from token

Response structure examples

See on API-specification

Expand
titleExample
Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
    "division_id": "8be63914-a278-470b-b868-1af5b9087332",
    "legal_entity_id": "483af06f-d4c6-4c9e-8d9b-680b5ef7270d",
    "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": "Технічний огляд раз на рік",
    "status": "ACTIVE",
    "is_active": true,
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

 Response

 

3

401

 

 Access token validation failed

4

403

 

  • Invalid scope(s)

  • Check that equipment belongs to the same legal entity as the user failed

5

404

 

Validation failed

6

409

 

Validation failed

7

409

Legal entity must be ACTIVE or SUSPENDED

8

Специфічні

9

Post-processing processes

N/A

Technical modules where the method is used

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"