REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

Properties of a REST API method document

Document type	Метод REST API
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 system

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

Example

  '/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
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2	Authorization	Bearer {token}			Authorization: Bearer {token}
3	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 API

Response structure examples