/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-001-001-001-0001
Microservices (namespace)	MPI
Component	Auth
Component ID	COM-001-001
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 WS allows to create a unique requisition number that can be later used as a Composition title in Create Composition method. Generated requisition number is stored in ME database until it is expired.

Logic

Service logic

Generate requisition number using Human readable requisition number algorithm based on patient_id
Use prefix from configuration instead of first 4 symbols: {{composition_type}}_TITLE_PREFIX (ex. ADOPTION_TITLE_PREFIX) If prefix can't be get from chart-parameters Return 500 error
Check that there is no Composition in ME.Compositions collection with such title
1. if it already exists generate new requisition as it is described in https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402257/Human+readable+requisition+number#Solution section
Check that there is no record in ME.requisition_number with such requisition
1. if it already exists generate new requisition as it is described in https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/583402257/Human+readable+requisition+number#Solution section
Save generated title in ME.requisition_number
1. requisition_number = generated requisition
2. patient_id = patient id from the request
3. expiration_date = current datetime + COMPOSITION_TITLE_EXPIRATION_PERIOD (config parameter in ehealth.charts)
4. composition_type = composition_type from query parameters

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 composition_type is COMPOSITION_TYPES dictionary
1. in case of error - return 422 ('value is not allowed in enum')
Check that сomposition_type is NOT from COMPOSITION_TYPE_BLACK_LIST
1. Return 422 ("сomposition_type is not allowed by configuration") 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