1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Dictionaries
6 Request structure
7 Authorize
8 Headers
9 Request data validation
- 9.1 Validate location
- 9.2 Validate addresses
- 9.3 Validate phone
- 9.4 Validate email
- 9.5 Validate type
10 Processing
11 Response structure
12 HTTP status codes

Purpose

This method must be used to update existing division in the system.

Note that different legal entity types can register specific division types and address types accordingly More details can be found here

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/divisions/update-division	Посилання на Apiary або Swagger
Resource	/api/divisions/{{id}}	Посилання на ресурс, наприклад: /api/persons/create
Scope	division:write	Scope для доступу
Components	Divisions	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	il/api	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

Only authenticated and authorized user of this legal entity with appropriate scope can update division.
Division can be updated for RESIDENCE, REGISTRATION addresses types.
Division can be updated for legal entities in ACTIVE or SUSPENDED statuses.
Editable information on division:
- name
- addresses
- phones
- email
- add the gps-coordinates attributed to the division (location)
- working hours

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Values	Type	Description	Example
id		String	Required	d290f1ee-6c54-4b01-90e6-d701748f0851

Parameter	Source

Parameter	Source
action	`PATCH`
id
external_id	$.external_id
name	$.name
type	$.type
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

Dictionaries

Dictionary ADDRESS_TYPE
Dictionary PHONE_TYPE
Dictionary SETTLEMENT_TYPE
Dictionary STREET_TYPE
Dictionary DIVISION_TYPE
Dictionary COUNTRY

Request structure

Example:

{
  "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
1. In case error generate 401 response
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):
1. in case not match - return 403 ("Access denied. Party is not verified")

Headers

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

Request data validation

Validate location

Location is required for divisions related to legal entity with type PHARMACY

Check that location exists in request for legal entity with type PHARMACY
1. In case of error - generate 422 response

Validate addresses

Check that addresses.type exists in dictionaries.
1. In case error generate 422 "value is not allowed in enum"
Check that addresses.area exists in Uaddresses.areas
1. in case error generate 422 "invalid area value"
Check that addresses.settlement exists in Uaddresses.settlements
1. in case error generate 422 "invalid settlement value"
Check that addresses.settlement_type exists in dictionaries.
1. in case error generate 422 "value is not allowed in enum"
Check that addresses.settlement_id exists in Uaddresses.settlements
1. in case error generate 422 "settlement with id = <id> does not exist"
Check that addresses.street_type exists in dictionaries.
1. In case error generate 422 "value is not allowed in enum"
Check that addresses.zip in "^[0-9]{5}$" format.
1. In case error generate 422 "string does not match pattern \"^[0-9]{5}$\""
Check mapping legal_entity_type, division_type and address_type and its obligation. See validation rules here: Validation rules on Divisions
1. in case error generate 422 response

Validate phone

Check that phone type exists in dictionaries. PHONE_TYPE required (MOBILE,LAND_LINE)
1. in case error generate 422 response
Check phone number is valid according to "^\\+38[0-9]{10}$"
1. in case error generate 422 response

Validate email

Check that email is valid according to "~r/^[\\w!#$%&'*+\\/=?`{|}~^-]+(?:\\.[\\w!#$%&'*+\\/=?`{|}~^-]+)*@(?:[A-Z0-9-]+\\.)+[A-Z]{2,6}$/i"
1. in case error generate 422 response

Validate type

Check that type exists in dictionaries. Type required (DRUGSTORE,DRUGSTORE2,CLINIC,AMBULANT_CLINIC,FAP)
1. in case error generate 422 response
Check mapping of legal_entity_type and division type.
1. in case error generate 422 response

Processing

Response structure