/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 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-011-001-0477
Microservices (namespace)	MPI
Component	Auth
Component ID	COM-007-011
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

Only authenticated and authorized employee with appropriate scope can use this method
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
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 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

Example

Headers

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer c2778f3064753ea70de870a53795f5c9	M	Перевірка користувача	Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3

Request data validation

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 API

Response structure examples