Versions Compared

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

...

  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

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

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Healthcare service identifier. Optional

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

2

...

  • 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

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

...

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"

...