ЕСОЗ - публічна документація

[DRAFT] Get Diagnostic Report by id (Patient Summary) [API-007-008-006-0287]

Owned by Serhii Boldin (SoE eHealth)
Last updated: yesterday at 2:09 PM by Oksana Demchenko
1 min read

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

Get Diagnostic Report by id (Patient Summary) [API-007-008-006-0287]

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-0287

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

Link на API-специфікацію

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-diagnostic-report-by-id

Resource

{{host}}/api/patients/{{patient_id}}/summary/diagnostic_reports/{{diagnostic_report_id}}

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

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

N/A (Not applicable)

Dictionaries

  1. eHealth/resources - diagnostic_report(parameter “diagnostic_report_id“ in response)

  2. eHealth/resources - service_request (parameter “based_on“ in response)

  3. eHealth/diagnostic_report_statuses (parameter “status“ in request / response)

  4. eHealth/resources - service (parameter “code“ in request / response)

  5. eHealth/diagnostic_report_categories (parameter “category“ in response)

  6. eHealth/ICD10_AM/condition_codes (parameter “conclusion_code“ in response)

  7. eHealth/resources - specimen (parameter “specimens“ in response)

  8. eHealth/resources - equipment (parameter “used_references“ in response)

  9. eHealth/resources - employee (parameter “recorded_by“ in response)

  10. eHealth/resources - encounter (parameter “encounter“ in response)

  11. eHealth/resources - episode (parameter “origin_episode“ in response)

  12. eHealth/resources - division (parameter “division“ in response)

  13. eHealth/resources - legal_enity (parameter “managing_organization“ in response)

  14. eHealth/resources - employee (parameter “performer“ in response)

  15. eHealth/report_origins (parameter “report_origin“ in response)

  16. eHealth/resources - employee (parameter “results_interpreter“ in response)

  17. eHealth/cancellation_reasons (parameter “cancellation_reason“ in response)

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Unique MPI patient identifier

e549c257-232e-4dab-9f1e-b2322cac3968

2

diagnostic_report_id

 M

String

Unique DR identifier

340b86fd-23f3-4a33-94c5-8ec19d116c33

Request structure

See on API-specification

Headers

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

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

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 (Not applicable)

Technical modules where the method is used

N/A (Not applicable)

 

ЕСОЗ - публічна документація