Versions Compared

Old Version 4

changes.mady.by.user Iryna Lishtaba (SoE eHealth)

Saved on

compared with

New Version 5

changes.mady.by.user Oksana Demchenko

Saved on

Key

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

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

...

Page Properties
idpage_properties_method_REST API

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

...

Dictionaries

No

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

person_id

 M

String

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
...
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
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"
  }
}
...
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
401
Invalid access token
Недійсний токен доступу
3
403
Your scope does not allow to access this resource. Missing allowances: medication_request:details
Для вашої ролі відсутній доступ до цього ресурсу. Необхідний доступ на отримання деталей рецепта
4
Специфічні
5
Post-processing processes
No
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"
...