/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-007-011-001-0481
...
Microservices (namespace)
...
MPI
...
Component
...
Auth
...
Component ID
...
COM-007-011
...
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 Episode of Care 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 Episode of Care 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 Episode of Care related to the patient:
Get Episode of Care from
episodescollection (MongoDB)Check it exists in DB
Return 404 ('not found') in case of error
Check Episode of Care 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
...
composition_id
...
M
...
String ($uuid) (path)
...
Composition object ID
...
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
...
...
...
...
...
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
...
| title | Example |
|---|
...
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
...
...
...
...
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
...
| title | Example |
|---|
...
HTTP status codes
...
Response code
...
HTTP Status code
...
Message
...
Internal name
...
Description
...
Базові
...
404
...
not found
...
401
...
Invalid access token
...
...
401
...
Unauthorized
...
...
Помилка підтвердження
...
403
...
forbidden
...
403
...
Your scope does not allow to access this resource. Missing allowances: composition:read
...
1000
...
404
...
Composition not found
...
COMPOSITION_NOT_FOUND_404
...
Не знайдено медичний висновок
...
Специфічні
...
...
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 /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 | [DRAFT] [NEW] Get Episode details in Composition context [API-007-011-001-0481] |
Guideline ID | GUI-0011 |
Author | |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-011-001-0481 |
Microservices (namespace) | ME |
Component | Compositions_ME |
Component ID | COM-007-011 |
Link на API-специфікацію | |
Resource | {{host}}//api.ehealth.gov.ua/api/patients/patient_id/compositions/id/episodes/episode_id |
Scope | composition:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private | Public |
Purpose
This method allows to get single Episode of Care 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 Episode of Care 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 Episode of Care related to the patient:
Get Episode of Care from
episodescollection (MongoDB)Check it exists in DB
Return 404 ('not found') in case of error
Check Episode of Care belongs to the patient
Return 403 ('forbidden') in case of error
Render response according to specification
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String ($uuid) (path) | Unique patient identifier | 7075e0e2-6b57-47fd-aff7-324806efa7e5 |
| 2 | composition_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 |
| 3 | pisode_id | M | String ($uuid) (path) | Episode identifier | 3a0dcfd7-5348-4511-b46d-b2dc4b94ca98 |
Request structure
See on API-specification
Headers
Request data validation
Authorization
Verify the validity of access token
in case of error - 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 and client scopes in order to perform this action (scope = 'composition:read')
return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)
Access to the resource is also managed by ABAC module
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
N/A
Response structure examples
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 404 | not found | |||
| 3 | 401 | Invalid access token | |||
| 4 | 403 | forbidden | |||
| 5 | 403 | Your scope does not allow to access this resource. Missing allowances: composition:read | |||
| 6 | Специфічні | ||||
| 7 | |||||
Post-processing processes
N/A
Technical modules where the method is used
Название | ID ТМ | Статус |
|---|---|---|
TM0112 | ||
...