Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/clinical-impression/get-clinical-impression-context	Посилання на Apiary або Swagger
Resource	/api/patients/{{patient_id}}/clinical_impressions/{{clinical_impression_id}}/context	Посилання на ресурс, наприклад: /api/persons/create
Scope	medical_event_context: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

Service returns context (episode), clinical impression based on:

...

Input parameter	Values	Type	Description	Example
patient_id		String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
clinical_impression_id		String	Clinical Impression identifier	`a10aeafb-0df2-4091-bc83-f07e92a100ae`

Request structure

...

Verify the validity of access token
- Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
- in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'medical_event_context:read')
- Return (403, 'Your scope does not allow to access this resource. Missing allowances: medical_event_context:read') in case of invalid scope(s)

...