REST API method / Метод REST API (настанова)

Info
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

id	page_properties_method_REST API

Public/Private
Document type	Метод REST API
Document title	[DRAFT] Activate equipment [API-007-002-002-0237]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-001007-001002-001002-00010237
Microservices (namespace)	MPIME
Component	AuthDevices and equipment
Component ID	COM-001007-001002
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-details
Resource	{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package/equipment/{{id}}/actions/activate
Scope	equipment:write
Protocol type	REST
Request type	PATCH
Sync/Async	Sync

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

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

...

Public

Purpose

N/A

Logic

Only authenticated and authorized HR, ADMIN, OWNER employees from MSP, OUTPATIENT, PRIMARY_CARE, EMERGENCY legal entities can activate equipments
Only INACTIVE equipment can be activated
Legal entity can activate only its own equipments

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

composition_id

M

String ($uuid) (path)

Composition object ID

89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

Equipment identifier.

Required

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

2

Request structure

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

Description of the REST API request structure, example

...

title	Example

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

Description of the REST API response structure, example

...

title	Example

...

Expand

title	Example

Code Block

Headers

Request data validation

Authorize

Verify the validity of access token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'equipment:write')
1. Return 403 in case invalid scope(s)

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 division

Check that division is active

Check division status (status = ACTIVE)
1. In case of error - return 409 (Division must be active)

Validate equipment

Check that equipment with such ID exists in the system (is_active = true)
1. In case of error - return 404
Check that equipment belongs to the same legal entity as the user
1. In case of error - return 403

Validate transition

Only INACTIVE equipment can be activated

Available transitions

INACTIVE → ACTIVE

In other cases - return 409 error with message "ACTIVE equipment cannot be ACTIVATED"

Processing

Update object in DB

1. equipments table

Patameter	Source	Description
status	Const: ACTIVE	By default ACTIVE for activated records
updated_at	Timestamp: now()	Get current date-time
updated_by	Token: user_id	Extract user from token

Save object to DB

1. equipment_status_hstr table

Parameter	Source	Description

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

Response structure examples

See on API-specification

Expand

title	Example

Code Block

language	json

{
  "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		1000200	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок	Response
3		401	Unauthorized	Помилка підтвердження
4	Специфічні
5	422	Only for active MPI record can be created medication request!	Access token validation failed
4		403		Invalid scope(s) Validation failed
5		404		Validation failed
6		409	ACTIVE equipment cannot be ACTIVATED
7		409	Division must be active
8		409	Legal entity must be ACTIVE or SUSPENDED
9		409		Validation failed
10	Специфічні
11

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Page Properties Report

headings	ID ТМ, Статус
cql	label = "tr-mis"

...

Versions Compared

Old Version 2

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Processing

Response structure examples

Headers

Request data validation

Authorize

Validate division

Validate equipment

Validate transition

Processing

Update object in DB

1. equipments table

1. equipment_status_hstr table

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Processing

Response structure examples

Headers

Request data validation

Authorize

Validate division

Validate equipment

Validate transition

Processing

Update object in DB

1. equipments table

1. equipment_status_hstr table

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used