Versions Compared

Old Version 4

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

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (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

[DRAFT] searchCompositions [API-006-001-001-0215]

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-0215

Microservices (namespace)

MC

Component

Compositions

Component ID

COM-006-001

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

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

Resource

{{host}}/patients/{{patientId}}/composition

Scope

composition:search

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This method is designed to search for a composition by the specified parameters and get a list of results that match these parameters.

Logic

...

Configuration parameters

Description of the configuration parameters that are used when processing a request in the systemN/A

Dictionaries

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

subject

 

string($uuid)

subject's MPI ID (patientID - incompatible with focus)

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

2

focus

 

string($uuid)

subject's MPI ID (patientID - incompatible with subject)

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

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson
  '/patients/searchComposition':
    get:
      description: Пошук мед висновків
      operationId: searchCompositions
      tags: ['main']
      parameters:
        - $ref: '#/components/parameters/offsetParam'
        - $ref: '#/components/parameters/limitParam'
        - name: subject
          in: query
          required: false
          description: subject's MPI ID (пацієнт) (несумісний з focus)
          schema:
            type: string
            format: uuid
        - name: focus
          in: query
          required: false
          description: focus MPI ID (фокус) (несумісний з subject)
          schema:
            type: string
            format: uuid
        - in: query
          name: type
          required: false
          schema:
            $ref: '#/components/schemas/compositionTypeEnum'
        - in: query
          name: episodeOfCare
          required: false
          schema:
            type: string
            format: uuid
        - in: query
          name: encounter
          description: id ME-об'єкту Encounter
          required: false
          schema:
            type: string
            format: uuid
        - in: query
          name: status
          description: статус медвисновку
          required: false
          schema:
            $ref: '#/components/schemas/compositionStatusEnum'

Headers

...

Key

...

Value

...

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

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

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

Request data validation

Authorize

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

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

Processing

N/A

Response structure examples

See on API-specification

Expand
titleExample
Code Block
languagejson
[
  {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "person"
          }
        ],
        "text": "string"
      },
      "value": "52b504c7-0177-4078-834b-52d89154081c"
    },
    "status": "PRELIMINARY",
    "title": "string",
    "type": {
      "coding": [
        {
          "system": "COMPOSITION_TYPES",
          "code": "TEMP_DISABILITY"
        }
      ]
    },
    "date": "string",
    "encounter": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "person"
          }
        ],
        "text": "string"
      },
      "value": "52b504c7-0177-4078-834b-52d89154081c"
    },
    "episodeOfCare": {
      "type": {
        "coding": [
          {
            "system": "eHealth/resources",
            "code": "person"
          }
        ],
        "text": "string"
      },
      "value": "52b504c7-0177-4078-834b-52d89154081c"
    }
  }
]

HTTP status codes

401

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

200

Search results

3

Специфічні

Unauthorized

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

4

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

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

5

Специфічні

6

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 N/A

Technical modules where the method is used

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

...