Versions Compared

Old Version 2

changes.mady.by.user Dmytro Kulibaba (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Oleksandr Zhuk (SoE eHealth)

Saved on

Key

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

Purpose

This WS allows getting a list of healthcare services by a legal entity.

Key points

  1. Only authenticated and authorized user with an appropriate scope can get the healthcare services list.

  2. WS returns only healthcare services related to the same legal entity as the user.

...

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/healthcare-services/get-healthcare-services

Посилання на Apiary або Swagger

Resource

/api/healthcare_services

Посилання на ресурс, наприклад: /api/persons/create

Scope

healthcare_service:read

Scope для доступу

Components

ePrescriptionHealthcare services

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

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Logic

  1. Filter active healthcare_services:

    1. with legal_entity_id = client_id from access token;

    2. by search params.

  2. Render found healthcare_services with all fields from PRM DB.

Preconditions

API paragraph not found

Global and configurable parameters

...

Input parameters

No

Filters

See on Apiary

...

API paragraph not found

Request structure

API paragraph not found

Authorize

  • 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 scopes in order to perform this action (scope = 'healthcare_service:read')

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

Headers

API paragraph not found

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

See on ApiaryContent-Type:application/json

Dictionaries

  • PROVIDING_CONDITION

  • SPECIALITY_TYPE

  • HEALTHCARE_SERVICE_CATEGORIES

  • HEALTHCARE_SERVICE_PHARMACY_DRUGS_TYPES

Response structure

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
      "division_id": "8be63914-a278-470b-b868-1af5b9087332",
      "legal_entity_id": "483af06f-d4c6-4c9e-8d9b-680b5ef7270d",
      "license_id": "cdcf456b-e235-4850-9f00-27cc3453d346",
      "speciality_type": "FAMILY_DOCTOR",
      "providing_condition": "OUTPATIENT",
      "category": {
        "coding": [
          {
            "system": "HEALTHCARE_SERVICE_CATEGORIES",
            "code": "MSP"
          }
        ]
      },
      "type": {
        "coding": [
          {
            "system": "HEALTHCARE_SERVICE_PHARMACY_DRUGS_TYPES",
            "code": "SALE"
          }
        ]
      },
      "status": "ACTIVE",
      "comment": "Заведено помилково",
      "coverage_area": [
        "2c0110a9-0bea-4b16-af8e-6e2e149a5bfc"
      ],
      "available_time": [
        {
          "days_of_week": [
            "mon"
          ],
          "all_day": true,
          "available_start_time": "08:30:00",
          "available_end_time": "19:00:00"
        }
      ],
      "not_available": [
        {
          "description": "Санітарний день",
          "during": {
            "start": "2018-08-02T10:45:16.000Z",
            "end": "2018-08-02T11:00:00.000Z"
          }
        }
      ],
      "licensed_healthcare_service": {
        "status": "ACTIVE",
        "updated_at": "2022-04-20T19:14:13Z"
      },
      "is_active": true,
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

No

HTTP status codes

Page Properties

HTTP status code

Message

What caused the error

200

Response

 

401

Invalid access token

 

403

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

Backward compatibility

...