Versions Compared

Old Version 2

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

Saved on

compared with

New Version 3

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

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-001006-001-001-00010216

Microservices (namespace)

MPIMC

Component

AuthCompositions

Component ID

COM-001006-001

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

https://ehealthmisapi1app.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-detailsswaggerhub.com/apis/ehealthua/compositions/Prod#/main/getPrintForm

Resource

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

Scope

Protocol type

Request type

Sync/Async

Public/Private

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

...

patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/printForm

Scope

composition:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

The method is designed for getting an HTML template of informational reference for print.

The template can be getted only by a user who has access to the MC.

The template can be getted by MC in any status (PRELIMINARY, FINAL, AMENDED, ENTERED_IN_ERROR).
Generation works by the MAN component.

Saving the generated content at the component level is not expected. If it is necessary to get the information reference again, then a new request is made and it is generated anew.

Used in processes:

Create/Sign composition (general process)

Extension / reduction MVTN

Refinement (preperson -> person) for MVTN

Creating "a replacement" composition

Logic

...

Configuration parameters

Link to configurable parameters

VAR_NAME: EMAL_PRINT_FORM_ALLOWED_TEMPLATE_IDS_BY_CATEGORY

  • “1001” for information reference by CATEGORIES of TYPE=TEMP_DISABILITY

  • “1000“ for information reference by CATEGORIES of TYPE=NEWBORN

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

composition_idcompositionId

 M 

String($uuid) (path)

Composition object ID

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

2

patientId

 

String($uuid) (path)

Patient object ID

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

3

episodeId

 

String($uuid) (path)

Episode of Care object ID

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

4

encounterId

 

String($uuid) (path)

Encounter object ID

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

5

templateId

1000, 1001

String(query)

ID of the template (man service) used to render the form

1000

Request structure

See on SwaggerHub (2.39.2)

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

Description of the REST API request structure, example

Expand
titleExample
Code Block
'/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/printForm':
    get:
      description: 'Отримання форми для друку'
      operationId: getPrintForm
      tags: [ 'main' ]
      parameters:
        - $ref: '#/components/parameters/compositionId'
        - $ref: '#/components/parameters/patientId'
        - $ref: '#/components/parameters/episodeId'
        - $ref: '#/components/parameters/encounterId'
        - in: query
          name: templateId
          required: true
          schema:
            type: string
          description: id шаблону (сервіс man), що використовується для рендерингу форми
          examples:
            newborn:
              value: "1000"
              description: приклад id шаблону для МВН
            disability:
              value: "1001"
              description: приклад id шаблону для МВТН

Headers

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer c2778f3064753ea70de870a53795f5c9

M

Перевірка користувача

{token}

Authorization: Bearer c2778f3064753ea70de870a53795f5c9{token}

3

api-key

{secret}

api-key: {secret}

Request data validation

Describe the process of checking the input data transmitted The compositionId in the request for compliance with the given rules and restrictions set in the APIis checked:

  • IF it is valid

    • THEN the process continues

    • ELSE an error 404 is returned.

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on SwaggerHub (2.39.2)

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

Description of the REST API response structure, example

Expand
titleExample
Code Block
      responses:
        '200':
          description: 'Форма присутня'
          content:
            text/plain:
              schema:
                type: string
                description: 'Тіло форми для друку'HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

 

 Form exists

3

401

Unauthorized

Помилка підтвердження

4

 404

 

 Form not found

5

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

Не знайдено медичний висновок

3

401

Unauthorized

Помилка підтвердження

46

Специфічні

57

422

Only for active MPI record can be created medication request!

Post-processing processes

Description of actions performed on data after processing

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"

...