| Info |
|---|
| 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
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
This method allows to get detailed information of the patient’s Clinical impression.
Logic
Configuration parameters
Dictionaries
eHealth/resources - clinical_impression (parameter “clinical_impression_id“ in request)
eHealth/clinical_impression_statuses(parameter “status“ in response)
eHealth/clinical_impression_patient_categories(parameter “code“ in response)
eHealth/resources - encounter (parameter “encounter “ in response)
eHealth/resources - employee (parameter “asserter“ in response)
eHealth/resources - clinical_impression (parameter “previous“ in response)
eHealth/resources - condition(parameter “problems“ in response)
eHealth/resources - condition | observation (parameter “findings“ in response)
eHealth/resources - condition | observation | diagnostic_report | encounter (parameter “supporting_info“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |||||
|---|---|---|---|---|---|---|---|---|---|
| 1 | compositionpatient_id | M | String ($uuid) (path) | Composition object ID | 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59 | 2 | Unique MPI patient identifier |
| |
| 2 | clinical_impression_id | M | String | Unique Clinical impression identifier |
|
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 |
|---|
...
Headers
See on Headers
Request data validation
Authorize
Verify the validity of access token
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 scopes in order to perform this action (scope = 'clinical_impression:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: clinical_impression:read') in case of invalid scope(s)
Access to the resource is also managed by ABAC module
Request to process the request using a token in the headers
Validate Patient
Get Patient identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Validate Clinical impression
Get Clinical impression identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check Clinical impression belongs to patient
Return 404 ('not found') in case of error
Processing
Service returns specified Clinical impression related to the patient:
Get Clinical impression by ID from clinical_impression collection (MongoDB)
Validate data consistency:
Ensure that requested Clinical impression relates to requested Patient (from URL)
Return 404 ('not found') in case of error
Render a response according to specification
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||||
| 2 | 1000 | 404200 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | Response |
| |||||
| 3 |
| 401 | Unauthorized | Помилка підтвердження |
| Access token validation failed |
| |||||
| 4 | Специфічні | 5 | 422 | Only for active MPI record can be created medication request! | 401 |
| Access token expired |
| ||||
| 5 |
| 403 |
| Invalid scope |
| |||||||
| 6 |
| 404 |
| Patient not found | ||||||||
| 7 | Специфічні | |||||||||||
Post-processing processes
Description of actions performed on data after processingN/A (Not applicable)
Technical modules where the method is used
List of pages describing technical modules where the method is used
...
N/A (Not applicable)