Versions Compared

Old Version 4

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

Saved on

compared with

New Version Current

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

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова) (
Info
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document statusDRAFT] REST API [Назва методу] [ID методу]getPrintForm [API-006-001-001-0216]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-006-001-001-0216

Microservices (namespace)

MC

Component

Compositions

Component ID

COM-006-001

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

https://app.swaggerhub.com/apis/ehealthua/compositions/Prod#/main/getPrintForm

Resource

{{host}}/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 by MC in any status (PRELIMINARY, FINAL, AMENDED, ENTERED_IN_ERROR).
Generation works by the MAN component.

...

Creating "a replacement" composition

Logic

...

Configuration parameters

Link to configurable parameters

...

  • “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 ConfluenceN/A

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

compositionId

 

String($uuid) (path)

Composition object ID

 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
languagejson
'/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

...

Headers

...

Request data validation

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer {token}

...

Authorization: Bearer {token}

...

api-key

...

{secret}

...

api-key: {secret}

Request data validation

Authorize

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

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

The compositionId in the request is 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 APIN/A

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
languagejson
      responses:
        '200':
          description: 'Форма присутня'
          content:
            text/plain:
              schema:
                type: string
                description: 'Тіло форми для друку'HTTP status codes

HTTP status codes

Unauthorized

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

 

 Form exists

3

401

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

4

 404

 

 Form not found

5

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

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

6

Специфічні

7

422

Only for active MPI record can be created medication request!

4

Специфічні

5

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"

...