Versions Compared

Key

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

Purpose

This method allows to search for a Person (MPI) without disclosing personal data.

...

Page Properties
idAPI_Specification
API paragraph not found

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/persons/search-for-a-person

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

Resource

/api/persons

Посилання на ресурс, наприклад: /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

Public

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

Logic

API paragraph not foundMethod returns only requested parameters, birth place and second name in addition for manual identification on MSP side.

Input parameters

See on Apiary

Filters

See on Apiary

Dictionaries

  • GENDER

  • PHONE_TYPE

Request structure

API paragraph not foundSee on Apiary

Authorize

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

Headers

...

Content-Type:application/json

Authorization:Bearer {{access_token}}

Request data validation

When flag `USE_DEDUPLICATION_MODEL` is turned ON, use this logic.

...

Expand
titleResponse example. Code: 403
Code Block
{
  "meta": {
    "code": 403,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "error": {
    "type": "too_many_results",
    "message": "This API method returns only exact match results, please retry with more specific search result"
  }
}

Post-processing processes

...

HTTP status codes

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response

 

 403

 This This API method returns only exact match results, please retry with more specific search result

 Too many results

...