Versions Compared

Version Old Version 1 New Version Current
Changes made by

Mykhaylo Khapchyk (SoE eHealth)

Mykhaylo Khapchyk (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Method to get or search all active device definitions in the system.

Used to return device definitions with the old structure only.

Will be deprecated

Specification

Page Properties
idAPI_Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/public.-devices/get-device-definitions/get-device-definitions

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

Resource

/api/device_definitions

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

Scope

device_definitions:read

Scope для доступу

Components

Public. Devices

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

Microservices

Devices

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

Protocol type

REST

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

Request type

GET

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

Sync/Async

Sync

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

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

Filters

Filter

Values

Type

Description

Example

classification_type

String

Classification type. Dictionary device_definition_classification_type

30221

model_number

String

Model number for the device

H00P53

name

String

Device name

Some name

name_type

Enum

Device name type. Dictionary device_name_type

registered

medical_program_id

String

medical program id

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

is_active

Boolean

device definition status

true

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 300. Default: 50

50

...

  1. Get all device_definitions (PRM database) where device_definitions.classification_type is not empty.

  2. Filter list by passed search parameters (according to spec.)

    1. Search using like operation. Case insensitive

    2. if medical_program_id is passed than get device definitions related to this program in program_devices table

      1. is_active = true

      2. start_date <= current date()

      3. end_date >= current_date(), if not null

  3. Render a response according to specification

...