Versions Compared

Old Version 12

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

Saved on

compared with

New Version 13

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

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

/wiki/spaces/EN/pages/17591304241 (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

...

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

  2. eHealth/resources - episode (parameter “episode “ in response)

  3. eHealth/encounter_typesclasses (parameter “type“ “class“ in request / response)

  4. eHealth/encounter_classestypes (parameter “class“ “type“ in request / response)

  5. SPECIALITY_TYPE (parameter “performer_speciality“ in request / response)

Input parameters

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer {{access_token}}

M

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

Authorization:Bearer {{access_token}}

3

api-key

{{secret}}

 

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

api-key:{{secret}}

4

X-Custom-PSK

{{secret}}

 

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

X-Custom-PSK:{{secret}}A limit on the number of objects to be returned, between 1 and 100. Default: 50

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Patient Unique patient identifier

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

2

page

 

Number

Page number

23

page_size

 

Number

50

4

period_start_from

 

String

 

2017-01-01

53

period_start_to

 

String

 

2017-01-01

64

period_end_from

 

String

 

2017-01-01

75

period_end_to

 

String

 

2017-01-01

86

episode_id

String

Episode identifier

f48d1b6c-a021-4d6a-a5a4-aee93e152ecc

97

status

String

Encounter status

finished

108

type

String

Encounter type

discharge

119

class

String

Encounter class

INPATIENT

1210

performer_speciality

String

VIROLOGY

Request structure

See on API-specification

Headers

11

page

 

Number

Page number

2

12

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

Headers

See on Headers

Request data validation

Authorize

...

8

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

Response

3

401

Access token validation failed

4

401

Access token expired

5

403

 

Invalid scope

6

404

Patient not found

7

Специфічні

Post-processing processes

...