| 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 This web service is designed to return detailed information of the patient’s observation.
Logic
N/A (Not applicable)
Configuration parameters
N/A (Not applicable)
Dictionaries
eHealth/resources - patient (parameter “patient_id“ in request)
eHealth/resources - observation (parameter “id“ in request)
eHealth/observation_statuses(parameter “status“ in response)
eHealth/resources - diagnostic_report (parameter “diagnostic_report“ in response)
eHealth/resources - encounter (parameter “context“ in response)
eHealth/observation_categories(parameter “categories“ in response)
eHealth/LOINC/observation_codes (parameter “code“ in request/response)
eHealth/resources - employee (parameter “performer“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/observation_interpretations (parameter “interpretation“ in response)
eHealth/body_sites (parameter “body_site“ in response)
eHealth/observation_methods (parameter “method“ in response)
eHealth/ucum/units (parameter “reference_ranges:low; reference_ranges:high;“ in response)
eHealth/reference_range_types (parameter “type“ in response)
eHealth/reference_range_applications (parameter “applies_to“ in response)
eHealth/ucum/units (parameter “age:low; age:high;“ in response)
eHealth/resources - specimen (parameter “specimen“ in response)
eHealth/resources - equipment (parameter “device“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 |
patient_id |
| String |
Composition object ID
89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
Unique MPI patient identifier |
| ||||
| 2 | id |
| String | Unique observation 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
Authorize
Request to process the request using a token in the headers
Request data validation
Validate token
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Validate scopes
Check user scopes in order to perform this action (scope = '
patient_summary:read')Return 403 in case invalid scope(s)
Access to the resource is also managed by ABAC module.
Validate patient
Validate patient exists in MongoDB
In case of error return 404 not found
Validate observation
Validate observation exists in MongoDB
In case of error return 404 not found
Check observation belongs to patient
In case of error return 404 not found
Processing
Get observation by ID
Ensure that requested observation relates to requested Patient
Filter using configuration param
SUMMARY_OBSERVATIONS_ALLOWEDin order to return only allowed codesRender 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 |
| ||||
|
200 |
Composition not found
COMPOSITION_NOT_FOUND_404
| Response |
|
| 3 |
| 401 |
Unauthorized
Помилка підтвердження
Специфічні
422
| Access token validation failed |
| |||
| 4 |
| 401 |
| Access token expired |
|
| 5 |
| 403 | Your scope does not allow to access this resource. Missing allowances: patient_summary:read | Forbiden |
|
| 6 |
| 403 | Access denied | Forbiden |
|
| 7 |
| 404 |
| Not found |
|
| 8 | Специфічні | ||||
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)