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

Get Person verification details

Owned by Dmytro Omelchenko (SoE eHealth)
Last updated: Jun 25, 2024 by Yuliia Mazur (UA SoE eHealth)
2 min read

Purpose

This WS allows to check current verification status of the specified person

This WS allows to check current cumulative verification status of specified person as well as verification statuses for each of streams: DRFO, DRACS death and NHS manual.

Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/persons/get-person-verification-details

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

Resource

/api/persons/{{id}}/verification

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

Scope

person:read

person_verification:details

Scope для доступу

Components

Patient registry

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

Microservices

mpi/api

il/api (rpc)

fe/admin-web

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

Protocol type

REST

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

Request type

GET

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

Sync/Async

Sync

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

Public/Private/Internal

Public

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

Logic

Service returns verification info for a specified person:

  • Get person from mpi.persons table

  • Get person verification details from mpi.person_verifications table

  • Render a response according to specification

Input parameters

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

id

 

String

Person identifier. Required

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

Filters

See on Apiary

Authorize

  • Verify the validity of access token

    • 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 = 'person_verification:details')

    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: person_verification:details') in case of invalid scope(s)

Headers

Наприклад:

  • Content-Type:application/json

  • Authorization:Bearer {{access_token}}

  • api-key: {{secret}}

Request data validation

Validate Patient

  • Get Patient identifier from the URL

  • Check it exists in mpi DB, persons table

    • Return 404 ('not found') in case of error

  • Check person verification record exists in mpi DB, person_verifications table

    • Return 404 ('not found') in case of error

Response structure

Example:

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": { "verification_status": "NOT_VERIFIED", "details": { "drfo": { "verification_status": "NOT_VERIFIED", "verification_reason": "AUTO", "result": 12 }, "dracs_death": { "verification_status": "NOT_VERIFIED", "verification_reason": "AUTO", "verification_comment": "Необхідно повторно підтвердити факт смерті у пацієнта", "death_date": "2022-05-09" }, "nhs": { "verification_status": "NOT_VERIFIED", "verification_reason": "AUTO", "verification_comment": "Бракує даних паспорту пацієнта та його ІПН" } } } }

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

200

 Response

 

401

 Invalid access token

 

403

Your scope does not allow to access this resource. Missing allowances: person:read

 

404

not found

 

 

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