Versions Compared

Old Version 5

changes.mady.by.user Mykhaylo Khapchyk (SoE eHealth)

Saved on

compared with

New Version 6

changes.mady.by.user Mykhaylo Khapchyk (SoE eHealth)

Saved on

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)

...

Page Properties
idpage_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-008-007-0289

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-008

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

https://medicaleventsmisapi.docs.apiary.io/#reference/medical-events/patient-summary/get-short-encounters-by-search-params

Resource

{{host}}/api/patients/{{patient_id}}/summary/encounters

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

...

N/A (Not applicable)

Dictionaries

  1. eHealth/encounter_statuses (parameter “status“ in request / response)

  2. eHealth/encounter_types (parameter “type“ in request / response):

  3. eHealth/encounter_classes (parameter “class“ in request / response):

  4. SPECIALITY_TYPE (parameter “performer_speciality“ in request / response):

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Patient identifier

70a9e15b-b71b-4caf-8f2e-ff247e8a5677

2

page

 

Number

Page number

2

3

page_size

 

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

4

period_start_from

 

String

 

2017-01-01

5

period_start_to

 

String

 

2017-01-01

6

period_end_from

 

String

 

2017-01-01

7

period_end_to

 

String

 

2017-01-01

8

episode_id

String

f48d1b6c-a021-4d6a-a5a4-aee93e152ecc

9

status

String

finished

10

type

String

discharge

11

class

String

INPATIENT

12

performer_speciality

String

VIROLOGY

Request structure

See on API-specification

Headers

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer mF_9.B5f-4.1JqM{{access_token}}

M

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

Authorization:Bearer mF_9.B5f-4.1JqM{{access_token}}

3

api-keyaFBLVTZ6Z2dON1V

{{secret}}

 

Секретний ключ

api-key:aFBLVTZ6Z2dON1V{{secret}}

4

X-Custom-PSK

{{secret}}

 

Секретний ключ МІС

X-Custom-PSK:{{secret}}

Request data validation

Validate token

...

  1. Get all patient's encounters

  2. Filter using Forbidden Groups

  3. Apply filters provided by user

Response structure examples

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

Expand
titleExample
Code Block
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "465fb6fe-2dea-4b8a-9ef7-58379d1eaab0",
      "status": "finised",
      "date": "2018-08-02T10:45:16.000Z",
      "episode": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      },
      "class": {
        "system": "eHealth/encounter_classes",
        "code": "inpatient"
      },
      "type": {
        "coding": [
          {
            "system": "eHealth/encounter_types",
            "code": "discharge"
          }
        ]
      },
      "performer_speciality": {
        "coding": [
          {
            "system": "SPECIALITY_TYPE",
            "code": "VIROLOGY"
          }
        ]
      }
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

...

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

3

401

Unauthorized

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

4

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

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

5

Специфічні

6

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 modules where the method is used

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

...