Versions Compared

Old Version 13

changes.mady.by.user Mykhaylo Khapchyk (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

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
idpage_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-008-006-0288

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-search-params

Resource

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

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)https://e-health-ua.atlassian.net/wiki/spaces/~62e8c2165111209f4fde26af/database/18368102410?contentId=18368102410&entryId=d985fe71-1d31-44b3-bfd1-888e5691b685&fieldId=4d80d11c-30a5-4546-a64d-c06e7509fb2d

Dictionaries

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Unique MPI patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

2

issued_from

 

String

 

1990-01-01

3

issued_to

 

String

 

2017-01-01

4

code

String

Service code

12345

5

page

 

Number

Page number

2

6

page_size

 

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

Request structure

See on API-specification

Headers

See on 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

1

Базові

2

 200 

200

 

 Response

 

3

Специфічні

4

 

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)