Properties of a REST API method document

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

No

Input parameters

Description of input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

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:

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

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

Post-processing processes

No

Technical modules where the method is used

List of pages describing technical modules where the method is used

...