Versions Compared

Key

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

REST API method / Метод REST API (настанова) (/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-004-002-0246

Microservices (namespace)

ME

Component

EDP

Component ID

COM-007-004

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

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

Resource

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

Scope

clinical_impression:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

...

  • 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

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 

String

Unique patient identifier

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

2

clinical_impression_id

 

String

Unique clinical impression identifie

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

...

  • 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

...

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"

...