Versions Compared

Version Old Version 4 New Version 5
Changes made by

Serhii Boldin (SoE eHealth) (Unlicensed)

Serhii Boldin (SoE eHealth) (Unlicensed)

Saved on

Key

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

Required parameters are marked with "*"

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

Purpose*

This WS allows to get detailed episode info from Admin panel.

...

Page Properties

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-episode-by-id

Resource

/api/patients/{{patient_id}}/episodes/{{episode_id}}

Scope

episode:read

Components

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

Microservices

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

Protocol type

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

Request type

GET

Sync/Async

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

Logic*

API paragraph not found

...

Key points

  1. This is a graphQl query used in Administration panel only

  2. Only authenticated and authorized NHS employee with appropriate scope can get episode details.

  3. Query returns single episode by person (mpi id) and episode identifier.

  4. Filtration with forbidden group items is worked here. So NHS employee should have an approval from patient to see an episode with forbidden elements.

  5. Query should be invoked only if Justification for monitoring exists for current user and corresponding patient (ABAC rule_-2).

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

...