REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] [NEW] Get Encounter details in Composition context [API-007-011-001-0483]
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-0483
Microservices (namespace)	ME
Component	Compositions_ME
Component ID	COM-007-011
Link на API-специфікацію	GENERAL MIS API · Apiary
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 single Encounter by its identifier using Composition context. It is designed to provide access to resources mentioned in Composition in case user has active Approval to such Composition.

Key points

Only authenticated and authorized employee with appropriate scope can use this method
Method returns a single Encounter via Composition context only in case user has active Approval to such Composition
ABAC rules are used here
1. Employee with active approval can read all the data of specified in approval composition - @rule_18

Logic

Service logic

Service returns specified Encounter related to the patient:

Get Encounter from encounters collection (MongoDB)
- Check it exists in DB
  - Return 404 ('not found') in case of error
- Check Encounter belongs to the patient
  - Return 403 ('forbidden') in case of error
Render response according to specification

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

Headers

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 ABAC module

Validate Patient

Get Patient identifier from the URL
Check it exists in 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

N/A

Response structure examples