ЕСОЗ - публічна документація

[DRAFT] Deactivate healthcare service [API-005-009-001-0174]

Owned by Kateryna Yakovleva
Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)
1 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Deactivate healthcare service [API-005-009-001-0174]

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-0174

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/deactivate-healthcare-service

Resource

{{host}}/api/healthcare_services/{{id}}/actions/deactivate

Scope

healthcare_service:write

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

Purpose

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

Key points

  1. Only authenticated and authorized user with an appropriate scope can deactivate healthcare service.

  2. Only active healthcare service can be deactivated.

  3. Healthcare service can be deactivated for legal entities in ACTIVE or SUSPENDED statuses.

  4. User can deactivate healthcare services only of its legal entity.

Logic

  1. 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.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Healthcare service identifier. Optional

d290f1ee-6c54-4b01-90e6-d701748f0851

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

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:write')

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

Validate legal entity

  • Extract legal entity id from access token. Check that legal entity is in ‘ACTIVE’ or ‘SUSPENDED’ status

    • in case of error - return 409 (“Invalid legal entity status”).

Validate healthcare service

  • Get healthcare service by $.id. Check that healthcare service exists in PRM DB

    • in case of error - return 404 (“not_found”).

  • Get healthcare service by $.id. Check that healthcare service belongs to legal entity id from access token

    • in case of error - return 403 (“forbidden”).

Validate transition

  • 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

N/A

Response structure examples

See on API-specification

{ "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" } }HTTP status codes

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

Response

 

 

3

 

401

Invalid access token

 

 

4

 

403

forbidden

 

 

5

 

403

Healthcare service belongs to legal entity id from access token check failed.

 

 

6

 

403

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

 

 

7

 

404

Not found

Healthcare service exists in PRM DB check failed

 

8

 

409

Invalid legal entity status.

 

 

9

 

409

healthcare_service.status healthcare service cannot be DEACTIVATED.

 

 

10

Специфічні

11

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

ЕСОЗ - публічна документація