Purpose

Getting a form template for printing.

Specification

Link	Swagger Link (2.32.2)
Resource	/patients/{patientId}/composition/{compositionId}/episode/{episodeId}/encounter/{encounterId}/printForm
Scope	Scope для доступу
Components	API paragraph not found
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Async
Public/Private/Internal	Public

Preconditions*

Logic*

Global and configurable parameters*

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	22: 23:	String(query)	ID of the template (man service) used to render the form

Request structure

See on SwaggerHub (2.32.2)

Example:

Request 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 шаблону для МВТН

Headers

Content-Type: application/json
Authorization: Bearer {token}
api-key: {secret}

Request data validation*

Processing*

Response structure*

See on SwaggerHub (2.32.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