Properties of a REST API method document

Purpose

The process is initiated by any employee with necessary scopes in this legal entity and involves the transfer of a signed person with electronic digital signature. 

Process is synchronous. If all validations are successfully completed, the synchronous process of creating a person starts by processing the message.

Key features

1. Only authenticated and authorized user can use this service

2. Only APPROVED patient request can be signed

3. The request can be signed only by the employee who works in the same legal entity in which the request was made.

Preconditions

Person request must be approved.

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

Digital signature

Decode content that is encrypted in an electronic digital signature.
Use Digital signature WS. Method checks digital signature and returns result.
See service specification.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Request structure

See on API-specification

Headers

Request data validation

Validate DRFO

1. Check that DRFO in Certificate details exists and not empty

2. Check that DRFO in Certificate details is equal to DRFO in Party

   1. Get party.tax_id using employee_id in person payload

   2. Compare DRFO in Certificate with party.tax_id

      1. Convert DRFO and TAX_ID to uppercase

      2. Compare DRFO and TAX_ID as Cyrillic letters

      3. Convert DRFO to Cyrillic and compare as Cyrillic letters

   3. In case validation fails - generate 422 error

Latin to Cyrillic mapping

Validate request

1. Validate request using JSON schema (See specification)

   1. In case validation fails - generate 422 error.

2. Check patient request status

   1. If status is not APPROVED, - returned error 'Incorrect status'.

Check signed content

Check decoded signed content with previously created on IL.db.

In case if they are not equal - generate 422 error (message: "Signed content does not match the previously created content")

Check legal entity id

Patient request can be signed by any employee with necessary scopes in equal legal_entity_id.

1. Check that ID in URL exists in the system

   1. Return 401 in case validation fails

2. Check that patient request belongs to the same legal entity as the user

   1. In case of error - return 403

Check "patient_signed" flag

• If "patient_signed" is not present in request, return 422 ("required property patient_signed was not present")

• If "patient_signed"=false in request, return 422 ("value is not allowed in enum")

Processing

Update patient request

Update patient request:

1. Change entity status in IL_DB.patient_request to SIGNED

2. Set updated_at - now() (Get current date-time)

3. Set updated_by - user_id (Extract user from token)

Create person

After singed patient request create new person on DB.mpi.

Calculate the end date of the person_aus_method and set as default

These params set only if person is creating (so after Create person request)

If person has auth_method = third_person, add in table person_auth_methods row with type = THIRD_PERSON, value = id (third_person_id), alias

Calculate term of person_authentication_method:

Start date: start_date = Current_date()

End date:

Also to table person_auth_methods add this method as default(field `default` = TRUE) - it's for all auth_method.type

Check if Person should be sent for verification

Please note, (GraphQL) Update person refers to this validation.

if person’s data match any of the following rules:

validate all Rules 01-05

1. Person has OFFLINE auth method
   if create Person process, check Request
   if update Person process, check within MPI.person_athentication_methods table

2. Person's age >= no_self_auth_age and no_tax_id = true (check in Request)

3. Person's age >= no_self_auth_age and Person’s tax_id is invalid (i.e. not match with birth date or gender or invalid checksum) (check in Request)

4. Person’s age < no_self_auth_age and has document with type BIRTH_CERTIFICATE_FOREIGN (check in Request)

5. Person’s age >= no_self_auth_age and has document with type PERMANENT_RESIDENCE_PERMIT (check in Request)

then

manual verification is needed

• Set MPI.persons.verification_status = VERIFICATION_NEEDED and

• Set MPI.persons.verification_reason = RULES_TRIGGERED and

• Create StateChangeEvent in event manager with new verification status

else

person will be verified with Registers

• Set MPI.persons.verification_status = VERIFICATION_NEEDED and

• Set MPI.persons.verification_reason = RULES_PASSED and

• Set MPI.persons.verification_comment = NULL and

• Create StateChangeEvent in event manager with new verification status

Submit person on verification

Create or update existing record in person_verifications table for a person according to logic in sections below. Also, set:

• updated_at = now()

• updated_by = user uuid

• inserted_at = now() (for new records)

• inserted_by = user uuid (for new records)

Manual NHS verification

If person’s data match any of the following rules:

1. Person has OFFLINE auth method
   if create Person process, check Request
   if update Person process, check within MPI.person_athentication_methods table

2. Person's age >= no_self_auth_age and no_tax_id = true (check in Request)

3. Person's age >= no_self_auth_age and Person’s tax_id is invalid (i.e. not match with birth date or gender or invalid checksum) (check in Request)

4. Person’s age < no_self_auth_age and has document with type BIRTH_CERTIFICATE_FOREIGN (check in Request, within $.person.documents and $.person.confidant_person[:].documents_relationship[:])

5. Person’s age >= no_self_auth_age and has document with type PERMANENT_RESIDENCE_PERMIT (check in Request)

then manual verification is needed. Set to person verification record:

• nhs_verification_status = VERIFICATION_NEEDED

• nhs_verification_reason = RULES_TRIGGERED

else manual verification is not needed. Set to person verification record:

• nhs_verification_status = VERIFIED

• nhs_verification_reason = RULES_PASSED

• nhs_verification_comment = NULL

DRFO registry verification

Set to person verification record:

• drfo_data_id = NULL

• drfo_data_result = NULL

• drfo_synced_at = NULL

• drfo_verification_status = VERIFICATION_NEEDED

• drfo_verification_reason = ONLINE_TRIGGERED

Then person will be verified online with DRFO registry via separate process: https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17250713607/DRFO+data+synchronization+for+Persons#Data-flow

DRACS death acts registry verification

Set to person verification record as ready for online verification with DRACS death acts registry:

• dracs_death_verification_status = VERIFICATION_NEEDED

• dracs_death_verification_reason = ONLINE_TRIGGERED

• dracs_death_online_status = READY

Then person will be verified online with DRACS death acts registry via separate process: https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17249763472

Calculate cumulative verification status

Calculate persons cumulative verification status based on persons verification status in each stream: Manual NHS verification, DRFO registry verification, DRACS death acts registry verification according to logic described at https://e-health-ua.atlassian.net/wiki/spaces/DRACS/pages/17250582534/Person+verification+status+model#Cumulative-verification-status:

• Set calculated status to persons.verification_status field

• Create StatusChangeEvent in event manager with new verification status

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used