...

...

...

...

...

...

...

...

Purpose

This WS gives the opportunity to update external identifier of unidentified person in eHealthMethod enables to modify all the preperson fields except note and status.

Specification

...

Logic

1. Only authenticated and authorized

...

1. SPECIALIST, ASSISTANT, RECEPTIONIST

...

1. employees can update external_id of preperson.

2. Preperson can be updated

...

1. only in OUTPATIENT or EMERGENCY legal entity type

...

1. , if

...

1. identifier of preperson is being known (returns after Create preperson).

2. Only

...

1. note and status fields can not be updated.

2. Update allowed for prepersons with status =

...

1. active.

Input parameters

Request structure

See on Apiary

Example:

{
  "external_id": "#1234-FDS-ab",
  "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"
      }
    ]
  },
  "death_date": "2018-11-11",
  "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:

...

1. write')

...

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

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 token

...

2. Check legal entity status (status = ACTIVE

...

1. )

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

...

1. 1. )

Validate

...

ID

Check person_id ID exists and belongs to preperson

1. Check

...

1. ID exists in MPI.

...

1. prepersons

   1. In case error -

...

Convert person_id into patient_id. Check patient_id exists in medical_data.patients collection

...

1. 1. 404

2. Check preperson has status=active

   1. In case error - return 422 (

...

1. 1. Preperson is not active)

Validate request

Validate request using schema (TBD)

1. Check at least one of allowed field is submitted and has value:

   • first_name

   • last_name

   • second_name

   • gender

   • external_id

   • birth_date

...

1. • emergency_contact

   • death_date

     • In case of error - return 422 (Schema validation failed)

   • note

2. Check if any forbidden field is submitted:

• status

  1. In case of error - return 422 (Schema validation failed)

Validate fields

• Validate external_id

...

• according to regexp - 8-10.8-10.1-10 [0-9

• Validate birth_date - must be <= today()

  • else error 422 "Birth date can't be in the future"Validate death_date < now():

  • In case of error - return 422

...

• • - “Death date can not be in future”

• Validate death_date > = birth_date:

  • else error 422 "Death date should equal or greater than birth_date"

• If death_date submitted, set mpi.preperson.status = inactive

Processing

Update object in DB

...

prepersons table

Parameter	Source	Description
external_id	Request: external_id	Identifier from external system

, required

. Get from request body
first_name	Request: first_name
second_name	Request: second_name
last_name	Request: last_name
gender	Request: gender
birth_date	Request: birth_date	If submitted, set status = inactive
emergency_contact	Request: emergency_contact
death_date	Request: death_date
note	Request: note
updated_at	timestamp: now()	Get current date-time
updated_by	uuid	Extract user from token

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "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