ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] [NEW] Get Composition Configurations by search params [API-007-011-001-0480]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-007-011-001-0480

Microservices (namespace)

ME

Component

Compositions_ME

Component ID

COM-007-011

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

https://ehealthmedicalevents991v11.docs.apiary.io/#reference/medical-events/composition/get-composition-configurations-by-search-params

Resource

{{host}}//api.ehealth.gov.ua/api/composition_configurations?type=DRIVERS&category=DRIVERS_GROUP1&page=2&page_size=50

Scope

composition_configurationMC-1295:read ?

Protocol type

REST

Request type

GET

Sync/Async

Async

Public/Private

Public

Purpose

This method allows to get composition_configurations that are used for request validation on Create Composition method.

Logic

Service logic

  1. Select composition_configurations records from PRM filtered by type and category from the request

  2. Exclude from composition_configurations.settings json elements where check = “Any”

  3. Return response to the client according to schema

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

type

M

String

type of the Composition

DRIVERS

2

 categor

M

String

 category of Composition

 DRIVERS_GROUP1

Request structure

See on API-specification

 Example

Headers

Headers

Request data validation

Authorization

  • Verify the validity of access token

    • in case of error - return 401 “Invalid access token” in case of validation fails

  • Verify that token is not expired

    • in case of error - return 401 “Invalid access token”

  • Check user and client scopes in order to perform this action (scope = 'composition:read')

    • return 403 “Your scope does not allow to access this resource. Missing allowances: composition:read” in case of invalid scope(s)

Validate query parameters

  1. Validate required query parameter type is filled

    1. Return 422 ("value is not allowed in enum”) in case of error

  2. Validate value in query parameter type is from COMPOSITION_TYPES dictionary

    1. Return 422 ("value is not allowed in enum") in case of error

  3. Validate required query parameter category is filled

    1. Return 422 ("value is not allowed in enum”) in case of error

  4. Validate value in query parameter category is from COMPOSITION_CATEGORIES dictionary

    1. Return 422 ("value is not allowed in enum”) in case of error

Processing

N/A

Response structure examples

See on API-specification

 Example
{
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "2017-04-20T19:14:13Z",
      "type": {
        "coding": [
          {
            "system": "COMPOSITION_TYPES",
            "code": "DRIVERS"
          }
        ]
      },
      "category": {
        "coding": [
          {
            "system": "COMPOSITION_CATEGORIES",
            "code": "DRIVERS_GROUP1"
          }
        ]
      },
      "is_active": true,
      "settings": "{ \"COMPOSITION_PERSON_GENDER\": { \"check\": [ \"female\", \"male\" ] }, \"COMPOSITION_SECTION_EMPTY_REASON\": { \"check\": [\"NILKNOWN\", \"NOTASKED\", \"WITHHELD\", \"UNAVAILABLE\", \"CLOSED\"] }, \"COMPOSITION_SECTION_NESTING_LEVEL\": { \"check\": 5 }, \"COMPOSITION_SECTION_COUNT_LIMIT\": { \"check\": 100 }, \"COMPOSITION_SECTION_ORDERBY\": { \"check\": [ \"USER\", \"SYSTEM\", \"EVENT-DATE\", \"ALPHABETIC\", \"CATEGORY\" ] }, \"COMPOSITION_DRIVER_RELATED_CODES\": [ { \"condition\": { \"code\": \"01.\", \"system\": \"eHealth/composition_additional_condition_admission\" }, \"check\": [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\", \"g\"] }, { \"condition\": { \"code\": \"01.01.\", \"system\": \"eHealth/composition_additional_condition_admission\" }, \"check\": [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\", \"g\"] }, { \"condition\": { \"code\": \"01.02.\", \"system\": \"eHealth/composition_additional_condition_admission\" }, \"check\": [\"a\", \"b\", \"c\", \"d\", \"e\", \"f\", \"g\"] }]}",
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2018-08-02T10:45:16.000Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "paging": {
    "page": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 20
  }
}

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

401

Invalid access token

3

403

Your scope does not allow to access this resource. Missing allowances: composition:read

4

422

Incorrect value for query parameter type

5

422

Incorrect value for query parameter category

6

422

Required query parameter type is missing

7

Специфічні

8

Post-processing processes

N/A

Technical modules where the method is used

Название

ID ТМ

Статус

/wiki/spaces/ESOZ/pages/17378181218

TM0112

/wiki/spaces/YK/pages/17837688354

 

  • No labels

ЕСОЗ - публічна документація