Versions Compared

Old Version 12

changes.mady.by.user Alexander Fedotov (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Kateryna Haleta (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

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

Specification

Link

https://app.swaggerhub.com/apis/

bugzi11a

ehealthua/

emal

compositions/

1

2.

0

39.

8#

2#/main/searchCompositions

Resource

/patients/{patientId}/composition

Scope

composition:search

Components

Compositions

Using Dictionaries

COMPOSITION_STATUS

COMPOSITION_TYPES

Using Microservices

API paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

Logic

...

...

View file
namesearchcomposition-logic.bpmn

Input parameters

Input parameter

Values

Type

Description

Example

subject

string($uuid)

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

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

focus

string($uuid)

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

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

Filters

Filter

Values

Type

Description

Example

offset

minimum: 0

integer(query)

The number of items to skip before starting to collect the result set.

2

limit

minimum: 1
maximum: 50

integer(query)

The numbers of items to return.

30

type

TEMP_DISABILITY

NEWBORN

string(query)

COMPOSITION_TYPES dictionary value

TEMP_DISABILITY

episodeOfCare

string($uuid)

episodeOfCareId

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

encounter

string($uuid)

encounterId

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

status

  • PRELIMINARY

  • FINAL

  • AMENDED

  • ENTERED

-

  • _IN

-

  • _ERROR

string(query)

COMPOSITION_STATUS ictionary value

ENTERED

-

_IN

-

_ERROR

Dictionaries

Request structure

See on SwaggerHub

Expand
titleExampleSchema
Code Block
  '/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'

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}

Validation data request

API paragraph not found

Processing

API paragraph not found

Response structure

See on SwaggerHub

Example:

Expand
titleResponse example
Code Block
[
  {
    "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"
    }
  }
]

Post-processing processes

...

HTTP status codes
HTTP status code
Message
What caused the error
 200
Search results