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
...
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-003-001-0242
...
Microservices (namespace)
...
ME
...
Component
...
Diagnostic Report Data Package
...
Component ID
...
COM-007-003
...
Link на API-специфікацію
...
...
Resource
...
{{host}}/api/patients/{{patient_id}}/diagnostic_reports/approved
...
Scope
...
diagnostic_report:read
...
Protocol type
...
REST
...
Request type
...
GET
...
Sync/Async
...
Sync
...
Public/Private
...
Public
Purpose
This web service is designed to return only diagnostic reports that were allowed to read by patient's approval to the current user.
Logic
Select all diagnostic reports(approvals.granted_resources.identifier.value) from patients approvals that meet the requirements:
patient_id= hashed patient_id from URL
status= 'active'
granted_to contains one of user's employees' id
granted_resources.identifier.type.coding[].code="diagnostic_report"
Select this diagnostic reports from ME.patients.diagnostic_reports
Add filters requested by the user (search params)
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
...
Authorization
...
Bearer {{access_token}}
...
Authorization:Bearer {{access_token}}
...
Content-Type
...
application/json
...
Content-Type:application/json
...
API-key
...
{{secret}}
...
API-key:{{secret}}
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
...
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 web service is designed to return only diagnostic reports that were allowed to read by patient's approval to the current user.
Logic
Select all diagnostic reports(approvals.granted_resources.identifier.value) from patients approvals that meet the requirements:
patient_id= hashed patient_id from URL
status= 'active'
granted_to contains one of user's employees' id
granted_resources.identifier.type.coding[].code="diagnostic_report"
Select this diagnostic reports from ME.patients.diagnostic_reports
Add filters requested by the user (search params)
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | |||||
2 |
Request structure
See on API-specification
Expand | ||
---|---|---|
| ||
|
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
Verify the validity of access token
Return 401 in case validation fails
Verify token is not expired
in case error return 401
Check user scopes in order to perform this action (scope = 'diagnostic_report:read')
Return 403 in case invalid scope(s)
Processing
N/A
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
Expand | |||||
---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | ||
---|---|---|---|---|---|---|
1 | Базові | |||||
2 | 200 |
|
| |||
3 | 401 | Unauthorized Unauthorized | Помилка підтвердження | |||
4 | 403 | Invalid scopes |
| |||
5 | 1000 | 404 | Composition not found | COMPOSITION_NOT_FOUND_404 | Не знайдено медичний висновок | |
6 | Специфічні | |||||
7 | 422 | Only for active MPI record can be created medication request!Специфічні | ||||
6 |
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Page Properties Report | ||||
---|---|---|---|---|
|
...