Properties of a REST API method document

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.

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.

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 ConfluenceN/A

Dictionaries

N/A

Input parameters

Description of input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

{
  "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"
      }
    }
  ]
}

Headers

...

Headers

...

Request data validation

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

API-key

...

uXhEczJ56adsfh3Ri9SUkc4en

...

API-key:uXhEczJ56adsfh3Ri9SUkc4en

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 request

• Validate request using JSON schema

  • in case of error - return 422.

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”).

• Get healthcare service by $.id. Check that healthcare service status = ‘ACTIVE’

  • in case of error - return 409 (“healthcare_service.status healthcare service cannot be updated”), where healthcare_service.status = value of status of healthcare service from PRM DB.

Validate available time

• If $.all_day = true, check that fields available_start_time and available_end_time does not exist in request

  • in case of error - return 422 (“Should not be present when all_day = true“).

• If all_day = false, check that fields available_start_time and available_end_time exist in request

  • in case of error - return 422 (“Should be present when all_day = false“).

Validate not available

• 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

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

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

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

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

...