Purpose

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

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.

Input parameters

Filters

No

Request structure

See on APIary

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

Request data validation

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

Validate transition

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

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
    "division_id": "8be63914-a278-470b-b868-1af5b9087332",
    "legal_entity_id": "483af06f-d4c6-4c9e-8d9b-680b5ef7270d",
    "license_id": "cdcf456b-e235-4850-9f00-27cc3453d346",
    "speciality_type": "FAMILY_DOCTOR",
    "providing_condition": "OUTPATIENT",
    "category": {
      "coding": [
        {
          "system": "HEALTHCARE_SERVICE_CATEGORIES",
          "code": "MSP"
        }
      ]
    },
    "type": {
      "coding": [
        {
          "system": "HEALTHCARE_SERVICE_PHARMACY_DRUGS_TYPES",
          "code": "SALE"
        }
      ]
    },
    "status": "INACTIVE",
    "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"
        }
      }
    ],
    "licensed_healthcare_service": {
      "status": "ACTIVE",
      "updated_at": "2022-04-20T19:14:13Z"
    },
    "is_active": true,
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

HTTP status codes