Versions Compared

Old Version 4

changes.mady.by.user Anzhela Kovalenko (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.
REST API method / Метод REST API (настанова) (
Info
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 методу]DRAFT] Get Clinical Impression by id [API-007-004-002-0246]

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

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 ConfluenceN/A

Dictionaries

N/A

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

Expand
titleExample
Code Block
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer {{access_token}}
...
Authorization:Bearer {{access_token}}
...
API-key
...
{{secret}}
...
API-key:{{secret}}
Headers
Request data validation
Authorize
  • Verify the validity of access token
    • Return (401, 'Invalid access token') in case of validation fails
  • Verify that token is not expired
    • in case of error - return (401, 'Invalid access token')
  • Check user scopes in order to perform this action (scope = 'clinical_impression:read')
    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: clinical_impression:read') in case of invalid scope(s)
Access to the resource is also managed by ABAC module
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 APIN/A
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "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
403
 
Invalid scope
6
403
Your scope does not allow to access this resource. Missing allowances: clinical_impression:read
7
404
 not found
 
8
Специфічні
9
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...