Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

...

Purpose*

...

Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

Return episodes, that patient gave approvals to read by a current employee.

Specification*

Page Properties

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-approved-episodes

Resource

/api/patients/{{patient_id}}/episodes/approved

Scope

episode:read

Components

API paragraph not found

Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Logic*

This web service returns episodes, that patient gave approvals to read by a current employee.

Specification*

...

Link

...

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/episode-of-care/get-approved-episodes

...

Resource

...

/api/patients/{{patient_id}}/episodes/approved

...

Scope

...

episode:read

...

Components

...

API paragraph not found

...

Filters

Filter

Values

Type

Description

Example

patient_id

String

Patient identifier

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

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 100. Default: 50

50

code

String

current diagnosis code

R80

Request structure*

API paragraph not found

...

Protocol type

...

REST

...

Request type

...

GET

...

Sync/Async

...

Async

Logic*

This web service returns episodes, that patient gave approvals to read by a current employee.

Filters

...

Filter

...

Values

...

Type

...

Description

...

Example

...

patient_id

...

String

...

Patient identifier

...

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

...

page

...

Number

...

Page number

...

2

...

page_size

...

Number

...

A limit on the number of objects to be returned, between 1 and 100. Default: 50

...

50

...

code

...

String

...

current diagnosis code

...

R80

Request structure*

API paragraph not found

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

  • api-key:aFBLVTZ6Z2dON1V

Request data validation*

API paragraph not found

Processing*

...

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer mF_9.B5f-4.1JqM

  • api-key:aFBLVTZ6Z2dON1V

Request data validation*

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 = 'episode:read')

    1. Return 403 in case invalid scope(s)

Processing*

  1. Select list of employees from PRM related to the current user in the current legal_entity, using data from the token

  2. Select all active approvals from Medical Events, where these employees referenced as a `granted_to`

  3. Select all the episodes from ME that are referenced as `granted resources` in the approvals from step 2. 

  4. Show episodes to the client ordered by inserted_at

Response structure*

See on Apiary

...