Versions Compared

Key

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

...

API paragraph not found

Link

https://app.swaggerhub.com/apis/bugzi11a/emal/1.0.8#/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

...

String

Input parameter

Values

Type

Description

Example

patientId

subject

string($uuid)

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

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

focus

string($uuid)

subject's MPI patient IDID (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: 50Default value : 20

integer(query)

The numbers of items to return.

30

type

TEMP_DISABILITY

NEWBORN

string(query)

COMPOSITION_TYPES dictionary value

TEMP_DISABILITY

episodeOfCare

string(query)episodeOfCare$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

Request structure

See on SwaggerHub

Expand
titleExample
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

API paragraph not found

Headers

...

  • Content-Type: application/json

  • Authorization: Bearer {token}

  • api-key: {secret}

Validation data request

API paragraph not found

...

API paragraph not found

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"
    }
  }
]

Post-processing processes

...