ЕСОЗ - публічна документація

[DRAFT] Verify Legal Entity by NHS [API-005-009-002-0179]

Owned by Kateryna Yakovleva
Last updated: Dec 24, 2024 by Anzhela Kovalenko (SoE eHealth)
2 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Verify Legal Entity by NHS [API-005-009-002-0179]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-009-002-0179

Microservices (namespace)

IL

Component

Legal Entities

Component ID

COM-005-009

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/legal-entities/verify-legal-entity-by-nhs

Resource

{{host}}/api/legal_entities/{{id}}/actions/nhs_verify

Scope

legal_entity:nhs_verify

Protocol type

REST

Request type

PATCH

Sync/Async

Sync

Public/Private

Public

Purpose

This service is designed to verify legal_entity by NHS. The company is created with nhs_verified is false

Logic

  1. Verify the validity of access token

  2. Check user scopes in order to perform this action

  3. Check legal_entity.status='active'

  4. Update legal_entity parameter nhs_verified on 'true', clear nhs_unverified_at

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Required

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

  1. Verify the validity of access token

  2. Check user scopes in order to perform this action

Data validation

  1. Check legal_entity.status='active'

  2. Update legal_entity parameter nhs_verified on 'true', clear nhs_unverified_at

Processing

Available transition: false → true

  • If legal_entity was previously verified, return Error 409

  • In successful case, return details by legal_entity

Response structure examples

See on API-specification

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": { "name": "Клініка Ноунейм", "short_name": "Ноунейм", "public_name": "Ноунейм", "type": "MSP", "owner_property_type": "STATE", "legal_form": "140", "edrpou": "5432345432", "kveds": [ "86.1" ], "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", "website": "www.msp.com.ua", "receiver_funds_code": "12345", "beneficiary": "Борисов Борис Борисович", "medical_service_provider": { "licenses": [ { "license_number": "fd123443", "issued_by": "Кваліфікацйна комісія", "issued_date": "2017-02-28", "expiry_date": "2017-02-28", "active_from_date": "2017-02-28", "what_licensed": "реалізація наркотичних засобів", "order_no": "ВА43234" } ], "accreditation": { "category": "SECOND", "issued_date": "2017-02-28", "expiry_date": "2017-02-28", "order_no": "fd123443", "order_date": "2017-02-28" } }, "archive": [ { "date": "2017-02-28", "place": "вул. Грушевського 15" } ], "security": { "redirect_uri": "redirect_uri" }, "is_active": true, "inserted_by": "A65C8369-CE3A-44D6-839B-8856E3DC4CA3", "inserted_at": "2005-10-30 10:45", "created_by_mis_client_id": "A65C8369-CE3A-44D6-839B-8856E3DC4CA3", "updated_at": "1991-08-19T00:00:00.000Z", "updated_by": "userid" } }

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 Response

 

 

3

 

409

 If legal_entity was previously verified

 

 

4

Специфічні

5

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

N/A

 

ЕСОЗ - публічна документація