/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
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-008-004-0284 |
Microservices (namespace) | ME |
Component | Patient Summary |
Component ID | COM-007-008 |
Link на API-специфікацію | |
Resource | {{host}}/api/patients/{{patient_id}}/summary/devices/device_id |
Scope | patient_summary:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private | Public |
Purpose
Logic
Configuration parameters
N/A (Not applicable)
Dictionaries
external_system - employee (parameter “identifier“ in response)
device_name_type (parameter “name:type“ in response)
eHealth/device_statuses (parameter “status“ in response)
device_properties (parameter “property:code“ in response)
eHealth/ucum/units (parameter “property:value_quantity:low:system“ in response)
eHealth/ucum/units (parameter “property:value_range:high:system“ in response)
device_definition_classification_type (parameter “type“ in response)
eHealth/resources - device_definition(parameter “definition“ in response)
eHealth/resources - device(parameter “parent“ in response)
eHealth/resources - employee(parameter “recordet“ in response)
eHealth/resources - encounter (parameter “context“ in response)
device_status_reasons (parameter “status_reason“ in response)
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id | M | String | Unique MPI patient identifier |
|
| 2 | device_id | M | String | Unique device identifier |
|
Request structure
See on API-specification
Headers
See on Headers
Request data validation
Authorize
Request to process the request using a token in the headers
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 = 'condition:read')
Return 403 in case invalid scope(s)
Access to the resource is also managed by ABAC module
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description |
|---|
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 200 |
|
|
|
| 3 |
| 401 |
| Access token validation failed |
|
| 4 |
| 401 |
| Access token expired |
|
| 5 |
| 403 |
| Invalid scope |
|
| 6 | Специфічні | ||||
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
N/A (Not applicable)