1 Purpose
2 Specification
3 Logic
4 Filters
5 Request structure
6 Authorize
7 Headers
8 Request data validation
- - 8.1.1 Validate token
  - 8.1.2 Validate scopes
- 8.2 Validate patient
9 Processing
10 Response structure
11 Post-processing processes
12 HTTP status codes

Purpose

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

Specification

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

Filter	Values	Type	Description	Example

Filter	Type	Description	Example
page	Number	Page number	Example: `2`
page_size	Number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	Example: `50`
medication_code	String		`spine_board`
asserted_date_from	String		`1990-01-01`
asserted_date_to	String		`2000-01-01`

Request structure

See on Apiary

Authorize

Request to process the request using a token in the headers

Headers

Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4

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

Get all patient's medication statements
Apply filters provided by user

Response structure