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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose

This method allows to view Person's (MPI) details.

Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin-v2/persons/get-person-details

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

Resource

/api/nhs_admin/persons/id

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

Scope

person:read

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

Private

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

Input parameters

Input parameter

Values

Type

Description

Example

id

String

Person identifier

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

Dictionaries

  • GENDER

  • AUTHENTICATION_METHOD

  • DOCUMENT_TYPE

Authorize

Request to process the request using a token in the headers.

Headers

Content-Type:application/json

Authorization:Bearer {{access_token}}

Request data validation

Processing

Response structure

Example:

 Response example. Code: 200
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
    "status": "active",
    "first_name": "Петро",
    "last_name": "Іванов",
    "second_name": "Миколайович",
    "birth_date": "1991-08-19",
    "birth_country": "Україна",
    "birth_settlement": "Вінниця",
    "tax_id": "3126509816",
    "unzr": "19910819-00011",
    "gender": "FEMALE",
    "authentication_method_current": {
      "type": "OTP",
      "number": "+380937777785"
    },
    "documents": [
      {
        "type": "PASSPORT",
        "number": "АА120518",
        "expiration_date": "2021-02-28",
        "issued_by": "Рокитнянським РВ ГУ МВС Київської області",
        "issued_at": "2017-02-28"
      }
    ]
  }
}

HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response

 

 

 

Backward compatibility

  • No labels