Versions Compared

Key

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

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the 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-0280

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-clinical-impression-by-id

Resource

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

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

SyncAsync

Public/Private

Public

Purpose

This method allows to get detailed information of the patient’s Clinical impression.

Logic

Service logic

Service returns specified Clinical impression related to the patient:

...

...

Validate data consistency:

  • Ensure that requested Clinical impression relates to requested Patient (from URL)

    • Return 404 ('not found') in case of error

...

Render a response according to specification

Configuration parameters

...

parameters

...

Dictionaries

...

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Unique MPI patient identifier

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

2

clinical_impression_id

 

String

Unique Clinical impression identifier

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

Request structure

See on API-specification

...

titleExample

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer mF_9.B5f-4.1JqM

...

Authorization:Bearer mF_9.B5f-4.1JqM

Headers

See on Headers

Request data validation

Authorize

...

  • Get Clinical impression identifier from the URL

  • Check it exists in DB

    • Return 404 ('not found') in case of error

  • Check Clinical impression belongs to patient

    • Return 404 ('not found') in case of error

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 Apiary

See on API-specification

...

titleExample

...

Service returns specified Clinical impression related to the patient:

  • Get Clinical impression by ID from clinical_impression collection (MongoDB)

  • Validate data consistency:

    • Ensure that requested Clinical impression relates to requested Patient (from URL)

      • Return 404 ('not found') in case of error

  • Render a response according to specification

Response structure examples

See on API-specification

HTTP status codes

7

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 200200

3

401

Invalid access token

4

403

Your scope does not allow to access this resource. Missing allowances: clinical_impression:read

5

404

not found

6

Специфічні

Post-processing processes

Description of actions performed on data after processingN/A (Not applicable)

Technical modules where the method is used

List of pages describing technical modules where the method is used

...

N/A (Not applicable)