/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] [NEW] Get Composition by search params [API-007-011-001-0476]
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-0476
Microservices (namespace)	ME
Component	Compositions_ME
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 a list of Composition in patient context. Also, this list can be filtered using search parameters.

Key points

Only authenticated and authorized employee with appropriate scope can use this method
Method returns a short information of Compositions that belongs to the specified patient.
List can be filtered by search params.

Logic

Service logic

Service returns all Compositions related to the patient, filtered by submitted parameters:

Get all Composition by subject from compositions collection (MongoDB)
Filter list above by submitted search parameters
Render a response according to specification with a list of found Composition entities.

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

Search params

All search params are optional. Search with a few params executes according to the logical AND rule.

encounter_id
- filter list by composition.encounter.identifier.value
context_episode_id
- filter list by episode of care - composition.context_episode_id
type
- filter list by composition.type.coding[*].code
category
- filter list by composition.category.coding[*].code
title
- filter list by composition.title
status
- filter list by composition.status
author
- filter list by composition.author.identifier.value
attester
- filter list by composition.attester.party.value
custodian
- filter list by composition.custodian.identifier.value
date_from
- filter list by $.date_from <= composition.date
date_to
- filter list by $.date_to >= composition.date
page
- filter list by page number
page_size
- a limit on the number of objects to be returned, between 1 and 100. Default: 50

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples