Versions Compared

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 condition info from Admin panel.API paragraph not found

Specification*

Page Properties

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/conditions/get-condition-by-id

Resource

/api/patients/{{patient_id}}/conditions/{{condition_id}}

Scope

condition:read

Components

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

Microservices

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

Protocol type

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

Request type

GET

Sync/Async

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

Logic*

  1. Get condition by id and patient_id

  2. Render detailed condition data according to schema

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 condition details.

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

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

  5. Query should be invoked only if /wiki/spaces/AFC/pages/16680386561 for monitoring exists for current user and corresponding patient (ABAC rule_-2).

API paragraph not found

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

Patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

condition_id

String

Condition identifier

a10aeafb-0df2-4091-bc83-f07e92a100ae

...

API paragraph not found

Authorize*

...

Verify the validity of access token

  • in case of error - return 401 (“Invalid access token”) in case of validation fails

...

  • in case of error - return 401 (“Invalid access token”)

...

Check user scopes in order to perform this action (scope = 'condition:practical_monitor')

  • return 403 (“Your scope does not allow to access this resource. Missing allowances: condition:practical_monitor”) in case of invalid scope(s)

...

Check user has access to resource according to @rule_-2 in ABAC

  • return 403 (“Access denied. Justification required“) in case of error

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

Request data validation*

Validate legal entity

  • Extract client_id from token.

  • Check client scopes in order to perform this action (scope = 'condition:practical_monitor')

    • in case of error - return 403 (“Your scope does not allow to access this resource. Missing allowances: condition:practical_monitor”)

  • Check legal entity status (status = ACTIVE)

    • In case of error - return 409 ('client_id refers to legal entity that is not active')

Validate request

...

Check required personId submitted.

  • return 404 (“not found“) in case not exist

Check required condition Id submitted.

...

return 404 (“not found“) in case not exist or not related to the person

...

API paragraph not found

Processing*

API paragraph not found

...