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

id	page_properties_method_REST API

Document type	Метод REST API
Document title	[Document statusDRAFT] REST API [Назва методу] [ID методуGet events by ID [API-003-001-001-0011]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-003-001-001-0011
Microservices (namespace)	EM
Component	Event manager
Component ID	COM-003-001
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-event-manager/get-events-by-id/get-events-by-id
Resource	{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package/events/{{id}}
Scope	event:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

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 This method is used to obtain events by id

Logic

N/A

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example
1

composition_

id

M

String

($uuid) (path)

Composition object ID

89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

	Required	a89f6a26-4221-4597-a1d2-542d5e40b565
2

Request structure

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

Description of the REST API request structure, example

Expand

title	Example

Code Block

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

...

language	json

Headers

Request data validation

N/A

Processing

N/A

Response structure examples

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

Description of the REST API response structure, example

Expand

title	Example

Code Block

language	json

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "event_type": "StatusChangeEvent",
      "entity_type": "MedicationDispense",
      "entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "properties": {
        "status": {
          "new_value": "COMPLETED"
        },
        "employee_id": {
          "new_value": "e1453f4c-1077-4e85-8c98-c13ffca0063e"
        }
      },
      "event_time": "2017-04-20T19:14:13Z",
      "changed_by": "df9f70ee-4b12-4740-b0f5-bb5aea116863"
    }
  ]
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2

10003

401

Unauthorized

Помилка підтвердження

200

404

Composition not found

COMPOSITION_NOT_FOUND_404

Не знайдено медичний висновок

Response
3
4	Специфічні
5

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

Technical modules where the method is used

Page Properties Report

headings	ID ТМ, Статус
cql	label = "tr-mis"

...

Version	Old Version 4	New Version Current
Changes made by	Anzhela Kovalenko (SoE eHealth)	Anzhela Kovalenko (SoE eHealth)
Saved on	Jun 25, 2024	Jan 03, 2025

Page Comparison

Versions Compared

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Processing

Headers

Request data validation

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used