ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “API paragraph not found”.

Purpose*

API paragraph not found

Specification*

Project Name

COVID-certificate

Project abreviation

SVC

Developer

Розробник методу API. Наприклад, Edenlab

Project Manager

@Єлизавета Гессен-Дармштадська

Tech Lead

@Іоанн Воїнов

Product Owner

@Нікодім Святогорцев

Вusiness analyst

@Пантелеймон Нікомедійський

Status

APPROVED

Version

1.0

Date of release

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/device/get-devices-by-search-params

Resource

/api/patients/{{patient_id}}/devices

Scope

device:read

Components

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

Microservices

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

Protocol type

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

Request type

GET

Sync/Async

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

Logic*

API paragraph not found

Filters

Filter

Values

Type

Description

Example

page

Number

Page number

2

page_size

Number

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

50

type

String

spine_board

encounter_id

String

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

episode_id

String

09dc3ed7-2169-45d8-8fa3-d918c6839bf9

asserted_date_from

String

1990-01-01

asserted_date_to

String

2000-01-01

Request structure*

API paragraph not found

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

Validate request*

API paragraph not found

Request data validation*

API paragraph not found

Processing*

API paragraph not found

Response structure*

See on Apiary

Example:

 Response example
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "status": "inactive",
      "asserted_date": "2018-08-02T10:45:00.000Z",
      "usage_period": {
        "start": "2000-01-01T00:00:00.000Z",
        "end": "2018-08-02T11:00:00.000Z"
      },
      "context": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "primary_source": true,
      "asserter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ],
            "text": ""
          },
          "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
        }
      },
      "type": {
        "coding": [
          {
            "system": "eHealth/device_types",
            "code": "Spine_board"
          }
        ]
      },
      "lot_number": "RZ12345678",
      "manufacturer": "GlobalMed, Inc",
      "manufacture_date": "1999-01-01T00:00:00.000Z",
      "expiration_date": "2020-01-01T00:00:00.000Z",
      "model": "NSPX30",
      "version": "v1.0.1",
      "note": "Імплант був вилучений по причині заміни на новий",
      "inserted_at": "2018-08-02T10:55:00.000Z",
      "updated_at": "2018-08-02T10:55:00.000Z"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes*

HTTP status code

Message

What caused the error

 200

 

 

  • No labels