...

Table of Contents

minLevel	1
maxLevel	7

Purpose

This WS is designed to deactivate healthcare service for the division of a legal entity.

Key points

Only authenticated and authorized user with an appropriate scope can deactivate healthcare service.
Only active healthcare service can be deactivated.
Healthcare service can be deactivated for legal entities in ACTIVE or SUSPENDED statuses.
User can deactivate healthcare services only of its legal entity.

Specification

Page Properties

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/healthcare-services/deactivate-healthcare-service	Посилання на Apiary або Swagger
Resource	/api/healthcare_services/{{id}}/actions/deactivate	Посилання на ресурс, наприклад: /api/persons/create
Scope	healthcare_service:write	Scope для доступу
Components	ePrescriptionHealthcare services	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public

Logic

Update healthcare service in healthcare_services table (PRM DB) with data from request and additional fields:
1. status = 'INACTIVE';
2. updated_at = now();
3. updated_by = user_id from access token.

...

Preconditions

API paragraph not found

Global and configurable parameters

...

Input parameters

Input parameter	Values	Type	Description	Example
id		String	Healthcare service identifier. Optional.	d290f1ee-6c54-4b01-90e6-d701748f0851

Filters

No

Dictionaries

...

Request structure

API paragraph not foundSee on APIary

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:write')
- return 403 (“Your scope does not allow to access this resource. Missing allowances: healthcare_service:write”) in case of invalid scope(s).

...

API paragraph not found

Request data validation

Validate legal entity

...

Get healthcare service by $.id. Check that healthcare service status = ‘ACTIVE’
- in case of error - return 409 (“healthcare_service.status healthcare service cannot be DEACTIVATED”), where healthcare_service.status = value of status of healthcare service from PRM DB.

Processing

...

Response structure

...

Example:

Expand

title	Response 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": "INACTIVE",
    "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"
  }
}

Post-processing processes

API paragraph not found

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:write. forbidden	2. Healthcare service belongs to legal entity id from access token check failed.
404	Not found	Healthcare service exists in PRM DB check failed
409	Invalid legal entity status. healthcare_service.status healthcare service cannot be DEACTIVATED.

Backward compatibility

...

Versions Compared

Old Version 1

New Version Current

Key

Purpose

Key points

Specification

Logic

Preconditions

Global and configurable parameters

Input parameters

Filters

Dictionaries

Request structure

Authorize

Request data validation

Validate legal entity

Processing

Response structure

Post-processing processes

HTTP status codes

Backward compatibility

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Purpose

Key points

Specification

Logic

Preconditions

Global and configurable parameters

Input parameters

Filters

Dictionaries

Request structure

Authorize

Request data validation

Validate legal entity

Processing

Response structure

Post-processing processes

HTTP status codes

Backward compatibility