Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

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

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] PIS. Get Person verification details [API-010-001-011010-04510450]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-010-001-011010-04510450

Microservices (namespace)

MPI

Component

Master Patient Index

Component ID

COM-010-001

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

https://pisapi1.docs.apiary.io/#reference/public.-patient-information-system/person-information/get-person-verification-details

Resource

{{host}}/api/pis/person/verification

Scope

person_verification:details_pis

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS designed to get information of person by tokencurrent user's person verification status & data and relationship verification status.

Logic

Service logic

  1. Get person_id and applicant_person_id from token (x-person-id header).

  2. Get person’s data from tables using person_id as query params:

    1. mpi.persons

    2. mpi.person_addresses

    3. mpi.person_documents

    4. mpi.person_phones

    5. mpi.person_verifications tables

  3. Render response according to specification.

  4. Get person verification details from mpi.person_verifications table

  5. Get relationship from mpi.confidant_person_relationships table where:

    1. person_id=person_id from token

    2. confidant_person_id = applicant_person_id

    3. AND is_active=true

  6. Render a response according to specification

Configuration parameters

N/A

...

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson

...

  • 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_pis')

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

  • Check that token contains person_id

    • in case of error - return (401, 'Invalid access token')

...

  • Get person_id from token (x-person-id header)

  • Validate patient status is active (status = ‘active' & is_active = 'true’)

    • in case of error - return 404 ('Person not found')

  • If person_id and applicant_person_id from token not equal check confidant person relationship record exists in mpi.confidant_person_relationships

    • in case of error - return 404 ('Confidant person relationship not found')

Processing

N/A

Response structure examples

See on API-specification

Expand
titleExample
Code Block
languagejson

...