Versions Compared

Key

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

...

...

Purpose

...

Return forbidden group details filtered by ID with active codes and active services in eHealth.

Specification

...

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-forbidden-groups/get-forbidden-group-details/get-forbidden-group-details

Resource

/api/forbidden_groups/{{id}}

Scope

forbidden_group:read

Components

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionForbidden groups

Microservices

Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACAPI paragraph not found

Protocol type

REST

Request type

GET

Sync/Async

Sync

...

Public/Private/Internal

Public

Logic

This web service returns forbidden group details filtered by ID with active codes and active services in eHealth.

Key points

  1. This is a REST method used by MIS

  2. Authorization is not needed to get Forbidden group list (as dictionaries).

Input parameters

Input parameter

Values

Type

Description

Example

id

String

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

Request structure*

...

Authorize*

Request to process the request using a token in the headers

Headers

...

Наприклад:

  • Content-Type:application/json

...

API paragraph not found

Processing*

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
      "name": "Some name",
      "creation_reason": "Some text",
      "deactivation_reason": "Some text",
      "forbidden_group_codes": [
        {
          "id": "f016a994-4826-48ae-be65-8d459a75f021",
          "code": "G30.9",
          "system": "eHealth/ICD10_AM/condition_codes",
          "creation_reason": "Some text"
        }
      ],
      "forbidden_group_services": [
        {
          "id": "b8bc70e1-783c-4b25-a90e-0da9217d84d9",
          "service_id": "b2e4464e-609e-480c-a32c-6db4fbb04cf1",
          "service_group_id": "d838dbea-0ca0-4295-bf46-819dc069b8d4",
          "creation_reason": "Some text"
        }
      ]
    }
  ]
}

Post-processing processes*

...

HTTP status codes

...

HTTP status code

Message

What caused the error

 200

 

 

...