Versions Compared

Key

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

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

Page Properties
idAPI_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

...

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

...

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

...