Versions Compared

Old Version 6

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-002-0281

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-clinical-impressions

Resource

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

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

Logic

Configuration parameters

N/A (Not applicable)

Dictionaries

  1. eHealth/clinical_impression_statuses(parameter “status“ in response)

  2. eHealth/clinical_impression_patient_categories(parameter “code“ in response)

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

  4. eHealth/resources - employee (parameter “asserter“ in response)

  5. eHealth/resources - clinical_impression (parameter “previous“ in response)

  6. eHealth/resources - condition(parameter “problems“ in response)

  7. eHealth/resources - condition | observation (parameter “findings“ in response)

  8. eHealth/resources - condition | observation | diagnostic_report | encounter (parameter “supporting_info“ 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

encounter_id

String

Identifier of the encounter in Clinical impression

7c3da506-804d-4550-8993-bf17f9ee0400.

3

episode_id

 

String

Identifier of the episode in Clinical impression

f48d1b6c-a021-4d6a-a5a4-aee93e152ecc

4

code

String

Clinical impression's code

insulin_1.

5

status

 

String

Clinical impression's status

completed

6

page

 

Number

Page number

2

7

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

 

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)