| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
...
| id | page_properties_method_REST API |
|---|
...
Document type
...
Метод REST API
...
Guideline ID
...
GUI-0011
...
Author
...
@
...
Document version
...
1
...
Document status
...
DRAFT
...
Date of creation
...
ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
...
Date of update
...
ХХ.ХХ.ХХХХ (дата зміни версії)
...
Method API ID
...
API-001-001-001-0001
...
Microservices (namespace)
...
MPI
...
Component
...
Auth
...
Component ID
...
COM-001-001
...
Link на API-специфікацію
...
...
Resource
...
{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package
...
Scope
...
Protocol type
...
Request type
...
Sync/Async
...
Public/Private
Purpose
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
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
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Description of the REST API response structure, example
| Expand | ||
|---|---|---|
| ||
| Info | ||
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
| Table of Contents |
|---|
Properties of a REST API method document
| Page Properties | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
|
Purpose
This method allows to get the details of the Composition and detailed information about the related composition.
Used in processes:
1. Пошук та отримання МВ (загальний процес)
Logic
...
| Expand | ||
|---|---|---|
| ||
MIS/Medical employee->Compositions: Create Composition POST/patients/composition |
Configuration parameter
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 | compositionId |
| String ($uuid) (path) | Composition object ID | 8c696fa4-6607-4aef-bab7-33cabc2dda2c |
| 2 | patientId | String ($uuid) (path) | Patient object ID | 6a524088-c3f6-44ef-bcea-12a8e2900431 | |
| 3 | episodeId | String ($uuid) (path) | Episode of care object ID | e4f8c204-4879-4a90-a89f-707ffd7f02c4 | |
| 4 | encounterId | String ($uuid) (path) | Encounter object ID | d44ac2e9-9c83-4f5a-9ce1-0b764f260fff |
Request structure
| Expand | ||
|---|---|---|
| ||
|
Headers
Key | Value | Mandatory | Description | Example | |
|---|---|---|---|---|---|
| 1 | Content-Type | application/json | Тип контенту | Content-Type:application/json | |
| 2 | Authorization | Bearer {token} | Перевірка користувача | Authorization: Bearer {token} | |
| 3 | api-key | {secret} | Секретний ключ | api-key: {secret} |
Request data validation
Authorize
Check user scopes in order to perform this action (scope = 'composition:read')
return 401 (Unauthorized) in case of invalid scope(s)
Composition is not directly involved in the processing of the access authorization module (in the ABAC rules and in the creation of approvals). However, the getComposition request contains encounter's and episod's IDs. That's mean approve for obtain a composition is inherited from these objects and determined by the approvals on them.
In the case of access denied to view the Composition according to the rules of ABAC - return 403 "Access denied"
| Expand | ||
|---|---|---|
| ||
{ |
In case of wrong request data - return 404 “Not Found“ - “no Route matched with those values”
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | ||||||||
| 2 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок200 | If the object exists and access is authorized | |||
| 3 | 401403 | Unauthorized | Помилка підтвердження | ||||||
| 4 | Специфічні | ||||||||
| 5 | 422 | Only for active MPI record can be created medication request!Access denied | In the case of access denied to view the Composition according to the rules of ABAK | ||||||
| 4 | 404 | In case the Composition does not exist | The Composition wasn’t found | ||||||
| 5 | Специфічні | ||||||||
| 6 | |||||||||
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
| Page Properties Report | ||||
|---|---|---|---|---|
|
...