| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
...
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [Document status] REST API [Назва методу] [ID методуDRAFT] Get Device by id (Patient Summary) [API-007-002-001-0230] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-007-002-001-0230 |
|---|
Microservices (namespace) | ME |
|---|
Component | Devices and equipment |
|---|
Component ID | COM-007-002 |
|---|
Link на API-специфікацію | https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-device-by-id |
|---|
Resource | {{host}}/api/patients/{{patient_id}}/devices/{{device_id}} |
|---|
Scope | device:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
...
This web service is designed to return records about patient's devices by patient_id or search_params.
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)N/A
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 ConfluenceN/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | patient_id | | String | Unique patient identifier | e549c257-232e-4dab-9f1e-b2322cac3968
|
| 2 | device_id | | String | Unique device identifier | 340b86fd-23f3-4a33-94c5-8ec19d116c33
|
Request structure
See on API-specification
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer mF_9.B5f-4.1JqM
...
Authorization:Bearer mF_9.B5f-4.1JqM
Headers
Request data validation
Authorize
...
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 APIN/A
Response structure examples
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
| {
"data": {
"id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"status": "inactive",
"asserted_date": "2018-08-02T10:45:00.000Z",
"usage_period": {
"start": "2000-01-01T00:00:00.000Z",
"end": "2018-08-02T11:00:00.000Z"
},
"context": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"primary_source": true,
"asserter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
],
"text": ""
},
"value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
}
},
"type": {
"coding": [
{
"system": "eHealth/device_types",
"code": "Spine_board"
}
]
},
"lot_number": "RZ12345678",
"manufacturer": "GlobalMed, Inc",
"manufacture_date": "1999-01-01T00:00:00.000Z",
"expiration_date": "2020-01-01T00:00:00.000Z",
"model": "NSPX30",
"version": "v1.0.1",
"note": "Імплант був вилучений по причині заміни на новий",
"inserted_at": "2018-08-02T10:55:00.000Z",
"updated_at": "2018-08-02T10:55:00.000Z"
},
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
}
} |
|
...
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 |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|
...