Versions Compared

Key

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

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

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] PIS. Get Person details [API-010-001-011-0451]

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-011-0451

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-details

Resource

{{host}}/api/pis/person

Scope

person:details_pis

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS designed to get information of person by token.

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

Service logic

  1. Get 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.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block

...

language

...

json

...

Headers

...

Mandatory

...

Description

...

Example

...

Headers

Request data validation

Authorization

...

  • Verify the

...

Processing

...

  • 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:details_pis')

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

  • Check that token contains person_id

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

Validate person

  • 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 ('not found')

Processing

N/A

Response structure examples

See on API-specification

Expand
titleExample
Code Block
languagejson

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

3

4

Специфічні

5

Post-processing processes

Description of actions performed on data after processingN/A

Technical modules where the method is used

...