ЕСОЗ - публічна документація

Get Medication request printout form

Owned by Dmytro Kulibaba (Unlicensed)
Last updated: Feb 13, 2023 by Iryna Lishtaba (SoE eHealth)
2 min read

Purpose

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

Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/medication-request/get-medication-request-printout-form

Посилання на Apiary або Swagger

Resource

/api/persons/{{person_id}}/medication_requests/{{id}}/printout_form

Посилання на ресурс, наприклад: /api/persons/create

Scope

medication_request:details

Scope для доступу

Components

ePrescription

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

 

Logic

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

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

Preconditions

No

Global and configurable parameters

No

Input parameters

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

person_id

 

String

person_id of a patient. Required.

5e661b15-a39a-4713-b18e-ba03a4a48ecc

id

 

String

Medication request identifier. Required.

d290f1ee-6c54-4b01-90e6-d701748f0851

Filters

No

Request structure

API paragraph not found

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) .

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Validate request

API paragraph not found

Request data validation

Perform Get medication requests details with corresponding validations.

Parameters that are used when processing the request

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.

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

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

See on Apiary

Example:

{ "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" } }

Post-processing processes

No

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

200

Response

 

401

Invalid access token

 

403

Your scope does not allow to access this resource. Missing allowances: medication_request:details

 

Backward compatibility

API paragraph not found

ЕСОЗ - публічна документація