Versions Compared

Key

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

Purpose

...

Table of Contents

Purpose

This WS serves for receiving approval from a person on the action of merging with preperson.

Specification

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/merge-request/approve-merge-request

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

Resource

/api/merge_requests/{{id}}/actions/approve

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

Scope

merge_request:write

Scope для доступу

Components

Patient registry

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not foundePrescription

Microservices

il/api

mpi/api

fe/admin-web

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

PATCH

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

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

Logic

  1. Only authenticated and authorized SPECIALIST, ASSISTANT or RECEPTIONIST employees can use this WS.

  2. Usage of this WS allowed in EMERGENCY or OUTPATIENT legal entities.

  3. Person should confirm merge with preperson by auth method chosen on create patient request or create declaration request processes.

  4. The request can be approved only by employee who made the request.

  5. Change status should be logged in the Event manager.

...

Input parameter

Values

Type

Description

Example

id

String

Identifier of the merge request. Required

7c3da506-804d-4550-8993-bf17f9ee0404

Identifier of the merge request. Required

7c3da506-804d-4550-8993-bf17f9ee0404

Dictionaries

  • GENDER

  • DOCUMENT_TYPE

  • ADDRESS_TYPE

  • COUNTRY

  • SETTLEMENT_TYPE

  • STREET_TYPE

  • PHONE_TYPE

  • CONFIDANT_PERSON_TYPE

  • PREFERRED_WAY_COMMUNICATION

  • DOCUMENT_RELATIONSHIP_TYPE

Request structure

Example:

...

  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 = 'merge_request:write')

    1. Return 403 in case invalid scope(s)

  3. Check the employee has created this merge request. Thus select inserted_by from il.merge_requests of this merge request and compare it with user_id from the token.

    1. If not match - return 403 error (Only author of merge request is allowed to approve it)

  4. Check that client_id from the token maches with il.merge_requests.legal_entity_id

    1. If not match - return 422 error (User doesn’t belong to legal entity where the merge request was created)

Headers

...

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9api{{access_token}}

Api-key:uXhEczJ56adsfh3Ri9SUkc4en{{secret}}

Request data validation

Validate schema

...

Get all the preperson episodes for the printout form (mongodb, episodes collection).

Generate printout form

  1. Check if person has confidant_person block:

    1. if has - select printout form with confidant person

    2. if not - select printout form w/o confidant person

  2. Invoke MAN to render print form.

...

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

200

 Response

 

401

 

 Access token validation failed

403

Only author of merge request is allowed to approve it

Invalid scope

404

Validation failed

422

User doesn’t belong to legal entity where the merge request was created

Incorrect status to approve merge request

Validation failed