Versions Compared

Old Version 40

changes.mady.by.user Igor Gorielov (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Yuliia Mazur (UA SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Purpose

...

Table of Contents

Purpose

This method must be used to create new division in the system.

...

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/divisions/create-division

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

Resource

/api/divisions

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

Scope

division:write

Scope для доступу

Components

Divisions

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

il/api

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

POST

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

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

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

Logic

General

Each legal entity can manage its own divisions:

...

Expand
titleRequest example
Code Block
{
  "name": "Бориспільське відділення Клініки Ноунейм",
  "addresses": [
    {
      "type": "RESIDENCE",
      "country": "UA",
      "area": "Житомирська",
      "region": "Бердичівський",
      "settlement": "Київ",
      "settlement_type": "CITY",
      "settlement_id": "b075f148",
      "street_type": "STREET",
      "street": "вул. Ніжинська",
      "building": "15",
      "apartment": "23",
      "zip": "02090"
    }
  ],
  "phones": [
    {
      "type": "MOBILE",
      "number": "+380503410870"
    }
  ],
  "email": "email@example.com",
  "working_hours": {
    "mon": [
      [
        "08.00",
        "12.00"
      ],
      [
        "14.00",
        "18.00"
      ]
    ],
    "tue": [
      [
        "08.00",
        "12.00"
      ]
    ],
    "wed": [
      [
        "08.00",
        "12.00"
      ]
    ],
    "thu": [
      [
        "08.00",
        "12.00"
      ]
    ],
    "fri": [
      [
        "08.00",
        "12.00"
      ]
    ]
  },
  "type": "CLINIC",
  "legal_entity_id": "c8aadb87-ecb9-41ca-9ad4-ffdfe1dd89c9",
  "external_id": "3213213",
  "location": {
    "latitude": 30.1233,
    "longitude": 50.32423
  }
}

Authorize

...

Verify the validity of access token

Check user scope (scope = 'division:write') in order to perform this action

...

50.32423
  }
}

Authorize

  1. Verify the validity of access token

  2. Check user scope (scope = 'division:write') in order to perform this action

    • in case error - generate 401 response

  3. If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

    • in case not match - return 403 ("Access denied. Party is not verified")

Headers

Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}

...

Processing

Create new division

Parameter

Source

action

`PUT`

id

external_id

$.external_id

name

$.name

type

$.type

mountain_group

addresses

$.addresses

phones

$.type, $.number

email

$.email

inserted_at

:timestamp

Updated_at

:timestamp

legal_entity_id

take from token

Location

$.latitude, $.longitude

status

ACTIVE

is_active

true

working_hours

$.working_hours

Additional

  1. Add new mapping for  "division_type" &  Legal_entity_type

    1. Check that prm.legal_entities.status = active or suspended and prm.legal_entities.is_active = true for legal entity to which division is added

  2. Add new validation for verification of usage division_type in Legal_entity_type at Create_division process.

  3. There is no other specific logic for new division types.

...