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
...
| title | Example |
|---|
...
HTTP status codes
...
Response code
...
HTTP Status code
...
Message
...
Internal name
...
Description
...
Базові
...
1000
...
404
...
Composition not found
...
COMPOSITION_NOT_FOUND_404
...
Не знайдено медичний висновок
...
401
...
Unauthorized
...
Помилка підтвердження
...
Специфічні
...
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
...
| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (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 receive active person declarations issued by current legal entity (based on access_token). It can be used to check if Patient has active declarations in other Legal Entities
Logic
N/A
Configuration parameters
N/A
Dictionaries
PHONE_TYPE
+DOCUMENT_TYPE
+DOCUMENT_RELATIONSHIP_TYPE
EMPLOYEE_TYPE
COUNTRYEDUCATION_DEGREEQUALIFICATION_TYPE
SPECIALITY_TYPE
SPEC_QUALIFICATION_TYPE
+DIVISION_TYPE
+ADDRESS_TYPE
SETTLEMENT_TYPE
STREET_TYPE
GENDER
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id |
| String |
|
|
| 2 |
Request structure
See on API-specification
| Expand | ||
|---|---|---|
| ||
|
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Validate mandatory query params
person_id (id)
Verify the validity of access token
Check user scopes in order to perform this action
Get legal_entity_id and division_id from current context
Processing
Search ACTIVE (declarations.active = true) person declaration using person_id in OPS_DB.declarations
In case found more than one - get newest declaration (TOP 1 order by inserted_at desc)
Response structure examples
See on API-specification
If no records found - return empty list
If record found and declarations.division_id = context.division_id - return short declaration details
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
If record found and declarations.division_id != context.division_id - return 403 Error code
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 |
| Short declaration info if active declaration found AND issued by legal entity that is available for | ||
| 3 | 403 |
| if active declaration found issued by other (not available by access scopes) legal entity | ||
| 4 | 404 |
| if active declaration not found | ||
| 5 | |||||
| 6 | Специфічні | ||||
| 7 | |||||
Post-processing processes
N/A
Technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|