Info |
---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
...
id | page_properties_method_REST API |
---|
...
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-003-001-0241
...
Microservices (namespace)
...
ME
...
Component
...
Diagnostic Report Data Package
...
Component ID
...
COM-007-003
...
Link на API-специфікацію
...
https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/diagnostic-report/get-diagnostic-report-by-search-params
...
Resource
...
{{host}}/api/patients/{{patient_id}}/diagnostic_reports
...
Scope
...
diagnostic_report:read
...
Protocol type
...
REST
...
Request type
...
GET
...
Sync/Async
...
Sync
...
Public/Private
...
Public
Purpose
This method is used to return the data of patient diagnostic reports to employees who have a signed declaration with this patient or work in the LE where this diagnostic report was created.
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
Provides a list of links to dictionaries that are available in Confluence
Input parameters
...
Input parameter
...
Mandatory
...
Type
...
Description
...
Example
...
Content-Type
...
application/json
...
Content-Type:application/json
...
Authorization
...
Bearer {{access_token}}
...
Authorization:Bearer {{access_token}}
...
API-key
...
{{secret}}
...
API-key:{{secret}}
Request structure
See on API-specification
...
...
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
Content-Type:application/json
...
Authorization
...
Bearer {{access_token}}
...
Authorization:Bearer {{access_token}}
...
API-key
...
{{secret}}
...
Info |
---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
Page Properties |
---|
id | page_properties_method_REST API |
---|
|
Document type | Метод REST API |
---|
Document title | [DRAFT] Get Diagnostic Report by search params [API-007-003-001-0241] |
---|
Guideline ID | GUI-0011 |
---|
Author | @ |
---|
Document version | 1 |
---|
Document status | DRAFT |
---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
---|
Method API ID | API-007-003-001-0241 |
---|
Microservices (namespace) | ME |
---|
Component | Diagnostic Report Data Package |
---|
Component ID | COM-007-003 |
---|
Link на API-специфікацію | https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/diagnostic-report/get-diagnostic-report-by-search-params |
---|
Resource | {{host}}/api/patients/{{patient_id}}/diagnostic_reports |
---|
Scope | diagnostic_report:read |
---|
Protocol type | REST |
---|
Request type | GET |
---|
Sync/Async | Sync |
---|
Public/Private | Public |
---|
|
Purpose
This method is used to return the data of patient diagnostic reports to employees who have a signed declaration with this patient or work in the LE where this diagnostic report was created.
Logic
N/A
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
---|
1 | | | | | |
2 | | | | | |
Request structure
See on API-specification
Headers
Request data validation
Authorize
Request to process the request using a token in the headers
...
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 |
---|
| {
"meta": {
"code": 200,
"url": "http://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
"based_on (Reference_response, optional)": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "service_request"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"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": "final",
"code": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "service"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"category": [
{
"coding": [
{
"system": "eHealth/diagnostic_report_categories",
"code": "diagnostic_procedure"
}
]
}
],
"effective_period": {
"start": "2018-08-02T10:45:16.000Z",
"end": "2018-08-02T11:00:00.000Z"
},
"issued": "2018-10-08T09:46:37.694Z",
"conclusion": "At risk of osteoporotic fracture",
"conclusion_code": {
"coding": [
{
"system": "eHealth/ICD10_AM/condition_codes",
"code": "H04.2"
}
]
},
"recorded_by (Reference_response, required)": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "Опанасенко Олексій Володимирович"
},
"inserted_at": "2018-08-02T10:55:00.000Z",
"updated_at": "2018-08-02T10:55:00.000Z",
"encounter": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "encounter"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "null"
},
"origin_episode (Reference_response, optional)": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "episode"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
}
},
"division": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "division"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "Перше відділення обласної лікарня №1"
},
"managing_organization (Reference_response, optional)": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "patient"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "Київська обласна лікарня №1"
},
"results_interpreter": {
"reference": {
"identifier": {
"type": {
"coding": [
{
"system": "eHealth/resources",
"code": "employee"
}
]
},
"value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
},
"display_value": "Опанасенко Олексій Володимирович"
}
},
"primary_source": true,
"explanatory_letter": "Звіт був відмінений у зв'язку з помилкою при виборі пацієнта",
"cancellation_reason": {
"coding": [
{
"system": "eHealth/cancellation_reasons",
"code": "misspelling"
}
],
"text": ""
}
}
],
"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 | | 401 | Unauthorized | | |
4 | | 403 | Invalid scopes | | |
45 | Специфічні |
56 | | | | | |
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" |
---|
|
...