Versions Compared

Key

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

Purpose

This WS give gives the opportunity to create an unidentified person in eHealth. It means that person can be created w/o any information about it but requires a medical identification with set of medical events.

Specification

TBD

...

.

Specification

Page Properties
idAPI_Specification

Link

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

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

Resource

/api/prepersons

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

Scope

preperson:write

Scope для доступу

Components

Patient registry

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

Microservices

mpi/api

il/api (rpc)

fe/admin-web

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

Protocol type

REST

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

Request type

POST

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

Sync/Async

Sync

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

Public/Private/Internal

Public

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

Logic

  1. Only authenticated and authorized

...

  1. SPECIALIST, ASSISTANT, RECEPTIONIST employees can register prepersons.

  2. Prepersons can be registered in OUTPATIENT and EMERGENCY legal entities.

  3. Prepersons shoul be registered only with

...

Preperson registered w/o entry in MPI. Only as document in patients collection.

...

Service should generate patient_id in MongoDB, but return person_id (w/o creating entry in MPI)

...

  1. external_id as a required field. Other are optional

  2. Preperson registers as separate record in MPI.prepersons table. On create ID of preperson sholdn’t match with ID of existent person.

  3. Service should return preperson_id.

  4. Preperson has been created without using digital sign.

Request structure

See on Apiary

Example:

Expand
titleRequest example
Code Block
{
  "external_id": "#1234-FDS-aa",
  "first_name": "Петро",
  "last_name": "Іванов",
  "second_name": "Миколайович",
  "gender": "MALE",
  "birth_date": "1980-01-01",
  "emergency_contact": {
    "first_name": "Петро",
    "last_name": "Іванов",
    "second_name": "Миколайович",
    "phones": [
      {
        "type": "MOBILE",
        "number": "+380503410870"
      }
    ]
  },
  "note": "Registered in SmartMed clinic at 01.01.2019 16:40. Male, 40 years old approximately, tatoo with sport motorcycle on the right forearm"
}

Dictionaries

  • GENDER

  • PHONE_TYPE

Authorize

  1. Verify the validity of access token

...

    • return 401 in case validation fails

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

...

    • return 403 in case invalid scope(s)

  1. If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

    • in case not match - return 403 ("Access denied. Party is not verified")

Headers

Content-Type:application/json

Authorization:Bearer {{access_token}}

api-key:{{secret}}

Request data validation

Validate legal entity

Check that legal entity is active (status = ACTIVE, SUSPENDED) and belongs to the user

  1. Extract client_id from

...

  1. token

...

  1. Check legal entity status (status = ACTIVE

...

  1. )

    1. In case of error - return 409 (Legal entity must be

...

    1. ACTIVE)

  1. Check legal entity has at least one healthcare service with status = ACTIVE and providing_condition = INPATIENT and speciality_type in PREPERSON_HEALTHCARE_SERVICES_SPECIALITY_TYPES variable (value should exist in SPECIALITY_TYPE dict)

    1. if no such healthcare services - return 409 (Legal entity does not have appropriate healthcare services)

Validate request

  • Validate request using schema (TBD)

...

Required set of medical events (TBD)

  • Validate birth_date - must be <= today()

    • else error 422 "Birth date can't be in the future"

Validate external_id

  1. Check external_id is not empty.

...

    1. In case of error - return 422 (external_id should not be empty)

  1. Validate according to regexp - ^[0-9]{8,10}\.[0-9]{8,10}\.[0-9]{1,10}$

Processing

Generate preperson_id

  1. Generate preperson_id (will be returned in response). Ensure there is no such person_id in MPI.persons

  2. Generate patient_id to save it in patients collection (separate job).

Save object to

...

DB

Insert patient and set of submitted medical events

...

preperson to MPI

prepersons table

Parameter

Source

Description

_

id

string

Autogenerated

hash.

.

first_name

Request: first_name

second_name

Request: second_name

last_name

Request: last_name

gender

Request: gender

Gender, required. The values correspond to GENDER dictionary

birth_date

Request: birth_date

emergency_contact

Request: emergency_contact

death_date

date

By default is null on create

note

Request: note

status

string

Status, required. By default is “active”

external_id

Request: external_id

Identifier from external system. Required

is_active

bool

Technical flag. By default is true.

inserted_by

uuid

Extract user from token

inserted_at

timestamp

Get current date-time

updated_by

uuid

Extract user from token

updated_at

timestamp

Get current date-time

...

Response structure

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 201,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
    "external_id": "#1234-FDS-aa",
    "first_name": "Петро",
    "last_name": "Іванов",
    "second_name": "Миколайович",
    "gender": "MALE",
    "birth_date": "1980-01-01",
    "emergency_contact": {
      "first_name": "Петро",
      "last_name": "Іванов",
      "second_name": "Миколайович",
      "phones": [
        {
          "type": "MOBILE",
          "number": "+380503410870"
        }
      ]
    },
    "note": "Registered in SmartMed clinic at 01.01.2019 16:40. Male, 40 years old approximately, tatoo with sport motorcycle on the right forearm",
    "status": "ACTIVE",
    "death_date": "2018-11-11",
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

HTTP status codes

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

201

 Response

 

401

 

Access token validation failed

403

Invalid scope(s)

409

Legal entity must be ACTIVE

Legal entity does not have appropriate healthcare services

Validation failed

422

Birth date can't be in the future

External_id should not be empty

Validation failed