Versions Compared

Old Version 1

changes.mady.by.user Dmytro Kulibaba (Unlicensed)

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

Purpose

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

API paragraph not found

COMPOSITION_STATUS

COMPOSITION_TYPES

Using Microservices

API paragraph not found

Protocol type

JSON

REST

Request type

GET

Sync/Async

Async

Public/Private/Internal

Public

Logic

API paragraph not found

Preconditions

API paragraph not found

Global and configuration parameters

None

...

View file
namesearchcomposition-logic.bpmn

Input parameters

Input parameter

Values

Type

Description

Example

patientId

String

subject

string($uuid)

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

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

focus

string($uuid)

subject's MPI

patient

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

Default value : 20

integer(query)

The numbers of items to return.

30

type

NEWBORN

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 Apiary

Authorize

API paragraph not found

Validate request (JSON schema)

API paragraph not found

Validation data request

API paragraph not found

Processing

API paragraph not found

Response structure

See on ApiarySwaggerHub

Expand
titleSchema
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}

Response structure

See on SwaggerHub

Example:

Expand
titleResponse example
Code Block
[
  {
    "identifier": {
      "type": {
        "coding": [
          {
            "system": "eHealth/compositionresources",
            "code": "stringperson"
          }
        ],
        "text": "string"
      },
      "value": "e49abc3052b504c7-6d170177-11ea4078-b83c834b-673680173afa52d89154081c"
    },
    "status": "PRELIMINARY",
    "title": "string",
    "type": {
      "coding": [
        {
          "system": "eHealth/compositionCOMPOSITION_typesTYPES",
          "code": "NEWBORNTEMP_DISABILITY"
        }
      ]
    },
    "date": "string",
    "encounter": {
      "type": {
        "coding": [
          {
            "system": "eHealth/compositionresources",
            "code": "stringperson"
          }
        ],
        "text": "string"
      },
      "value": "e49abc3052b504c7-6d170177-11ea4078-b83c834b-673680173afa52d89154081c"
    },
    "episodeOfCare": {
      "type": {
        "coding": [
          {
            "system": "eHealth/compositionresources",
            "code": "stringperson"
          }
        ],
        "text": "string"
      },
      "value": "e49abc3052b504c7-6d170177-11ea4078-b83c834b-673680173afa52d89154081c"
    }
  }
]

...

None
HTTP status codes
HTTP status code
Message
What caused the error
 200
 Результати пошуку
Search results
 
Backward compatibility
...