Versions Compared

Old Version 5

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

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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
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

Purpose

Return single short Encounter info

Logic

The endpoint returns single short Encounter info

Configuration parameters

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 “type“ in response)

  6. SPECIALITY_TYPE (parameter “performer_speciality“ in response)

Input

...

parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Unique patient identifier

e549c257-232e-4dab-9f1e-b2322cac3968

2

encounter_id

 M

String

Unique encounter identifier

340b86fd-23f3-4a33-94c5-8ec19d116c33

Request structure

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

Request data validation

See on Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Validate token

  • Verify the validity of access token

    • Return 401 in case validation fails

  • Verify token is not expired

    • in case error return 401

Validate scopes

  • Check user scopes in order to perform this action (scope = 'patient_summary:read')

    1. Return 403 in case invalid scope(s)

Validate patient

  • 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

...

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

Expand
titleExample
Code Block
{
  "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"
        }
      ]
    }
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

 

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

 

 

78

Специфічні

9

 

 

 

 

Post-processing processes

Description of actions performed on data after processingN/A (Not applicable)

Technical modules where the method is used

List of pages describing technical modules where the method is used

...

N/A (Not applicable)