Versions Compared

Version Old Version 3 New Version 4
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

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

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

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-005-009-001-0172

Microservices (namespace)

IL

Component

Legal Entities

Component ID

COM-005-009

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

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

Resource

{{host}}/api/healthcare_services/

Scope

healthcare_service:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

...

  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.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

  • PROVIDING_CONDITION

  • SPECIALITY_TYPE

  • HEALTHCARE_SERVICE_CATEGORIES

  • HEALTHCARE_SERVICE_PHARMACY_DRUGS_TYPES

Input parameters

...

parameters

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

Composition object ID

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Expand
titleExample
Code Block
...
Key
Value
Mandatory
Description
Example
1
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
Request data validation
...
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).
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 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
  }
}
...
Помилка підтвердженняOnly for active MPI record can be created medication request!
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
Response
 
3
401
Invalid access token
 
4
401
Unauthorized
5
403
Your scope does not allow to access this resource. Missing allowances: healthcare_service:read
6
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
7
Специфічні
8
422
5
Специфічні
6
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...