/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [Document status] REST API [Назва методу] [ID методу] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-001007-001011-001-00010487 |
Microservices (namespace) | MPI |
Component | Auth |
Component ID | COM-001007-001011 |
Link на API-специфікацію | |
Resource | {{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package |
Scope | |
Protocol type | REST |
Request type | |
Sync/Async | |
Public/Private |
Purpose
This method allows to get single Observation by its identifier using Composition context. It is designed to provide access to resources mentioned in Composition in case user has active Approval to such Composition
Key points
Only authenticated and authorized employee with appropriate scope can use this method
Method returns a single Observation via Composition context only in case user has active Approval to such Composition
ABAC rules are used here
Employee with active approval can read all the data of specified in approval composition - @rule_18
Logic
Service logic
Service returns specified Observation related to the patient:
Get Observation from
observationscollection (MongoDB)Check it exists in DB
Return 404 ('not found') in case of error
Check Observation belongs to the patient
Return 403 ('forbidden') in case of error
Render response according to specification
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in Confluence
Input parameters
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | composition_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 2 |
|
|
|
|
|
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
| Expand | ||
|---|---|---|
| ||
|
Headers
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | M | Тип контенту | Content-Type:application/json |
| 2 | Authorization | Bearer c2778f3064753ea70de870a53795f5c9 | M | Перевірка користувача | Authorization:Bearer c2778f3064753ea70de870a53795f5c9 |
| 3 |
|
|
|
|
|
Request data validation
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Validate Composition
Get Composition identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check Composition belongs to patient
Return 403 ('forbidden') in case of error
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 401 | Invalid access token | |||
| 3 |
| 401 | Unauthorized |
| Помилка підтвердження |
| 4 | 403 | forbidden | |||
| 5 | 403 | Your scope does not allow to access this resource. Missing allowances: composition:read | |||
| 6 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок |
| 7 | 404 | not found | |||
| 8 | Специфічні | ||||
| 9 |
| 422 | Only for active MPI record can be created medication request! |
|
|
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||
...