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-0290

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-encounter-by-id

Resource

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

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

...

N/A (Not applicable)

Dictionaries

  1. eHealth/resources - encounter(parameter “encounter_id“ in request)

  2. eHealth/encounter_statuses (parameter “status“ in response)

  3. eHealth/encounter_typesresources - episode (parameter “typeepisode “ in response)

  4. eHealth/encounter_classes (parameter “class“ in response)

  5. eHealth/encounter_types (parameter “typein response)

  6. SPECIALITY_TYPE (parameter “performer_speciality“ in response)

...

See on API-specification

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer {{access_token}}

...

M

...

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

...

Authorization:Bearer {{access_token}}

...

api-key

...

{{secret}}

...

 

...

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

...

api-key:{{secret}}

...

X-Custom-PSK

...

{{secret}}

...

 

...

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

...

X-Custom-PSK:{{secret}}

See on Headers

Request data validation

Authorize

...

  • Validate patient exists in MongoDB

    • In case of error return 404 not found

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

...

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

Response Response

 

 

3

 

401

 

Access token validation failed

 

4

 

401

 

Access token expired

 

5

 

403

 

 

Invalid  Invalid scope

 

6

 

404

Patient  Patient not found 

 

7

Специфічні

Post-processing processes

...