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.

Specification

...

Logic

1. Only authenticated and authorized 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 external_id as a required field. Other are optional

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

5. Service should return preperson_id.

6. Preperson has been created without using digital sign.

...

Request structure

See on Apiary

Example:

{
  "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

...

1. • return 401 in case validation fails

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

...

1. • return 403 in case invalid scope(s)

2. 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) and belongs to the user

1. Extract client_id from token

2. Check legal entity status (status = ACTIVE)

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

3. 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)

• 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)

2. 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 preperson to MPI

prepersons table

Response structure

See on Apiary

Example:

{
  "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