Purpose
API paragraph not found
Specification
| Page Properties |
|---|
|
Link | https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/patient-summary/get-device-by-id | Посилання на Apiary або Swagger | Resource | /api/patients/patient_id/summary/devices/device_id | Посилання на ресурс, наприклад: /api/persons/create | Scope | patient_summary:read
| Scope для доступу | Components | | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | | Метод є синхронним чи асинхронним? | Public/Private/Internal | | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
API paragraph not found
Input parameters
Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:
Input parameter | Values | Type | Description | Example |
|---|
asyncJobIdpatient_id | | String | Async Job Object ID |
Filters
Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:
...
Filter
...
Values
...
Type
...
Description
...
Example
...
status
...
String
...
Optional
...
PROCESSED
Request structure
See on Apiary
Example:
...
...
Unique patient identifier | e549c257-232e-4dab-9f1e-b2322cac3968
|
device_id | | String | Unique device identifier | 340b86fd-23f3-4a33-94c5-8ec19d116c33
|
Request structure
API paragraph not found
Authorize
Request to process the request using a token in the headers
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| 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
API paragraph not found
HTTP status codes
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
| | | 200 | | |
|