/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-0285 |
Microservices (namespace) | ME |
Component | Patient Summary |
Component ID | COM-007-008 |
Link на API-специфікацію | |
Resource | {{host}}/api/patients/{{patient_id}}/summary/devices |
Scope | patient_summary:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private | Public |
...
external_system - employee (parameter “identifier“ in response)
device_name_type (parameter “name:type“ 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 | type |
| String | Device type |
|
| 3 | asserted_date_from |
| String |
|
|
| 4 | asserted_date_to |
| String |
|
|
| 5 | page |
| Number | Page number |
|
| 6 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
...
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
...