Versions Compared

Old Version 1

changes.mady.by.user Serhii.Matiushyn

Saved on

compared with

New Version Current

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

Key

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

/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

[Document statusDRAFT] REST API [Назва методу] [ID методуNEW] Get Composition by id [API-007-011-001-0477]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-001007-001011-001-00010477

Microservices (namespace)

MPIME

Component

AuthCompositions_ME

Component ID

COM-001007-001011

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-details

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

Scope

Protocol type

REST

Request type

Sync/Async

Public/Private

Purpose

This method allows to get Composition in patient context by composition identifier. It is designed to provide access to Composition in case user has access to such Composition aсcording to ABAC rules

Key points

  1. Only authenticated and authorized employee with appropriate scope can use this method

  2. Method returns all information of Composition that belongs to the specified patient (exclude forbidden groups) context only in case user has access to such Composition aсcording to ABAC rules

  3. ABAC rules are used here:

    1. Employee with active declaration (declaration) - @rule_1

    2. Composition created in the employee's MSP (also author and attester) (recorder_legal_entity_id) - @rule_2

    3. Employee can read all the composition data of episodes created in the employee's MSP (also author) (context_episode_id) - @rule_3

    4. Employee with active approval can read all the data (including merged persons/prepersons data) of specified in approval patient - @rule_4

    5. Employee with active approval can read all the data of specified in approval episodes (context_episode_id) - @rule_5

    6. Employee with active approval can read all the data of specified in approval composition - @rule_18

Logic

Service logic

Service returns specified Composition related to the patient:

  • Get Composition by ID from compositions collection (MongoDB)

    • Check it exists in DB

      • Return 404 ('not found') in case of error

  • Validate data consistency:

    • Ensure that requested Composition relates to requested Patient (from URL)

      • Return 404 ('not found') in case of error

  • Render a response according to specification

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

Composition object ID

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

2

 

 

 

 

 

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Expand
titleExample
Code Block
Headers
...
Headers 
...
Request data validation
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
 
...
 
...
 
...
 
...
 
Request data validation
Authorization
  • Verify the validity of access token
    • in case of error - return 401 “Invalid access token” in case of validation fails
  • Verify that token is not expired
    • in case of error - return 401 “Invalid access token”
  • Check user and client scopes in order to perform this action (scope = 'composition:read')
    • return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)
  • Access to the resource is also managed by /wiki/spaces/emal/pages/18119196701
Validate Patient
  • Get Patient identifier from the URL
  • Check it exists in Mongo DB
    • Return 404 ('not found') in case of error
Validate Composition
  • Get Composition identifier from the URL
  • Check it exists in DB
    • Return 404 ('not found') in case of error
  • Check Composition belongs to patient
    • Return 403 ('forbidden') in case of error
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 Code Block
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1000
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
401
Invalid access token
3
 
401
Unauthorized
 
Помилка підтвердження
4
403
forbidden
54
403
Your scope does not allow to access this resource. Missing allowances: composition:read
65
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
7
404
not found
8
Специфічні
9
 
422
Only for active MPI record can be created medication request!
 
 
6
Специфічні
7
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Название
ID ТМ
Статус
/wiki/spaces/ESOZ/pages/17378181218
TM0112
/wiki/spaces/YK/pages/17837688354