ЕСОЗ - публічна документація
[DRAFT] Get Diagnostic Report contexts [API-007-008-006-0289]
- Anzhela Kovalenko (SoE eHealth)
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
- 1 Properties of a REST API method document
- 2 Purpose
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Request structure
- 8 Headers
- 9 Request data validation
- 9.1 Authorize
- 10 Processing
- 11 Response structure examples
- 12 HTTP status codes
- 13 Post-processing processes
- 14 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] Get Diagnostic Report contexts [API-007-008-006-0289] |
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-006-0289 |
Microservices (namespace) | ME |
Component | Patient Summary |
Component ID | COM-007-008 |
Link на API-специфікацію | |
Resource | {{host}}/api/patients/{{patient_id}}/diagnostic_reports/{{diagnostic_report_id}}/context |
Scope | medical_event_context:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private | Public |
Purpose
This method allows to get contexts of Diagnostic Report in order to create approval on episode and receive access to other medical events.
Logic
Service returns contexts (episode and origin_episode), diagnostic report based on:
Get Diagnostic Report object by diagnostic_report_id from diagnostic_reports (MongoDB)
Get diagnostic_report.encounter.identifier from Diagnostic Report object
Call Get Encounter context :
Get Encounter object by diagnostic_report.encounter.identifier (diagnostic_report.encounter.identifier = encounter._id)
AFTERGet encounter.episode from Encounter object
Get diagnostic_report.origin_episode from Diagnostic Report object
Render a response according to specification
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | patient_id |
| String | Patient identifier |
|
| 2 | diagnostic_report_id |
| String | Diagnostic Report identifier |
|
Request structure
See on API-specification
Headers
Request data validation
Authorize
Verify the validity of access token
Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'medical_event_context:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: medical_event_context:read') in case of invalid scope(s)
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
| 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
Technical modules where the method is used
ЕСОЗ - публічна документація