Versions Compared

Version Old Version 3 New Version 4
Changes made by

Anzhela Kovalenko (SoE eHealth)

Mariana Veremeieva (UA SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

Scope

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://ehealthmisapi1ehealthmedicalevents991v11.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-detailsevents/composition/get-composition-configurations-by-search-params

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

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.

...

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

...

  1. Validate required query parameter type is filled

    1. Return 422 ("Required query parameter type is missing”value is not allowed in enum”) in case of error

  2. Validate value in query parameter type is fromCOMPOSITION_TYPES dictionary

    1. Return 422 ("Incorrect value for query parameter typevalue is not allowed in enum") in case of error

  3. Validate required query parameter category is filled

    1. Return 422 ("Required query parameter category is missing”value is not allowed in enum”) in case of error

  4. Validate value in query parameter category is fromCOMPOSITION_CATEGORIES dictionary

    1. Return 422 ("Incorrect value for query parameter category”value is not allowed in enum”) in case of error

Processing

...

Response structure examples

See on API-specification

Expand
titleExample
Code Block
{
  "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

...