Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents
minLevel1
maxLevel7

Purpose

This WS is designed to update previously created healthcare service for the division of legal entity

...

Page Properties

Link

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

Посилання на Apiary або Swagger

Resource

/api/healthcare_services/{{id}}

Посилання на ресурс, наприклад: /api/persons/create

Scope

healthcare_service:write

Scope для доступу

Components

Healthcare 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. comment = $.comment;

    2. available_time = $.available_time;

    3. not_available = $.not_available;

    4. updated_at = now();

    5. updated_by = user_id from access token.

...

  • Check that each object in not_available array has a valid period in $.not_available.during. during.end must be greater than during.start

    • in case of error - return 422 (“Should be greater then start“).

Processing

API paragraph not found

Response structure

See on Apiary

...

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

422

  • Error

  • Should not be present when all_day = true.

  • Should be present when all_day = false.

  • Should be greater then start.

  • Request validation failed

Backward compatibility

...