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

Properties of a REST API method document

Document type	Метод REST API
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-005-008-002-0151
Microservices (namespace)	IL
Component	ePrescription
Component ID	COM-005-008
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/medication-request/get-medication-request-printout-form
Resource	{{host}}/api/medication_requests/{{id}}/printout_form
Scope	medication_request:details
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This WS allows to generate Printout form by medication request id.

Logic

Технічний опис бізнес-процесу виписування рецепту в ЕСОЗ (загальний процес для усіх рецептурних ЛЗ, в т.ч. і тих, які підлягають реімбурсації)

Процеси роботи з випискою електронних рецептів

Configuration parameters

Access to the method is defined by the scope medication_request:details. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.

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	person_id		String	person_id of a patient. Required.	5e661b15-a39a-4713-b18e-ba03a4a48ecc
2	id		String	Medication request identifier. Required.	d290f1ee-6c54-4b01-90e6-d701748f0851

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

Perform Get medication requests details with corresponding validations.

Processing

Get Medication request by ID

Perform Get medication requests details with corresponding validations.

Generate Printout form

Invoke MAN to render printout form.
Request mapping:

Parameter	Source
id	MEDICATION_REQUEST_REQUEST_PRINTOUT_FORM_TEMPLATE_ID

Logic of generation of fields for the printout form is described in 1f1fa-1f1e6Sign Medication Request Request.

Response structure examples