Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-episodes-by-search-params	Посилання на Apiary або Swagger
Resource	/api/patients/{{patient_id}}/summary/episodes	Посилання на ресурс, наприклад: /api/persons/create
Scope	`TBD`	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

...

Filter	Type	Description	Example
patient_id	String	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
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`
period_start_from	String		`2017-01-01`
period_start_to	String		`2018-01-01`
period_end_from	String		`2017-01-01`
period_endperiod_to	String		`2018-01-01`

Request structure

API paragraph not foundSee on Apiary

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

...