Table of Contents | ||||
---|---|---|---|---|
|
...
...
Purpose
...
API paragraph not found
Specification
...
Page Properties | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Project Name | COVID-certificate | |||||||||||||||||
Project abreviation | SVC | |||||||||||||||||
Developer | Розробник методу API. Наприклад, Edenlab | |||||||||||||||||
Project Manager | @Єлизавета Гессен-Дармштадська | |||||||||||||||||
Tech Lead | @Іоанн Воїнов | |||||||||||||||||
Product Owner | @Нікодім Святогорцев | |||||||||||||||||
Вusiness analyst | @Пантелеймон Нікомедійський | Status |
Status | ||||
---|---|---|---|---|
|
Version
1.0
Date of release
Link | https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-immunizations |
Resource | /api/patients/{{patient_id}}/summary/immunizations |
Scope | patient_summary:read |
Components | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionPatient Summary |
Microservices | Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found |
Protocol type | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | GET |
Sync/Async | Метод є синхронним чи асинхронним?Async |
Public/Private/Internal | Public |
Logic
...
API paragraph not found
Filters
Filter | Values | Type | Description | Example |
---|---|---|---|---|
patient_id | String | Unique patient identifier |
| |
page | Number | Page number |
| |
page_size | Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
| |
vaccine_code | String |
| ||
date_from | String |
| ||
date_to | String |
|
Request structure
...
API paragraph not found
Authorize
...
Request to process the request using a token in the headers
Headers
...
Наприклад:
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
Validate request*
API paragraph not found
Request data validation*
API paragraph not found
Processing*
API paragraph not found
...
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')
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 immunizations
Apply filters provided by user
Response structure
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes
...
API paragraph not found
HTTP status codes
...
Page Properties | ||||||
---|---|---|---|---|---|---|
|
...