Versions Compared

Key

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

Purpose

This WS is designed to deactivate healthcare service for division of 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.

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

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

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.

Preconditions

API paragraph not found

...

Page Properties

HTTP status code

Message

What caused the error

200

Response

 

401

Invalid access token

 

403

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

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

...