Versions Compared

Old Version 3

changes.mady.by.user Dmytro Kulibaba (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Nickolay Kolotov (SoE eHealth)

Saved on

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.

Key points

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

  2. Healthcare service can be updated for PRIMARY_CARE, EMERGENCY, OUTPATIENT or PHARMACY legal entity.

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

  4. Only active healthcare service can be updated.

  5. Only comment, available_time, restricted_periods fields can be updated.

Specification

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.

Preconditions

API paragraph not found

Global and configurable parameters

NoHealthcare services hould be created

Input parameters

Input parameter

Values

Type

Description

Example

id

String

Healthcare service identifier. Optional.

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

Filters

No

Dictionaries

...

Request structure

...

Example:

Expand
titleRequest example
Code Block
{
  "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"
      }
    }
  ]
}

...

  • 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

...

Response structure

See on Apiary

...

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

Post-processing processes

...

HTTP status codes
 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
...