Versions Compared

Version Old Version 13 New Version 14
Changes made by

Anzhela Kovalenko (SoE eHealth)

Mykhaylo Khapchyk (SoE eHealth)

Saved on

Key

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

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Get Short Encounter by id [API-007-008-007-0290]

Guideline ID

GUI-0011

Author

@Mykhaylo Khapchyk (SoE eHealth)

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

Sync

Public/Private

Public

Purpose

Return single short Encounter info

Logic

The endpoint returns single short Encounter infoThis web service is designed to return of short encounter info for a specified patient.

Logic

N/A (Not applicable)

Configuration parameters

N/A (Not applicable)

Dictionaries

  1. eHealth/resources - patient (parameter “patient_id“ in request)

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

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

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

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

  6. eHealth/encounter_types (parameter “type“ in response)

  7. SPECIALITY_TYPE (parameter “performer“performer_speciality“ speciality“ in response)

Input parameters

...

Request structure

See on API-specification

...

titleExample

...

Headers

See on Headers

Request data validation

...

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 401401 

Validate scopes

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

    1. Return 403 in case invalid scope(s)

Access to the resource is also managed by ABAC module.

Validate patient

  • Validate patient exists in MongoDB

    • In case of error return 404 not found

Processing

...

  1. Get encounter by ID

  2. Ensure that requested encounter relates to requested Patient

  3. Filter using Forbidden Groups

  4. Render a response according to specification

Response structure examples

See on API-specification

...

titleExample

...

languagejson

...

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

Your scope does not allow to access this resource. Missing allowances: patient_summary:read 

Forbiden

 

6

 

 Invalid scope

403

Access denied

Forbiden

 

6
7

 

404

 

 Patient not

Not found

 

7
8

Специфічні

Post-processing processes

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)