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

Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 7 Current »

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] REST API Get monitoring Justifications [API-005-010-003-0199]

Guideline ID

GUI-0011

Author

Viacheslav Tybin (SoE eHealth)

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-005-010-003-0199

Microservices (namespace)

IL

Component

Anti-fraud сabinets

Component ID

COM-005-010

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

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

Resource

{{host}}/api/cabinet/justifications

Scope

justification:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Private NHS

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

 Example
 

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

 Example
{
  "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

  • No labels