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

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

Owned by Mykhailo Troinin (SoE eHealth) (Unlicensed)

Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)

1 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

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

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

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

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

	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

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