| Info |
|---|
| 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
Describe the purpose of the API method, add Key points (if necessary)
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
...
eHealth/resources - service_request (parameter “based_on“ in response)
eHealth/procedure_statuses (parameter “status“ in response)
eHealth/procedure_status_reasons (parameter “status_reason“ in response)
eHealth/resources - service (parameter “code“ in response)
eHealth/resources - employee (parameter “recorded_by“ in response)
eHealth/report_origins (parameter “report_origin“ in response)
eHealth/resources - division (parameter “division “ in response)
eHealth/resources - legal_entity (parameter “managing_organization“ in response)
eHealth/resources - reason_references (parameter “condition“ in response)
eHealth/resources - equipment (parameter “used_references“ in response)
eHealth/procedure_outcomes (parameter “outcome“ in response)
eHealth/procedure_categories (parameter “category“ in response)
eHealth/resources - encounter (parameter “encounter“ in response)
eHealth/resources - episode (parameter “origin_episode“ in response)
eHealth/resources - condition (parameter “complication_details“ in response)
eHealth/assistive_products(parameter “used_codes“ in response)
procedure_focal_device_actions (parameter “focal_device“ in response)
Input parameters
...
Headers
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
api-key
aFBLVTZ6Z2dON1V
api-key:aFBLVTZ6Z2dON1V
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | 2 |
Request structure
See on API-specification
...
| title | Example |
|---|
patient_id | M | String | Unique MPI patient identifier |
| |
| 2 | status |
| String | Procedure status |
|
| 3 | code |
| String |
|
|
| 4 | page |
| Number | Page number |
|
| 5 | page_size |
| Number | A limit on the number of objects to be returned, between 1 and 100. Default: 50 |
|
Request structure
See on API-specification
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
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
...
...
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "7075e0e2-6b57-47fd-aff7-324806efa7e5",
"based_on": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "service_request"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"paper_referral": {
"requisition": "1111-2222-3333-4444",
"requester_legal_entity_name": "Some clinic",
"requester_legal_entity_edrpou": "12345678",
"requester_employee_name": "John",
"service_request_date": "2018-10-08",
"note": "Some notes"
},
"status": "COMPLETED",
"status_reason": {
"coding": [
{
"system": "eHealth/procedure_status_reasons",
"code": "default"
}
]
},
"code": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "service"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"performed_date_time": "2018-08-02T10:55:00.000Z",
"recorded_by": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "Шевченко Олесь Вікторович"
},
"primary_source": true,
"performer": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
],
"text": "Галина Олександрівна"
},
"value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
}
},
"division": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "division"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"managing_organization": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "legal_entity"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "Перше відділення обласної лікарня №1"
},
"reason_references": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
}
],
"outcome": {
"coding": [
{
"system": "eHealth/procedure_outcomes",
"code": "default_outcome"
}
]
},
"note": "Додаткова інформація по процедурі",
"category": {
"coding": [
{
"system": "eHealth/procedure_categories",
"code": "default"
}
]
},
"encounter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"explanatory_letter": "Процедура була відмінена у зв'язку з помилкою при виборі пацієнта",
"origin_episode (Reference_response, optional)": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "episode"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"complication_details": [
{
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "condition"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
}
]
}
],
"paging": {
"page": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 20
}
} |
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 200 | ||||
| 3 | Специфічні | 4 | |||
Post-processing processes
...
| 200 |
| Response |
| |
| 3 |
| 401 |
| Access token validation failed |
|
| 4 |
| 401 |
| Access token expired |
|
| 5 |
| 403 |
| Invalid scope |
|
| 6 |
| 404 |
| Patient not found |
|
| 7 | Специфічні | ||||
Post-processing processes
N/A (Not applicable)
Technical modules where the method is used
List of pages describing technical modules where the method is used
...
N/A (Not applicable)