Versions Compared

Old Version 2

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова) (
Info
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (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
Sync/Async

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-001005-001008-001002-00010151

Microservices (namespace)

MPIIL

Component

AuthePrescription

Component ID

COM-001005-001008

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-detailsreimbursement/medication-request/get-medication-request-printout-form

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

Scope

Protocol type

Request type

/medication_requests/{{id}}/printout_form

Scope

medication_request:details

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

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 ConfluenceThis 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

No

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

compositionperson_id

 M

String ($uuid) (path)

Composition object ID

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

2

person_id of a patient

5e661b15-a39a-4713-b18e-ba03a4a48ecc

2

id

M

String

Medication request identifier

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
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
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 Sign Medication Request Request.
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 Code Block
{
  "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
Only for active MPI record can be created medication request!
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
1000401
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
3
401
Unauthorized
Помилка підтвердженняInvalid access token
Недійсний токен доступу
3
403
Your scope does not allow to access this resource. Missing allowances: medication_request:details
Для вашої ролі відсутній доступ до цього ресурсу. Необхідний доступ на отримання деталей рецепта
4
Специфічні
5
422
Post-processing processes
Description of actions performed on data after processingNo
Technical modules where the method is used
List of pages describing technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...