Versions Compared

Version Old Version 3 New Version Current
Changes made by

Anzhela Kovalenko (SoE eHealth)

Natalia Hanaha

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

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

...

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

REST API Get Medication Request Printout Form [API-005-008-002-0151]

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 ConfluenceN/A

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

person_id

 

 M

String

person_id of a patient

. Required.

5e661b15-a39a-4713-b18e-ba03a4a48ecc

2

id

M

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

Expand
titleExample
Code Block
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
Perform Get medication requests details with corresponding validationsHeaders
Request data validation
Perform Get medication requests details with corresponding validations.
Authorize
  • Verify the validity of access token
    • 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 scopes in order to perform this action (scope = 'medication_request:details')
    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: medication_request:details') in case of invalid scope(s).
Access to the resource is also managed by ABAC rules (EN) .
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-1f1e6 Sign Medication Request Request.
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example
 Expand
titleExample
 Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "printout_form": "Medication request content"
  }
}
HTTP status codes
3
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
Response
 
5
401
Invalid access token
 
4
401
Unauthorized
Помилка підтвердження
Недійсний токен доступу
3
403
Your scope does not allow to access this resource. Missing allowances: medication_request:details
6
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
7
Специфічні
8
422
Only for active MPI record can be created medication request!
Для вашої ролі відсутній доступ до цього ресурсу. Необхідний доступ на отримання деталей рецепта
4
Специфічні
5
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
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...