Versions Compared

Version Old Version 9 New Version 10
Changes made by

Dmytro Omelchenko (SoE eHealth)

Dmytro Omelchenko (SoE eHealth)

Saved on

Key

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

...

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/preperson/get-preperson-by-id

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

Resource

/api/prepersons/{{id}}

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

Scope

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

  1. Only authenticated and authorized SPECIALIST, ASSISTANT, RECEPTIONIST employees can get preperson.

  2. Preperson could be got only in OUTPATIENT or EMERGENCY legal entity type, if identifier of preperson is being known (returns after Create preperson).

  3. Only preperson’s table fields can be recieved.

...

Input parameter

Values

Type

Description

Example

id

String

MPI identifier of the preperson. Required

7c3da506-804d-4550-8993-bf17f9ee0402

Dictionaries

  • GENDER

  • PHONE_TYPE

Authorize

  1. Verify the validity of access token

    1. Return 401 in case validation fails

  2. Check user scopes in order to perform this action (scope = 'preperson:read')

    1. Return 403 in case invalid scope(s)

...