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

Specification

Logic

Configurable parameters

Link to configurable parameters

VAR_NAME: EMAL_PRINT_FORM_ALLOWED_TEMPLATE_IDS_BY_CATEGORY

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

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

Input parameters

Request structure

See on SwaggerHub (2.32.2)

Example:

'/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: "20"
              description: приклад id шаблону для МВН
            disability:
              value: "21"
              description: приклад id шаблону для МВТН

Authorize

Check user scopes in order to perform this action (scope = 'composition:search')

• return 401 (Unauthorized) in case of invalid scope(s)

Headers

• Content-Type: application/json

• Authorization: Bearer {token}

• api-key: {secret}

Request data validation

The compositionId in the request is checked:

• IF it is valid

  • THEN the process continues

  • ELSE an error is returned.

Processing

1. Before collecting data from the composition, access to the composition according to the data from the request is checked:

   1. IF access allowed

      1. THEN data collect

      2. ELSE access error message

2. After requesting a template from the MAN component, the response is checked:

   1. IF template received in response

      1. THEN print form generated in response to MIS

      2. ELSE template error message

Response structure

See on SwaggerHub (2.32.2)

Example:

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

HTTP status codes