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

Link	Swagger Link (2.39.2)
Resource	/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/printForm
Scope	composition:read
Components	Compositions
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal	Public

Logic

Configurable 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

Input parameters

Input parameter	Values	Type	Description	Example
compositionId		String($uuid) (path)	Composition object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
patientId		String($uuid) (path)	Patient object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
episodeId		String($uuid) (path)	Episode of Care object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
encounterId		String($uuid) (path)	Encounter object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59
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)

Example:

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

Authorize

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

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 404 is returned.

Processing

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

Example:

Response example

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

HTTP status codes

HTTP status code	Message	What caused the error
200		Form exists
404		Form not found