ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Current »

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] REST API Get Short Episodes by search params [API-007-008-008-0291

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-006-001-0268

Microservices (namespace)

ME

Component

Patient Summary

Component ID

COM-007-006

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

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

Resource

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

Scope

patient_summary:read

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

Return brief information in order not to disclose confidential and sensitive data.

Logic

This web service returns brief information in order not to disclose confidential and sensitive data. Access to full episode data is restricted by patient's approval. If you have an approval - you can obtain episode details and nested entities through /episode/:id/* web services.

Configuration parameters

N/A (Not applicable)

Dictionaries

  1. eHealth/episode_statuses (parameter “status“ in response)

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

patient_id

 M

String

Unique MPI patient identifier

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

2

period_start_from

 

String

 

2017-01-01

3

period_start_to

String

2017-01-01

4

period_end_from

String

2017-01-01

5

period_end_to

String

2017-01-01

6

page

 

Number

Page number

2

7

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

Validate token

  1. Verify the validity of access token

    1. Return 401 in case validation fails

  2. Verify token is not expired

    1. in case error return 401

Validate scopes

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

    1. Return 403 in case invalid scope(s)

Validate patient

  1. Validate patient exists in MongoDB

    1. In case of error return 404 not found

Processing

  1. Get all patient's episodes

  2. Filter using Forbidden Groups

  3. Apply filters provided by user

  4. Render reduced episode data

Response structure examples

See on API-specification

HTTP status codes

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

N/A (Not applicable)

Technical modules where the method is used

N/A (Not applicable)

  • No labels

ЕСОЗ - публічна документація