Versions Compared

Key

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

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

Table of Contents

Properties of a REST API method document

Автор
Page Properties
idENT-005-011-003

ID метода

API-005-011-003-0195

page_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

Viacheslav Tybin (SoE eHealth)

Версія документа

Document version

1

.0

Статус документа

Document status

title

DRAFT

draft

Назва метода (укр.)

Отримати обґрунтування моніторингу

Назва метода (eng.)

Get monitoring Justifications

Короткий опис метода

Для отримання інформації щодо обґрунтування моніторингу персональних та медичних даних пацієнта співробітниками NHS (не лікарями).

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-001-001-001-0001

Microservices (namespace)

MPI

Component

Auth

Component ID

COM-001-001

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-patient-cabinet/cabinet/get-monitoring-justifications

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

Scope

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Purpose

Use this method to get information about justification for monitoring patient's personal and medical data by NHS employees (not medical employees as doctors)

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block

Headers

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

N/A

Response structure examples

See on API-specification

Expand
titleExample
Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "b94893f5-b66b-4431-b023-d5b5c037caef",
      "expires_at": "2021-11-10T18:23:34.217Z",
      "consumer": {
        "client_id": "b94893f5-b66b-4431-b023-d5b5c037cae1",
        "client_name": "Національна служба здоров'я України"
      },
      "reason": "Просмотр медичних даних пацієнта Олександрова Олександра Володимировича 12.12.2012 р.н згідно судового рішення №АБ-23234234-434",
      "reason_type": {
        "coding": [
          {
            "system": "eHealth/justification_reason_types",
            "code": "default"
          }
        ],
        "text": "Інше"
      },
      "status": "active",
      "inserted_at": "2021-11-09T00:00:00.000Z",
      "updated_at": "2021-11-09T00:00:00.000Z"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

Response

3

4

Специфічні

5

Post-processing processes

N/A

Technical modules where the method is used

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