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

Skip to end of banner Go to start of banner

Get Clinical Impression by id [API-007-004-002-0246]

Skip to end of metadata

Created by Serhii Boldin (SoE eHealth), last modified by Anzhela Kovalenko (SoE eHealth) on Sep 25, 2024

Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

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://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/diagnostic-report/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

Purpose

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

Logic

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

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

Description of 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`

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Example

Headers

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer {{access_token}}			Authorization:Bearer {{access_token}}
3	API-key	{{secret}}			API-key:{{secret}}

Request data validation

Validate Patient

Get Patient identifier from the URL
Check it exists in DB
- Return 404 ('not found') in case of error

Validate Clinical impression

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 API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

Example

{
  "data": {
    "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
    "status": "completed",
    "description": "Some description of the clinical impression",
    "code": {
      "coding": [
        {
          "system": "eHealth/clinical_impression_patient_categories",
          "code": "insulin_1"
        }
      ]
    },
    "encounter": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "encounter"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "effective_date_time": "2018-08-02T10:45:16.000Z",
    "assessor": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "employee"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      },
      "display_value": "Петров Іван Іванович"
    },
    "previous": {
      "identifier": {
        "type": {
          "coding": [
            {
              "system": "eHealth/resources",
              "code": "clinical_impression"
            }
          ]
        },
        "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
      }
    },
    "problems": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "condition"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],
    "summary": "Some summary",
    "findings": [
      {
        "item_reference": {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition"
                }
              ]
            },
            "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
          }
        },
        "basis": "Some basis"
      }
    ],
    "supporting_info": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode_of_care"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],
    "note": "Some note",
    "inserted_at": "2018-08-02T10:55:00.000Z",
    "updated_at": "2018-08-02T10:55:00.000Z"
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200
3		401		Access token validation failed
4		401	Invalid access token
5		401	Unauthorized		Помилка підтвердження
6		403		Invalid scope
7		403	Your scope does not allow to access this resource. Missing allowances: clinical_impression:read
8	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок
9		404	not found
10	Специфічні
11		422	Only for active MPI record can be created medication request!

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

No labels

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