Purpose

This web service is designed to provide access to patient's Devices as a part of Patient Summary

Specification

...

...

Get Device by id

Page Properties
id API_Specification
Link https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-devices-by-search-params Посилання на Apiary або Swagger Resource /api/patients/{{patient_id}}/summary/devices Посилання на ресурс, наприклад: /api/persons/create Scope patient_summary:read Scope для доступу Components Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription Microservices Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC Protocol type Тип протоколу, який використовується запитом, наприклад: SOAP | REST Request type GET Тип запиту API, наприклад: GET, POST, PATCH… Sync/Async Метод є синхронним чи асинхронним? Public/Private/Internal Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

Filters

Request structure

API paragraph not foundSee on Apiary

Authorize

API paragraph not foundRequest to process the request using a token in the headers

Headers

API paragraph not found

Request data validation

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• Verify token is not expired

  • in case error return 401

Validate scopes

• Check user scopes in order to perform this action (scope = 'patient_summary:read')

  1. Return 403 in case invalid scope(s)

Validate patient

• Validate patient exists in MongoDB

  • In case of error return 404 not found

Processing

1. Get all patient's devices

2. Apply filters provided by user

Response structure

API paragraph not foundSee on Apiary

Post-processing processes

API paragraph not found

HTTP status codes

API paragraph not found