/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 Configurations by search params [API-007-011-001-0480]
Guideline ID	GUI-0011
Author	@Mariana Veremeieva (UA SoE eHealth)
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-001007-001011-001-00010480
Microservices (namespace)	MPIME
Component	AuthCompositions_ME
Component ID	COM-001007-001011
Link на API-специфікацію	https://ehealthmisapi1ehealthmedicalevents991v11.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-detailsevents/composition/get-composition-configurations-by-search-params
Resource	{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_packagecomposition_configurations?type=DRIVERS&category=DRIVERS_GROUP1&page=2&page_size=50
Scope	composition:read
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private	Public

Purpose

This method allows to get composition_configurations that are used for request validation on Create Submit Composition method.

Logic

Service logic

Select composition_configurations records from PRM filtered by type and category from the request
Exclude from composition_configurations.settings json elements where check = “Any”
Return response to the client according to schema

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_idtype	MM	String ($uuid) (path)	Composition object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59	type of the Composition	DRIVERS
2	category	M	String		category of Composition	DRIVERS_GROUP1

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

...

title	Example

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

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)

Validate query parameters

Validate required query parameter type is filled
1. Return 422 ("Required query parameter type is missing”value is not allowed in enum”) in case of error
Validate value in query parameter type is fromCOMPOSITION_TYPES dictionary
1. Return 422 ("Incorrect value for query parameter typevalue is not allowed in enum") in case of error
Validate required query parameter category is filled
1. Return 422 ("Required query parameter category is missing”value is not allowed in enum”) in case of error
Validate value in query parameter category is fromCOMPOSITION_CATEGORIES dictionary
1. Return 422 ("Incorrect value for query parameter category”value is not allowed in enum”) 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

title	Example

Code Block

{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "2017-04-20T19:14:13Z",
      "type": {
        "coding": [
          {
            "system": "COMPOSITION_TYPES",
            "code": "DRIVERS"
          }
        ]
      },
      "category": {
        "coding": [
          {
            "system": "COMPOSITION_CATEGORIES",
            "code": "DRIVERS_GROUP1"
          }
        ]
      },
      "is_active": true,
      "settings": "{ \"COMPOSITION_PERSON_GENDER\": { \"check\": [ \"female\", \"male\" ] }, \"COMPOSITION_SECTION_EMPTY_REASON\": { \"check\": [\"NILKNOWN\", \"NOTASKED\", \"WITHHELD\", \"UNAVAILABLE\", \"CLOSED\"] }, \"COMPOSITION_SECTION_NESTING_LEVEL\": { \"check\": 5 }, \"COMPOSITION_SECTION_COUNT_LIMIT\": { \"check\": 100 }, \"COMPOSITION_SECTION_ORDERBY\": { \"check\": [ \"USER\", \"SYSTEM\", \"EVENT-DATE\", \"ALPHABETIC\", \"CATEGORY\" ] }, \"COMPOSITION_DRIVER_RELATED_CODES\": [ { \"condition\": { \"code\": \"01.\", \"system\": \"eHealth/composition_additional_condition_admission\" }, \"check\": [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\", \"g\"] }, { \"condition\": { \"code\": \"01.01.\", \"system\": \"eHealth/composition_additional_condition_admission\" }, \"check\": [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\", \"g\"] }, { \"condition\": { \"code\": \"01.02.\", \"system\": \"eHealth/composition_additional_condition_admission\" }, \"check\": [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\", \"g\"] }]}",
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2018-08-02T10:45:16.000Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		401	Invalid access token
3		401	Unauthorized		Помилка підтвердження	4	403	Your scope does not allow to access this resource. Missing allowances: composition:read
5	1000	404	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок

6	4		422	Incorrect value for query parameter `type`
75		422	Incorrect value for query parameter category
86		422	Required query parameter `type` is missing
97	Специфічні
10		422	Only for active MPI record can be created medication request!		8

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

Version	Old Version 1	New Version Current
Changes made by	Serhii.Matiushyn	Mariana Veremeieva (UA SoE eHealth)
Saved on	Dec 11, 2024	Jan 27, 2025

Page Comparison

Versions Compared

Key

Properties of a REST API method document

Purpose

Logic

Service logic

Configuration parameters

Dictionaries

Input parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Headers

Request data validation

Authorization

Validate query parameters

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Technical modules where the method is used