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

Table of Contents

Properties of a REST API method document

...

id	page_properties_method_REST API

...

Document type

...

Метод REST API

...

Document title

...

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

...

Guideline ID

...

GUI-0011

...

Author

...

@

...

Document version

...

1

...

Document status

...

DRAFT

...

Date of creation

...

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

...

Date of update

...

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

...

Method API ID

...

API-007-006-001-0268

...

Microservices (namespace)

...

ME

...

Component

...

Episode

...

Component ID

...

COM-007-006

...

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

...

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-episodes-by-search-params

...

Resource

...

{{host}}/api/patients/{{patient_id}}/episodes

...

Scope

...

episode:read

...

Protocol type

...

REST

...

Request type

...

GET

...

Sync/Async

...

Sync

...

Public/Private

...

Public

Purpose

This web service is designed to return episodes by search parameters.

Logic

Use period_from period_to to find episodes that were active in a certain period of time.

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

...

Input parameter

...

Mandatory

...

Type

...

Description

...

Example

...

Request structure

...

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	[DRAFT] REST API Get Episodes by search params [API-007-006-001-0268]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-006-001-0268
Microservices (namespace)	ME
Component	Episode
Component ID	COM-007-006
Link на API-специфікацію	https://ehealthmedicalevents975v12.docs.apiary.io/#reference/medical-events/episode-of-care/get-episodes-by-search-params
Resource	{{host}}/api/patients/{{patient_id}}/episodes
Scope	episode:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This web service is designed to return episodes by search parameters.

Logic

Use period_from period_to to find episodes that were active in a certain period of time.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Type	Description	Example
1	patient_id	string	Patient identifier	`70a9e15b-b71b-4caf-8f2e-ff247e8a5677`
2	period_from	string		`2017-01-01`
3	period_to	string		`2018-01-01`
4	code	string		`R80`
5	status	string		`active`
6	managing_organization_id	string		`80a9e15b-b71b-4caf-8f2e-ff247e8a5677`
7	page	number	Page number	2
8	page_size	number	A limit on the number of objects to be returned, between 1 and 100. Default: 50	50

Request structure

See on API-specification

Expand

title	Example

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

...

language	json

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Verify the validity of access token
- Return 401 in case validation fails
Verify token is not expired
- in case of error return 401
Check user scopes in order to perform this action (scope = 'episode:write')
- Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module.

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

title	Example

Code Block

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "90a9e15b-b71b-4caf-8f2e-ff247e8a5600",
      "inserted_at": "2018-08-02T10:45:16.000Z",
      "updated_at": "2018-08-02T10:45:16.000Z",
      "type": {
        "system": "eHealth/episode_types",
        "code": "primary_care"
      },
      "status": "active",
      "name": "Діабет 2018",
      "current_diagnoses": [
        {
          "condition": {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "system": "eHealth/resources",
                    "code": "condition"
                  }
                ]
              },
              "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
            },
            "display_value": "null"
          },
          "code": {
            "coding": [
              {
                "system": "eHealth/ICPC2/conditions",
                "code": "A20"
              }
            ]
          },
          "role": {
            "coding": [
              {
                "system": "eHealth/diagnosis_roles",
                "code": "CC"
              }
            ]
          },
          "rank": 1
        }
      ],
      "diagnoses_history": [
        {
          "date": "2018-08-02T10:45:16.000Z",
          "evidence": {
            "identifier": {
              "type": {
                "coding": [
                  {
                    "system": "eHealth/resources",
                    "code": "encounter"
                  }
                ]
              },
              "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
            },
            "display_value": "null"
          },
          "diagnoses": [
            {
              "condition": {
                "identifier": {
                  "type": {
                    "coding": [
                      {
                        "system": "eHealth/resources",
                        "code": "condition"
                      }
                    ]
                  },
                  "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
                },
                "display_value": "null"
              },
              "code": {
                "coding": [
                  {
                    "system": "eHealth/ICPC2/conditions",
                    "code": "A20"
                  }
                ]
              },
              "role": {
                "coding": [
                  {
                    "system": "eHealth/diagnosis_roles",
                    "code": "CC"
                  }
                ]
              },
              "rank": 1
            },
            {
              "condition": {
                "identifier": {
                  "type": {
                    "coding": [
                      {
                        "system": "eHealth/resources",
                        "code": "condition"
                      }
                    ]
                  },
                  "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
                },
                "display_value": "null"
              },
              "code": {
                "coding": [
                  {
                    "system": "eHealth/ICPC2/conditions",
                    "code": "A20"
                  }
                ]
              },
              "role": {
                "coding": [
                  {
                    "system": "eHealth/diagnosis_roles",
                    "code": "CC"
                  }
                ]
              },
              "rank": 1
            }
          ]
        }
      ],
      "status_history": [
        {
          "status": "active",
          "status reason": {
            "coding": [
              {
                "system": "eHealth/episode_closing_reasons",
                "code": "cured"
              }
            ]
          },
          "inserted_at": "2018-08-02T10:45:16.000Z"
        }
      ],
      "managing_organization": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "legal_entity"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "Медікал Солюшнc"
      },
      "period": {
        "start": "2018-08-02T10:45:16.000Z",
        "end": "2018-08-03T10:45:16.000Z"
      },
      "care_manager": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "employee"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      },
      "closing_summary": "Носові шляхи вільні, горло рожеве, температура в нормі",
      "status_reason": {
        "coding": [
          {
            "system": "eHealth/episode_closing_reasons",
            "code": "cured"
          }
        ]
      },
      "explanatory_letter": "Епізод був відмінений у зв'язку з помилкою при виборі пацієнта"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

Order by inserted_at
In case of searching by code:
1. select episode where ME.patients.episodes.current_diagnoses[*].code.coding[*].code == code(search param)

HTTP status codes

	Response code	HTTP Status code
1	Базові
2		200
3	Специфічні
4

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 6	New Version 13
Changes made by	Anastasiia Prokhorova (SoE eHealth) (Unlicensed)	Anzhela Kovalenko (SoE eHealth)
Saved on	Oct 31, 2024	Feb 19, 2025

Content Comparison

Versions Compared

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Headers

Request data validation

Authorize

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used